public inbox for pdm-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Wolfgang Bumiller <w.bumiller@proxmox.com>
To: Lukas Wagner <l.wagner@proxmox.com>
Cc: pdm-devel@lists.proxmox.com
Subject: Re: [pdm-devel] [PATCH proxmox-datacenter-manager 25/25] cli: add commands for metric-collection settings, trigger, status
Date: Thu, 13 Feb 2025 13:14:39 +0100	[thread overview]
Message-ID: <eg7przvwbnmb7gqbw6xb5pe7l63iwtdwcp6thbxoqws7pdt54o@2rss6alti37s> (raw)
In-Reply-To: <20250211120541.163621-26-l.wagner@proxmox.com>

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@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


_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel

  reply	other threads:[~2025-02-13 12:14 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-11 12:05 [pdm-devel] [PATCH proxmox-datacenter-manager 00/25] metric collection improvements (concurrency, config, API, CLI) Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 01/25] test support: add NamedTempFile helper Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 02/25] test support: add NamedTempDir helper Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 03/25] pdm-api-types: add CollectionSettings type Lukas Wagner
2025-02-11 14:18   ` Maximiliano Sandoval
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 04/25] pdm-config: add functions for reading/writing metric collection settings Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 05/25] metric collection: split top_entities split into separate module Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 06/25] metric collection: save metric data to RRD in separate task Lukas Wagner
2025-02-12 13:59   ` Wolfgang Bumiller
2025-02-12 14:32     ` Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 07/25] metric collection: rework metric poll task Lukas Wagner
2025-02-11 12:58   ` Lukas Wagner
2025-02-12 15:57   ` Wolfgang Bumiller
2025-02-13 12:31     ` Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 08/25] metric collection: persist state after metric collection Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 09/25] metric collection: skip if last_collection < MIN_COLLECTION_INTERVAL Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 10/25] metric collection: collect overdue metrics on startup/timer change Lukas Wagner
2025-02-13  8:55   ` Wolfgang Bumiller
2025-02-13 13:50     ` Lukas Wagner
2025-02-13 14:19       ` Wolfgang Bumiller
2025-02-13 15:21         ` Lukas Wagner
2025-02-13 15:34           ` Wolfgang Bumiller
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 11/25] metric collection: add tests for the fetch_remotes function Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 12/25] metric collection: add test for fetch_overdue Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 13/25] metric collection: pass rrd cache instance as function parameter Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 14/25] metric collection: add test for rrd task Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 15/25] metric collection: wrap rrd_cache::Cache in a struct Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 16/25] metric collection: record remote response time in metric database Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 17/25] metric collection: save time needed for collection run to RRD Lukas Wagner
2025-02-13 11:53   ` Wolfgang Bumiller
2025-02-13 12:12     ` Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 18/25] metric collection: periodically clean removed remotes from statefile Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 19/25] api: add endpoint for updating metric collection settings Lukas Wagner
2025-02-13 12:09   ` Wolfgang Bumiller
2025-02-13 12:15     ` Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 20/25] api: add endpoint to trigger metric collection Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 21/25] api: remotes: trigger immediate metric collection for newly added nodes Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 22/25] api: add api for querying metric collection RRD data Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 23/25] api: metric-collection: add status endpoint Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 24/25] pdm-client: add metric collection API methods Lukas Wagner
2025-02-13 12:10   ` Wolfgang Bumiller
2025-02-13 13:52     ` Lukas Wagner
2025-02-11 12:05 ` [pdm-devel] [PATCH proxmox-datacenter-manager 25/25] cli: add commands for metric-collection settings, trigger, status Lukas Wagner
2025-02-13 12:14   ` Wolfgang Bumiller [this message]
2025-02-13 14:17     ` Lukas Wagner
2025-02-13 14:56       ` Wolfgang Bumiller
2025-02-13 14:58         ` Lukas Wagner
2025-02-13 15:11           ` Lukas Wagner
2025-02-14 13:08 ` [pdm-devel] [PATCH proxmox-datacenter-manager 00/25] metric collection improvements (concurrency, config, API, CLI) Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=eg7przvwbnmb7gqbw6xb5pe7l63iwtdwcp6thbxoqws7pdt54o@2rss6alti37s \
    --to=w.bumiller@proxmox.com \
    --cc=l.wagner@proxmox.com \
    --cc=pdm-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal