[pdm-devel] [PATCH proxmox-datacenter-manager v7 17/24] api: add api for querying metric collection RRD data
Lukas Wagner
l.wagner at proxmox.com
Tue Aug 26 15:51:12 CEST 2025
This commit adds two new API endpoints:
- remotes/{id}/rrddata
- nodes/localhost/rrddata
The first one returns graphable datapoints for the API response time
when fetching metrics, the second one datapoints about the total time
needed for collecting *all* remotes.
Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
Reviewed-by: Dominik Csapak <d.csapak at proxmox.com>
Tested-by: Dominik Csapak <d.csapak at proxmox.com>
---
lib/pdm-api-types/src/rrddata.rs | 26 ++++++++++++++
server/src/api/metric_collection.rs | 3 +-
server/src/api/nodes/mod.rs | 2 ++
server/src/api/nodes/rrddata.rs | 48 ++++++++++++++++++++++++++
server/src/api/remotes.rs | 53 +++++++++++++++++++++++++++++
5 files changed, 131 insertions(+), 1 deletion(-)
create mode 100644 server/src/api/nodes/rrddata.rs
diff --git a/lib/pdm-api-types/src/rrddata.rs b/lib/pdm-api-types/src/rrddata.rs
index a973977c..47847b72 100644
--- a/lib/pdm-api-types/src/rrddata.rs
+++ b/lib/pdm-api-types/src/rrddata.rs
@@ -216,3 +216,29 @@ pub struct PbsDatastoreDataPoint {
#[serde(skip_serializing_if = "Option::is_none")]
pub disk_write: Option<f64>,
}
+
+#[api]
+#[derive(Serialize, Deserialize, Default)]
+#[serde(rename_all = "kebab-case")]
+/// RRD datapoint for statistics about the metric collection loop.
+pub struct PdmNodeDatapoint {
+ /// Timestamp (UNIX epoch)
+ pub time: u64,
+
+ /// Total time in milliseconds needed for full metric collection run.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub total_time: Option<f64>,
+}
+
+#[api]
+#[derive(Serialize, Deserialize, Default)]
+#[serde(rename_all = "kebab-case")]
+/// RRD datapoint for a single remote.
+pub struct RemoteDatapoint {
+ /// Timestamp (UNIX epoch)
+ pub time: u64,
+
+ /// API response time in milliseconds when requesting the metrics from the remote.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub metric_collection_response_time: Option<f64>,
+}
diff --git a/server/src/api/metric_collection.rs b/server/src/api/metric_collection.rs
index 308ceca2..02e5be22 100644
--- a/server/src/api/metric_collection.rs
+++ b/server/src/api/metric_collection.rs
@@ -1,10 +1,11 @@
use anyhow::Error;
-use pdm_api_types::remotes::REMOTE_ID_SCHEMA;
use proxmox_router::{Router, SubdirMap};
use proxmox_schema::api;
use proxmox_sortable_macro::sortable;
+use pdm_api_types::remotes::REMOTE_ID_SCHEMA;
+
pub const ROUTER: Router = Router::new().subdirs(SUBDIRS);
#[sortable]
diff --git a/server/src/api/nodes/mod.rs b/server/src/api/nodes/mod.rs
index 42da798a..6f30ba7e 100644
--- a/server/src/api/nodes/mod.rs
+++ b/server/src/api/nodes/mod.rs
@@ -9,6 +9,7 @@ pub mod config;
pub mod dns;
pub mod journal;
pub mod network;
+pub mod rrddata;
pub mod syslog;
pub mod tasks;
pub mod termproxy;
@@ -43,6 +44,7 @@ pub const SUBDIRS: SubdirMap = &sorted!([
("dns", &dns::ROUTER),
("journal", &journal::ROUTER),
("network", &network::ROUTER),
+ ("rrdata", &rrddata::ROUTER),
("syslog", &syslog::ROUTER),
("tasks", &tasks::ROUTER),
("termproxy", &termproxy::ROUTER),
diff --git a/server/src/api/nodes/rrddata.rs b/server/src/api/nodes/rrddata.rs
new file mode 100644
index 00000000..de7f5a52
--- /dev/null
+++ b/server/src/api/nodes/rrddata.rs
@@ -0,0 +1,48 @@
+use anyhow::Error;
+use proxmox_rrd_api_types::{RrdMode, RrdTimeframe};
+
+use proxmox_router::Router;
+use proxmox_schema::api;
+
+use pdm_api_types::rrddata::PdmNodeDatapoint;
+
+use crate::api::rrd_common::{self, DataPoint};
+
+impl DataPoint for PdmNodeDatapoint {
+ fn new(time: u64) -> Self {
+ Self {
+ time,
+ ..Default::default()
+ }
+ }
+
+ fn fields() -> &'static [&'static str] {
+ &["metric-collection-total-time"]
+ }
+
+ fn set_field(&mut self, name: &str, value: f64) {
+ if name == "metric-collection-total-time" {
+ self.total_time = Some(value);
+ }
+ }
+}
+
+#[api(
+ input: {
+ properties: {
+ timeframe: {
+ type: RrdTimeframe,
+ },
+ cf: {
+ type: RrdMode,
+ },
+ },
+ },
+)]
+/// Read RRD data for this PDM node.
+fn get_node_rrddata(timeframe: RrdTimeframe, cf: RrdMode) -> Result<Vec<PdmNodeDatapoint>, Error> {
+ let base = "nodes/localhost";
+ rrd_common::create_datapoints_from_rrd(base, timeframe, cf)
+}
+
+pub const ROUTER: Router = Router::new().get(&API_METHOD_GET_NODE_RRDDATA);
diff --git a/server/src/api/remotes.rs b/server/src/api/remotes.rs
index b49228a9..c2489e60 100644
--- a/server/src/api/remotes.rs
+++ b/server/src/api/remotes.rs
@@ -9,6 +9,8 @@ use proxmox_access_control::CachedUserInfo;
use proxmox_router::{
http_bail, http_err, list_subdirs_api_method, Permission, Router, RpcEnvironment, SubdirMap,
};
+use proxmox_rrd_api_types::RrdMode;
+use proxmox_rrd_api_types::RrdTimeframe;
use proxmox_schema::api;
use proxmox_schema::Schema;
use proxmox_section_config::typed::SectionConfigData;
@@ -16,12 +18,15 @@ use proxmox_sortable_macro::sortable;
use proxmox_time::{epoch_i64, epoch_to_rfc2822};
use pdm_api_types::remotes::{Remote, RemoteType, RemoteUpdater, REMOTE_ID_SCHEMA};
+use pdm_api_types::rrddata::RemoteDatapoint;
use pdm_api_types::{Authid, ConfigDigest, PRIV_RESOURCE_AUDIT, PRIV_RESOURCE_MODIFY};
use crate::metric_collection;
use crate::{connection, pbs_client};
use super::pve;
+use super::rrd_common;
+use super::rrd_common::DataPoint;
pub const ROUTER: Router = Router::new()
.get(&API_METHOD_LIST_REMOTES)
@@ -38,6 +43,10 @@ const ITEM_ROUTER: Router = Router::new()
const SUBDIRS: SubdirMap = &sorted!([
("config", &Router::new().get(&API_METHOD_REMOTE_CONFIG)),
("version", &Router::new().get(&API_METHOD_VERSION)),
+ (
+ "rrddata",
+ &Router::new().get(&API_METHOD_GET_PER_REMOTE_RRD_DATA)
+ ),
]);
pub fn get_remote<'a>(
@@ -331,3 +340,47 @@ pub fn remote_config(id: String) -> Result<Remote, Error> {
remote.token = String::new(); // mask token in response
Ok(remote.clone())
}
+
+impl DataPoint for RemoteDatapoint {
+ fn new(time: u64) -> Self {
+ Self {
+ time,
+ ..Default::default()
+ }
+ }
+
+ fn fields() -> &'static [&'static str] {
+ &["metric-collection-response-time"]
+ }
+
+ fn set_field(&mut self, name: &str, value: f64) {
+ if name == "metric-collection-response-time" {
+ self.metric_collection_response_time = Some(value);
+ }
+ }
+}
+
+#[api(
+ input: {
+ properties: {
+ id: {
+ schema: REMOTE_ID_SCHEMA,
+ },
+ timeframe: {
+ type: RrdTimeframe,
+ },
+ cf: {
+ type: RrdMode,
+ },
+ },
+ },
+)]
+/// Read metric collection RRD data.
+fn get_per_remote_rrd_data(
+ id: String,
+ timeframe: RrdTimeframe,
+ cf: RrdMode,
+) -> Result<Vec<RemoteDatapoint>, Error> {
+ let base = format!("remotes/{id}");
+ rrd_common::create_datapoints_from_rrd(&base, timeframe, cf)
+}
--
2.47.2
More information about the pdm-devel
mailing list