From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id E5D8461662 for ; Mon, 17 Jan 2022 11:49:03 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 78E8018C19 for ; Mon, 17 Jan 2022 11:48:33 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id A1BDA18B92 for ; Mon, 17 Jan 2022 11:48:28 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 73C19460B7 for ; Mon, 17 Jan 2022 11:48:28 +0100 (CET) From: Dominik Csapak To: pbs-devel@lists.proxmox.com Date: Mon, 17 Jan 2022 11:48:21 +0100 Message-Id: <20220117104825.2409598-7-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220117104825.2409598-1-d.csapak@proxmox.com> References: <20220117104825.2409598-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.162 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v4 2/6] pbs-api-types: add metrics api types X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 17 Jan 2022 10:49:03 -0000 InfluxDbUdp and InfluxDbHttp for now introduces schemas for host:port and https urls Signed-off-by: Dominik Csapak --- pbs-api-types/src/lib.rs | 15 ++++ pbs-api-types/src/metrics.rs | 138 +++++++++++++++++++++++++++++++++++ 2 files changed, 153 insertions(+) create mode 100644 pbs-api-types/src/metrics.rs diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs index 0a0dd33d..e442b1cf 100644 --- a/pbs-api-types/src/lib.rs +++ b/pbs-api-types/src/lib.rs @@ -88,6 +88,8 @@ pub use traffic_control::*; mod zfs; pub use zfs::*; +mod metrics; +pub use metrics::*; #[rustfmt::skip] #[macro_use] @@ -100,6 +102,7 @@ mod local_macros { macro_rules! DNS_ALIAS_NAME { () => (concat!(r"(?:(?:", DNS_ALIAS_LABEL!() , r"\.)*", DNS_ALIAS_LABEL!(), ")")) } + macro_rules! PORT_REGEX_STR { () => (r"(?:[0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])") } } const_regex! { @@ -113,6 +116,8 @@ const_regex! { pub DNS_NAME_REGEX = concat!(r"^", DNS_NAME!(), r"$"); pub DNS_ALIAS_REGEX = concat!(r"^", DNS_ALIAS_NAME!(), r"$"); pub DNS_NAME_OR_IP_REGEX = concat!(r"^(?:", DNS_NAME!(), "|", IPRE!(), r")$"); + pub HOST_PORT_REGEX = concat!(r"^(?:", DNS_NAME!(), "|", IPRE_BRACKET!(), "):", PORT_REGEX_STR!() ,"$"); + pub HTTP_URL_REGEX = concat!(r"^https?://(?:(?:(?:", DNS_NAME!(), "|", IPRE_BRACKET!(), ")(?::", PORT_REGEX_STR!() ,"))|", IPV6RE!(),")(?:/[^\x00-\x1F\x7F]*)?$"); pub SHA256_HEX_REGEX = r"^[a-f0-9]{64}$"; // fixme: define in common_regex ? @@ -160,6 +165,8 @@ pub const BLOCKDEVICE_NAME_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&B pub const SUBSCRIPTION_KEY_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&SUBSCRIPTION_KEY_REGEX); pub const SYSTEMD_DATETIME_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&SYSTEMD_DATETIME_REGEX); pub const HOSTNAME_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&HOSTNAME_REGEX); +pub const HOST_PORT_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&HOST_PORT_REGEX); +pub const HTTP_URL_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&HTTP_URL_REGEX); pub const DNS_ALIAS_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&DNS_ALIAS_REGEX); @@ -199,6 +206,14 @@ pub const DNS_NAME_OR_IP_SCHEMA: Schema = StringSchema::new("DNS name or IP addr .format(&DNS_NAME_OR_IP_FORMAT) .schema(); +pub const HOST_PORT_SCHEMA: Schema = StringSchema::new("host:port combination (Host can be DNS name or IP address).") + .format(&HOST_PORT_FORMAT) + .schema(); + +pub const HTTP_URL_SCHEMA: Schema = StringSchema::new("HTTP(s) url with optional port.") + .format(&HTTP_URL_FORMAT) + .schema(); + #[cfg(not(target_arch="wasm32"))] // this only makes sense for the serever side pub const NODE_SCHEMA: Schema = StringSchema::new("Node name (or 'localhost')") .format(&ApiStringFormat::VerifyFn(|node| { diff --git a/pbs-api-types/src/metrics.rs b/pbs-api-types/src/metrics.rs new file mode 100644 index 00000000..239d6c80 --- /dev/null +++ b/pbs-api-types/src/metrics.rs @@ -0,0 +1,138 @@ +use serde::{Deserialize, Serialize}; + +use crate::{ + HOST_PORT_SCHEMA, HTTP_URL_SCHEMA, PROXMOX_SAFE_ID_FORMAT, SINGLE_LINE_COMMENT_SCHEMA, +}; +use proxmox_schema::{api, Schema, StringSchema, Updater}; + +pub const METRIC_SERVER_ID_SCHEMA: Schema = StringSchema::new("Metrics Server ID.") + .format(&PROXMOX_SAFE_ID_FORMAT) + .min_length(3) + .max_length(32) + .schema(); + +pub const INFLUXDB_BUCKET_SCHEMA: Schema = StringSchema::new("InfluxDB Bucket.") + .format(&PROXMOX_SAFE_ID_FORMAT) + .min_length(3) + .max_length(32) + .default("proxmox") + .schema(); + +pub const INFLUXDB_ORGANIZATION_SCHEMA: Schema = StringSchema::new("InfluxDB Organization.") + .format(&PROXMOX_SAFE_ID_FORMAT) + .min_length(3) + .max_length(32) + .default("proxmox") + .schema(); + +#[api( + properties: { + name: { + schema: METRIC_SERVER_ID_SCHEMA, + }, + enable: { + type: bool, + optional: true, + default: true, + }, + host: { + schema: HOST_PORT_SCHEMA, + }, + mtu: { + type: u16, + optional: true, + default: 1500, + }, + comment: { + optional: true, + schema: SINGLE_LINE_COMMENT_SCHEMA, + }, + }, +)] +#[derive(Serialize, Deserialize, Updater)] +#[serde(rename_all = "kebab-case")] +/// InfluxDB Server (UDP) +pub struct InfluxDbUdp { + #[updater(skip)] + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + /// Enables or disables the metrics server + pub enable: Option, + /// the host + port + pub host: String, + #[serde(skip_serializing_if = "Option::is_none")] + /// The MTU + pub mtu: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub comment: Option, +} + +#[api( + properties: { + name: { + schema: METRIC_SERVER_ID_SCHEMA, + }, + enable: { + type: bool, + optional: true, + default: true, + }, + url: { + schema: HTTP_URL_SCHEMA, + }, + token: { + type: String, + optional: true, + }, + bucket: { + schema: INFLUXDB_BUCKET_SCHEMA, + optional: true, + }, + organization: { + schema: INFLUXDB_ORGANIZATION_SCHEMA, + optional: true, + }, + "max-body-size": { + type: usize, + optional: true, + default: 25_000_000, + }, + "verify-tls": { + type: bool, + optional: true, + default: true, + }, + comment: { + optional: true, + schema: SINGLE_LINE_COMMENT_SCHEMA, + }, + }, +)] +#[derive(Serialize, Deserialize, Updater)] +#[serde(rename_all = "kebab-case")] +/// InfluxDB Server (HTTP(s)) +pub struct InfluxDbHttp { + #[updater(skip)] + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + /// Enables or disables the metrics server + pub enable: Option, + /// The base url of the influxdb server + pub url: String, + /// The Optional Token + #[serde(skip_serializing_if = "Option::is_none")] + /// The (optional) API token + pub token: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub bucket: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub organization: Option, + #[serde(skip_serializing_if = "Option::is_none")] + /// The (optional) maximum body size + pub max_body_size: Option, + #[serde(skip_serializing_if = "Option::is_none")] + /// If true, the certificate will be validated. + pub verify_tls: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub comment: Option, +} -- 2.30.2