[pdm-devel] [PATCH proxmox-datacenter-manager v7 18/24] api: metric-collection: add status endpoint

[Lukas Wagner]

This adds a new API endpoint at /metric-collection/status, returning the
status of the last metric collection attempt from each remote.
For now, this contains the timestamp (last-collected) and any
error that occurred (error).

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

Notes:
    Changes since v2:
      - use `_` for type casts
      - Drop max-concurrency, and delay settings for now

 lib/pdm-api-types/src/lib.rs               |  3 +++
 lib/pdm-api-types/src/metric_collection.rs | 20 ++++++++++++++++++
 server/src/api/metric_collection.rs        | 24 +++++++++++++++++-----
 server/src/metric_collection/mod.rs        | 21 +++++++++++++++++++
 4 files changed, 63 insertions(+), 5 deletions(-)
 create mode 100644 lib/pdm-api-types/src/metric_collection.rs

diff --git a/lib/pdm-api-types/src/lib.rs b/lib/pdm-api-types/src/lib.rs
index 37da134c..8dbacba9 100644
--- a/lib/pdm-api-types/src/lib.rs
+++ b/lib/pdm-api-types/src/lib.rs
@@ -19,6 +19,9 @@ pub use acl::*;
 mod node_config;
 pub use node_config::*;
 
+mod metric_collection;
+pub use metric_collection::*;
+
 mod proxy;
 pub use proxy::HTTP_PROXY_SCHEMA;
 
diff --git a/lib/pdm-api-types/src/metric_collection.rs b/lib/pdm-api-types/src/metric_collection.rs
new file mode 100644
index 00000000..5279c8a4
--- /dev/null
+++ b/lib/pdm-api-types/src/metric_collection.rs
@@ -0,0 +1,20 @@
+//! API types for metric collection.
+
+use serde::{Deserialize, Serialize};
+
+use proxmox_schema::api;
+
+#[api]
+#[derive(Clone, Deserialize, Serialize)]
+#[serde(rename_all = "kebab-case")]
+/// Per-remote collection status.
+pub struct MetricCollectionStatus {
+    /// The remote's name.
+    pub remote: String,
+    /// Any error that occured during the last collection attempt.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub error: Option<String>,
+    /// Timestamp of last successful collection.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub last_collection: Option<i64>,
+}
diff --git a/server/src/api/metric_collection.rs b/server/src/api/metric_collection.rs
index 02e5be22..845cc0e6 100644
--- a/server/src/api/metric_collection.rs
+++ b/server/src/api/metric_collection.rs
@@ -4,15 +4,23 @@ use proxmox_router::{Router, SubdirMap};
 use proxmox_schema::api;
 use proxmox_sortable_macro::sortable;
 
-use pdm_api_types::remotes::REMOTE_ID_SCHEMA;
+use pdm_api_types::{remotes::REMOTE_ID_SCHEMA, MetricCollectionStatus};
+
+use crate::metric_collection;
 
 pub const ROUTER: Router = Router::new().subdirs(SUBDIRS);
 
 #[sortable]
-const SUBDIRS: SubdirMap = &sorted!([(
-    "trigger",
-    &Router::new().post(&API_METHOD_TRIGGER_METRIC_COLLECTION)
-),]);
+const SUBDIRS: SubdirMap = &sorted!([
+    (
+        "trigger",
+        &Router::new().post(&API_METHOD_TRIGGER_METRIC_COLLECTION)
+    ),
+    (
+        "status",
+        &Router::new().get(&API_METHOD_GET_METRIC_COLLECTION_STATUS)
+    ),
+]);
 
 #[api(
     input: {
@@ -30,3 +38,9 @@ pub async fn trigger_metric_collection(remote: Option<String>) -> Result<(), Err
 
     Ok(())
 }
+
+#[api]
+/// Read metric collection status.
+fn get_metric_collection_status() -> Result<Vec<MetricCollectionStatus>, Error> {
+    metric_collection::get_status()
+}
diff --git a/server/src/metric_collection/mod.rs b/server/src/metric_collection/mod.rs
index 41772a95..2ddffda5 100644
--- a/server/src/metric_collection/mod.rs
+++ b/server/src/metric_collection/mod.rs
@@ -6,6 +6,7 @@ use anyhow::{bail, Error};
 use nix::sys::stat::Mode;
 use tokio::sync::mpsc::{self, Sender};
 
+use pdm_api_types::MetricCollectionStatus;
 use pdm_buildcfg::PDM_STATE_DIR_M;
 
 mod collection_task;
@@ -78,3 +79,23 @@ pub async fn trigger_metric_collection(remote: Option<String>) -> Result<(), Err
 
     Ok(())
 }
+
+/// Get each remote's metric collection status.
+pub fn get_status() -> Result<Vec<MetricCollectionStatus>, Error> {
+    let (remotes, _) = pdm_config::remotes::config()?;
+    let state = collection_task::load_state()?;
+
+    let mut result = Vec::new();
+
+    for (remote, _) in remotes.into_iter() {
+        if let Some(status) = state.get_status(&remote) {
+            result.push(MetricCollectionStatus {
+                remote,
+                error: status.error.clone(),
+                last_collection: status.last_collection,
+            })
+        }
+    }
+
+    Ok(result)
+}
-- 
2.47.2