[pdm-devel] [PATCH proxmox-datacenter-manager 25/25] cli: add commands for metric-collection settings, trigger, status

[Wolfgang Bumiller]

On Tue, Feb 11, 2025 at 01:05:41PM +0100, Lukas Wagner wrote:
> This adds new commands to the proxmox-datacenter-client CLI tool, namely
>  - to update metric collection settings
>  - trigger metric collection
>  - show status of the last metric collection
> 
> Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
> ---
>  cli/client/Cargo.toml               |   1 +
>  cli/client/src/main.rs              |   2 +
>  cli/client/src/metric_collection.rs | 164 ++++++++++++++++++++++++++++
>  3 files changed, 167 insertions(+)
>  create mode 100644 cli/client/src/metric_collection.rs
> 
> diff --git a/cli/client/Cargo.toml b/cli/client/Cargo.toml
> index 96016cd..5c96b28 100644
> --- a/cli/client/Cargo.toml
> +++ b/cli/client/Cargo.toml
> @@ -46,6 +46,7 @@ proxmox-rrd-api-types.workspace = true
>  proxmox-schema = { workspace = true, features = [ "api-macro" ] }
>  proxmox-section-config.workspace = true
>  proxmox-sys.workspace = true
> +proxmox-time.workspace = true
>  proxmox-tfa = { workspace = true, features = [ "types" ] }
>  
>  # for the pve API types:
> diff --git a/cli/client/src/main.rs b/cli/client/src/main.rs
> index c913e97..55877cf 100644
> --- a/cli/client/src/main.rs
> +++ b/cli/client/src/main.rs
> @@ -17,6 +17,7 @@ pub mod env;
>  
>  pub mod acl;
>  pub mod config;
> +pub mod metric_collection;
>  pub mod pbs;
>  pub mod pve;
>  pub mod remotes;
> @@ -93,6 +94,7 @@ fn main_do() -> Result<(), Error> {
>          )
>          .insert("acl", acl::cli())
>          .insert("login", CliCommand::new(&API_METHOD_LOGIN))
> +        .insert("metric-collection", metric_collection::cli())

maaaaaybe...
    .alias(&["mc"], &["metric-collection"])
? 🤪

>          .insert("pbs", pbs::cli())
>          .insert("pve", pve::cli())
>          .insert("remote", remotes::cli())
> diff --git a/cli/client/src/metric_collection.rs b/cli/client/src/metric_collection.rs
> new file mode 100644
> index 0000000..8ca861a
> --- /dev/null
> +++ b/cli/client/src/metric_collection.rs
> @@ -0,0 +1,164 @@
> +use anyhow::Error;
> +use pdm_api_types::{
> +    remotes::REMOTE_ID_SCHEMA, CollectionSettingsUpdater, DeletableCollectionSettingsProperty,
> +};
> +use proxmox_router::cli::{
> +    format_and_print_result, CliCommand, CliCommandMap, CommandLineInterface, OutputFormat,
> +};
> +use proxmox_schema::api;
> +
> +use crate::{client, env};
> +
> +pub fn cli() -> CommandLineInterface {
> +    CliCommandMap::new()
> +        .insert(
> +            "show-settings",
> +            CliCommand::new(&API_METHOD_SHOW_COLLECTION_SETTINGS),
> +        )

↑↓ wouldn't `settings show`, `settings update` be more consistent?

> +        .insert(
> +            "update-settings",
> +            CliCommand::new(&API_METHOD_UPDATE_COLLECTION_SETTINGS),
> +        )
> +        .insert(
> +            "trigger",
> +            CliCommand::new(&API_METHOD_TRIGGER_METRIC_COLLECTION),
> +        )
> +        .insert(
> +            "status",
> +            CliCommand::new(&API_METHOD_METRIC_COLLECTION_STATUS),
> +        )
> +        .into()
> +}
> +
> +#[api]
> +/// Show metric collection settings.
> +async fn show_collection_settings() -> Result<(), Error> {
> +    let client = client()?;
> +    let settings = client.get_metric_collection_settings().await?;
> +
> +    fn default_if_none<T>(value: Option<T>) -> &'static str {
> +        if value.is_none() {
> +            " (default)"
> +        } else {
> +            ""
> +        }
> +    }
> +
> +    let output_format = env().format_args.output_format;
> +    if output_format == OutputFormat::Text {
> +        println!("Metric collection settings:");
> +        println!(
> +            "    collection-interval: {}s {}",
> +            settings.collection_interval_or_default(),
> +            default_if_none(settings.collection_interval),
> +        );
> +        println!(
> +            "    max-interval-offset: {}s {}",
> +            settings.max_interval_offset_or_default(),
> +            default_if_none(settings.max_interval_offset)
> +        );
> +        println!(
> +            "    min-interval-offset: {}s {}",
> +            settings.min_interval_offset_or_default(),
> +            default_if_none(settings.min_interval_offset)
> +        );
> +        println!(
> +            "    max-connection-delay: {}ms {}",
> +            settings.max_connection_delay_or_default(),
> +            default_if_none(settings.max_connection_delay)
> +        );
> +        println!(
> +            "    min-connection-delay: {}ms {}",
> +            settings.min_connection_delay_or_default(),
> +            default_if_none(settings.min_connection_delay)
> +        );
> +        println!(
> +            "    max-concurrent-connections: {} {}",
> +            settings.max_concurrent_connections_or_default(),
> +            default_if_none(settings.max_concurrent_connections),
> +        );
> +    } else {
> +        format_and_print_result(&settings, &output_format.to_string());
> +    }
> +    Ok(())
> +}
> +
> +#[api(
> +    input: {
> +        properties: {
> +            updater: {
> +                type: CollectionSettingsUpdater,
> +                flatten: true,
> +            },
> +            delete: {
> +                description: "Clear/reset collection settings properties.",
> +                optional: true,
> +                type: Array,
> +                items: {
> +                    type: DeletableCollectionSettingsProperty,
> +                },
> +            },
> +        }
> +    }
> +)]
> +/// Change metric collection settings.
> +async fn update_collection_settings(
> +    updater: CollectionSettingsUpdater,
> +    delete: Option<Vec<DeletableCollectionSettingsProperty>>,
> +) -> Result<(), Error> {
> +    let client = client()?;
> +    client
> +        .update_metric_collection_settings(updater, delete)
> +        .await?;
> +
> +    Ok(())
> +}
> +
> +#[api(
> +    input: {
> +        properties: {
> +            remote: {
> +                schema: REMOTE_ID_SCHEMA,
> +                optional: true,
> +            },
> +        }
> +    }
> +)]
> +/// Trigger metric collection. If a remote is passed, only this remote will be collected, otherwise
> +/// all.
> +async fn trigger_metric_collection(remote: Option<String>) -> Result<(), Error> {
> +    client()?
> +        .trigger_metric_collection(remote.as_deref())
> +        .await?;
> +    Ok(())
> +}
> +
> +#[api]
> +/// Show metric collection status.
> +async fn metric_collection_status() -> Result<(), Error> {
> +    let result = client()?.get_metric_collection_status().await?;
> +
> +    let output_format = env().format_args.output_format;
> +    if output_format == OutputFormat::Text {
> +        for remote_status in result {
> +            let timestamp = if let Some(last_collection) = remote_status.last_collection {
> +                proxmox_time::strftime_local("%a, %d %b %Y %T %z", last_collection)?
> +            } else {
> +                "never".into()
> +            };
> +
> +            let status = if let Some(err) = &remote_status.error {
> +                err
> +            } else {
> +                "ok"
> +            };
> +
> +            println!("{}: {status}", remote_status.remote);
> +            println!("    last successful: {timestamp}");
> +            println!();
> +        }
> +    } else {
> +        format_and_print_result(&result, &output_format.to_string());
> +    }
> +    Ok(())
> +}
> -- 
> 2.39.5