Re: [pbs-devel] [PATCH proxmox-backup v3 2/6] pbs-api-types: add metrics api types

[Wolfgang Bumiller <w.bumiller@proxmox.com>]

On Fri, Dec 17, 2021 at 09:09:56AM +0100, Dominik Csapak wrote:
> InfluxDbUdp and InfluxDbHttp for now
> 
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
>  pbs-api-types/src/lib.rs     |   2 +
>  pbs-api-types/src/metrics.rs | 147 +++++++++++++++++++++++++++++++++++
>  2 files changed, 149 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..09bd59c8 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]
> diff --git a/pbs-api-types/src/metrics.rs b/pbs-api-types/src/metrics.rs
> new file mode 100644
> index 00000000..786abe82
> --- /dev/null
> +++ b/pbs-api-types/src/metrics.rs
> @@ -0,0 +1,147 @@
> +use serde::{Deserialize, Serialize};
> +
> +use crate::{DNS_NAME_OR_IP_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: {
> +            description: "Enables or disables the metrics server",

^ same


I'd prefer not to mix doc-comments and `description` entries, please
stick to doc comments as they'll also show up in rustdocs.

> +            type: bool,
> +            optional: true,
> +            default: true,
> +        },
> +        host: {
> +            schema: DNS_NAME_OR_IP_SCHEMA,
> +        },
> +        mtu: {
> +            description: "The MTU",

^ same

> +            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,

and please put some newlines in between these, it's a bit much otherwise
with the #[serde] & doc comment stuff.

> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub enable: Option<bool>,
> +    pub host: String,
> +    /// The port
> +    pub port: u16,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub mtu: Option<u16>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub comment: Option<String>,
> +}
> +
> +#[api(
> +    properties: {
> +        name: {
> +            schema: METRIC_SERVER_ID_SCHEMA,
> +        },
> +        enable: {
> +            description: "Enables or disables the metrics server",

^ same

> +            type: bool,
> +            optional: true,
> +            default: true,
> +        },
> +        host: {
> +            schema: DNS_NAME_OR_IP_SCHEMA,
> +        },
> +        https: {
> +            description: "If true, HTTPS is used.",

^ same

> +            type: bool,
> +            optional: true,
> +            default: true,
> +        },
> +        token: {
> +            description: "The (optional) API token",

^ same, here for instance you used both...

> +            type: String,
> +            optional: true,
> +        },
> +        bucket: {
> +            schema: INFLUXDB_BUCKET_SCHEMA,
> +            optional: true,
> +        },
> +        organization: {
> +            schema: INFLUXDB_ORGANIZATION_SCHEMA,
> +            optional: true,
> +        },
> +        "max-body-size": {
> +            description: "The (optional) maximum body size",

^ same

> +            type: usize,
> +            optional: true,
> +            default: 25_000_000,
> +        },
> +        "verify-tls": {
> +            description: "If true, the certificate will be validated.",

^ same

> +            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")]
> +    pub enable: Option<bool>,
> +    pub host: String,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    /// The (optional) port. (defaults: 80 for HTTP, 443 for HTTPS)
> +    pub port: Option<u16>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub https: Option<bool>,
> +    /// The Optional Token
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub token: Option<String>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub bucket: Option<String>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub organization: Option<String>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub max_body_size: Option<usize>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub verify_tls: Option<bool>,
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub comment: Option<String>,
> +}
> -- 
> 2.30.2