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 v2 24/28] pdm-client: add metric collection API methods
Date: Fri, 14 Feb 2025 14:06:49 +0100	[thread overview]
Message-ID: <20250214130653.283012-25-l.wagner@proxmox.com> (raw)
In-Reply-To: <20250214130653.283012-1-l.wagner@proxmox.com>

This adds bindings for collection settings, trigger, and status APIs.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 lib/pdm-client/src/lib.rs | 87 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 87 insertions(+)

diff --git a/lib/pdm-client/src/lib.rs b/lib/pdm-client/src/lib.rs
index a41b82ca..70880576 100644
--- a/lib/pdm-client/src/lib.rs
+++ b/lib/pdm-client/src/lib.rs
@@ -320,6 +320,93 @@ impl<T: HttpApiClient> PdmClient<T> {
             .ok_or_else(|| Error::BadApi("api returned no webauthn entry id".to_string(), None))
     }
 
+    /// Get global metric collection settings.
+    pub async fn get_metric_collection_settings(
+        &self,
+    ) -> Result<pdm_api_types::CollectionSettings, Error> {
+        let path = "/api2/extjs/config/metric-collection/default";
+        Ok(self.0.get(path).await?.expect_json()?.data)
+    }
+
+    /// Update global metric collection settings.
+    pub async fn update_metric_collection_settings(
+        &self,
+        updater: pdm_api_types::CollectionSettingsUpdater,
+        delete: Option<Vec<pdm_api_types::DeletableCollectionSettingsProperty>>,
+    ) -> Result<(), Error> {
+        let path = "/api2/extjs/config/metric-collection/default";
+
+        #[derive(Serialize)]
+        struct UpdateSettings<'a> {
+            updater: &'a pdm_api_types::CollectionSettingsUpdater,
+            #[serde(skip_serializing_if = "Option::is_none")]
+            delete: Option<Vec<pdm_api_types::DeletableCollectionSettingsProperty>>,
+        }
+
+        let params = UpdateSettings {
+            updater: &updater,
+            delete,
+        };
+        self.0.put(path, &params).await?.nodata()?;
+        Ok(())
+    }
+
+    /// Trigger metric collection for a single remote or for all remotes, if no remote is provided.
+    pub async fn trigger_metric_collection(
+        &self,
+        remote: Option<&str>,
+    ) -> Result<(), proxmox_client::Error> {
+        let path = "/api2/extjs/metric-collection/trigger";
+
+        #[derive(Serialize)]
+        struct TriggerParams<'a> {
+            #[serde(skip_serializing_if = "Option::is_none")]
+            remote: Option<&'a str>,
+        }
+
+        self.0
+            .post(path, &TriggerParams { remote })
+            .await?
+            .nodata()?;
+
+        Ok(())
+    }
+
+    /// Get global metric collection status.
+    pub async fn get_metric_collection_status(
+        &self,
+    ) -> Result<Vec<pdm_api_types::MetricCollectionStatus>, Error> {
+        let path = "/api2/extjs/metric-collection/status";
+        Ok(self.0.get(path).await?.expect_json()?.data)
+    }
+
+    /// Get global metric collection status.
+    pub async fn get_metric_collection_rrddata(
+        &self,
+        mode: RrdMode,
+        timeframe: RrdTimeframe,
+    ) -> Result<pdm_api_types::rrddata::FullCollectionDatapoint, Error> {
+        let mut path = "/api2/extjs/metric-collection/rrddata".to_string();
+        let mut sep = '?';
+        add_query_arg(&mut path, &mut sep, "cf", &Some(mode));
+        add_query_arg(&mut path, &mut sep, "timeframe", &Some(timeframe));
+        Ok(self.0.get(&path).await?.expect_json()?.data)
+    }
+
+    /// Get per-remote metric collection status.
+    pub async fn get_per_remote_metric_collection_rrddata(
+        &self,
+        remote: &str,
+        mode: RrdMode,
+        timeframe: RrdTimeframe,
+    ) -> Result<pdm_api_types::rrddata::RemoteCollectionDatapoint, Error> {
+        let mut path = format!("/api2/extjs/remotes/{remote}/metric-collection-rrddata");
+        let mut sep = '?';
+        add_query_arg(&mut path, &mut sep, "cf", &Some(mode));
+        add_query_arg(&mut path, &mut sep, "timeframe", &Some(timeframe));
+        Ok(self.0.get(&path).await?.expect_json()?.data)
+    }
+
     pub async fn pve_list_nodes(
         &self,
         remote: &str,
-- 
2.39.5



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


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

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-14 13:06 [pdm-devel] [PATCH proxmox-datacenter-manager v2 00/28] metric collection improvements (concurrency, config, API, CLI) Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 01/28] test support: add NamedTempFile helper Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 02/28] test support: add NamedTempDir helper Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 03/28] pdm-api-types: add CollectionSettings type Lukas Wagner
2025-02-18 15:26   ` Wolfgang Bumiller
2025-02-18 15:31     ` Stefan Hanreich
2025-02-21  8:27     ` Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 04/28] pdm-config: add functions for reading/writing metric collection settings Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 05/28] metric collection: split top_entities split into separate module Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 06/28] metric collection: save metric data to RRD in separate task Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 07/28] metric collection: rework metric poll task Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 08/28] metric collection: persist state after metric collection Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 09/28] metric collection: skip if last_collection < MIN_COLLECTION_INTERVAL Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 10/28] metric collection: collect overdue metrics on startup/timer change Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 11/28] metric collection: add tests for the fetch_remotes function Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 12/28] metric collection: add test for fetch_overdue Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 13/28] metric collection: pass rrd cache instance as function parameter Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 14/28] metric collection: add test for rrd task Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 15/28] metric collection: wrap rrd_cache::Cache in a struct Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 16/28] metric collection: record remote response time in metric database Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 17/28] metric collection: save time needed for collection run to RRD Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 18/28] metric collection: periodically clean removed remotes from statefile Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 19/28] api: add endpoint for updating metric collection settings Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 20/28] api: add endpoint to trigger metric collection Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 21/28] api: remotes: trigger immediate metric collection for newly added nodes Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 22/28] api: add api for querying metric collection RRD data Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 23/28] api: metric-collection: add status endpoint Lukas Wagner
2025-02-14 13:06 ` Lukas Wagner [this message]
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 25/28] cli: add commands for metric-collection settings, trigger, status Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 26/28] metric collection: factor out handle_tick and handle_control_message fns Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 27/28] metric collection: skip missed timer ticks Lukas Wagner
2025-02-14 13:06 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 28/28] metric collection: use JoinSet instead of joining from handles in a Vec Lukas Wagner
2025-02-21 13:19 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 00/28] metric collection improvements (concurrency, config, API, CLI) Maximiliano Sandoval
2025-03-14 14:10 ` 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=20250214130653.283012-25-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