public inbox for pdm-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH proxmox-datacenter-manager v6 20/23] cli: add commands for metric-collection trigger and status
Date: Thu, 21 Aug 2025 11:53:16 +0200	[thread overview]
Message-ID: <20250821095319.134215-21-l.wagner@proxmox.com> (raw)
In-Reply-To: <20250821095319.134215-1-l.wagner@proxmox.com>

This adds new commands to the proxmox-datacenter-client CLI tool, namely
 - trigger metric collection
 - show status of the last metric collection

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---

Notes:
    Changes since v1:
      - update-settings -> 'settings update'
      - show-settings -> 'settings show'

 cli/client/Cargo.toml               |  1 +
 cli/client/src/main.rs              |  2 +
 cli/client/src/metric_collection.rs | 70 +++++++++++++++++++++++++++++
 3 files changed, 73 insertions(+)
 create mode 100644 cli/client/src/metric_collection.rs

diff --git a/cli/client/Cargo.toml b/cli/client/Cargo.toml
index 3de3bf3f..c2aac874 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 b1cc2ad5..27fd3744 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;
@@ -96,6 +97,7 @@ fn main_do() -> Result<(), Error> {
         )
         .insert("acl", acl::cli())
         .insert("login", CliCommand::new(&API_METHOD_LOGIN))
+        .insert("metric-collection", metric_collection::cli())
         .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 00000000..e9dbd804
--- /dev/null
+++ b/cli/client/src/metric_collection.rs
@@ -0,0 +1,70 @@
+use anyhow::Error;
+use pdm_api_types::remotes::REMOTE_ID_SCHEMA;
+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(
+            "trigger",
+            CliCommand::new(&API_METHOD_TRIGGER_METRIC_COLLECTION),
+        )
+        .insert(
+            "status",
+            CliCommand::new(&API_METHOD_METRIC_COLLECTION_STATUS),
+        )
+        .into()
+}
+
+#[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.47.2



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


  parent reply	other threads:[~2025-08-21  9:54 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-21  9:52 [pdm-devel] [PATCH proxmox-datacenter-manager v6 00/23] metric collection improvements (concurrency, API, CLI) Lukas Wagner
2025-08-21  9:52 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 01/23] metric collection: split top_entities split into separate module Lukas Wagner
2025-08-21  9:52 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 02/23] metric collection: save metric data to RRD in separate task Lukas Wagner
2025-08-21  9:52 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 03/23] metric collection: rework metric poll task Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 04/23] metric collection: persist state after metric collection Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 05/23] metric collection: skip if last_collection < MIN_COLLECTION_INTERVAL Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 06/23] metric collection: collect overdue metrics on startup/timer change Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 07/23] metric collection: add tests for the fetch_remotes function Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 08/23] metric collection: add test for fetch_overdue Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 09/23] metric collection: pass rrd cache instance as function parameter Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 10/23] metric collection: add test for rrd task Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 11/23] metric collection: wrap rrd_cache::Cache in a struct Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 12/23] metric collection: record remote response time in metric database Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 13/23] metric collection: save time needed for collection run to RRD Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 14/23] metric collection: periodically clean removed remotes from statefile Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 15/23] api: add endpoint to trigger metric collection Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 16/23] api: remotes: trigger immediate metric collection for newly added nodes Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 17/23] api: add api for querying metric collection RRD data Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 18/23] api: metric-collection: add status endpoint Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 19/23] pdm-client: add metric collection API methods Lukas Wagner
2025-08-21  9:53 ` Lukas Wagner [this message]
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 21/23] metric collection: factor out handle_tick and handle_control_message fns Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 22/23] metric collection: skip missed timer ticks Lukas Wagner
2025-08-21  9:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 23/23] metric collection: use JoinSet instead of joining from handles in a Vec Lukas Wagner
2025-08-21 12:53 ` [pdm-devel] [PATCH proxmox-datacenter-manager v6 00/23] metric collection improvements (concurrency, API, CLI) Dominik Csapak
2025-08-21 13:46   ` Lukas Wagner
2025-08-22 11:27     ` Dominik Csapak
2025-08-27  7:19   ` Thomas Lamprecht
2025-08-22 11:51 ` Dominik Csapak
2025-08-22 12:49   ` Dominik Csapak
2025-08-25  8:43   ` Lukas Wagner
2025-08-26 13:53 ` [pdm-devel] superseded: " 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=20250821095319.134215-21-l.wagner@proxmox.com \
    --to=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