From: Lukas Wagner <l.wagner@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH proxmox-datacenter-manager v3 17/26] api: add endpoint for updating metric collection settings
Date: Wed, 16 Apr 2025 14:56:33 +0200 [thread overview]
Message-ID: <20250416125642.291552-18-l.wagner@proxmox.com> (raw)
In-Reply-To: <20250416125642.291552-1-l.wagner@proxmox.com>
This one lives under /config/metric-collection.
At the moment, we do not offer full CRUD, but only offer a hard-coded
collection settings instance at /config/metric-collection/default, which
can be retrieved via GET and updated via PUT.
Later, we might update this to full CRUD, e.g. to have different
settings for different 'poll-groups' consisting of a sub-set of remotes.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
server/src/api/config/metric_collection.rs | 97 ++++++++++++++++++++++
server/src/api/config/mod.rs | 2 +
2 files changed, 99 insertions(+)
create mode 100644 server/src/api/config/metric_collection.rs
diff --git a/server/src/api/config/metric_collection.rs b/server/src/api/config/metric_collection.rs
new file mode 100644
index 00000000..751b741e
--- /dev/null
+++ b/server/src/api/config/metric_collection.rs
@@ -0,0 +1,97 @@
+use anyhow::Error;
+
+use proxmox_config_digest::ConfigDigest;
+use proxmox_router::{list_subdirs_api_method, Router, RpcEnvironment, SubdirMap};
+use proxmox_schema::api;
+use proxmox_sortable_macro::sortable;
+
+use pdm_api_types::{
+ CollectionSettings, CollectionSettingsUpdater, DeletableCollectionSettingsProperty,
+};
+use pdm_config::metric_collection::COLLECTION_SETTINGS_TYPE;
+
+#[sortable]
+const SUBDIRS: SubdirMap = &sorted!([("default", &DEFAULT_ROUTER),]);
+
+pub const ROUTER: Router = Router::new()
+ .get(&list_subdirs_api_method!(SUBDIRS))
+ .subdirs(SUBDIRS);
+
+const DEFAULT_ROUTER: Router = Router::new()
+ .get(&API_METHOD_GET_SETTINGS)
+ .put(&API_METHOD_UPDATE_SETTINGS);
+
+#[api]
+/// Get metric collection settings.
+pub fn get_settings(rpcenv: &mut dyn RpcEnvironment) -> Result<CollectionSettings, Error> {
+ let (config, digest) = pdm_config::metric_collection::config()?;
+ rpcenv["digest"] = digest.to_hex().into();
+
+ if config.sections.contains_key("default") {
+ config.lookup(COLLECTION_SETTINGS_TYPE, "default")
+ } else {
+ Ok(CollectionSettings::new("default"))
+ }
+}
+
+#[api(
+ input: {
+ properties: {
+ updater: {
+ type: CollectionSettingsUpdater,
+ },
+ delete: {
+ type: Array,
+ items: {
+ type: DeletableCollectionSettingsProperty,
+ },
+ description: "Array of properties that should be deleted.",
+ optional: true,
+ },
+ digest: {
+ type: ConfigDigest,
+ optional: true,
+ },
+ },
+ },
+)]
+/// Update metric collection settings.
+pub fn update_settings(
+ updater: CollectionSettingsUpdater,
+ delete: Option<Vec<DeletableCollectionSettingsProperty>>,
+ digest: Option<ConfigDigest>,
+) -> Result<(), Error> {
+ let (mut config, existing_digest) = pdm_config::metric_collection::config()?;
+ if digest.is_some() {
+ existing_digest.detect_modification(digest.as_ref())?;
+ }
+
+ let mut entry = if config.sections.contains_key("default") {
+ config.lookup(COLLECTION_SETTINGS_TYPE, "default")?
+ } else {
+ CollectionSettings::new("default")
+ };
+
+ if let Some(delete) = delete {
+ for property in delete {
+ use DeletableCollectionSettingsProperty::*;
+
+ match property {
+ CollectionInterval => entry.collection_interval = None,
+ }
+ }
+ }
+
+ let CollectionSettingsUpdater {
+ collection_interval,
+ } = updater;
+
+ if let Some(value) = collection_interval {
+ entry.collection_interval = Some(value);
+ }
+
+ config.set_data("default", COLLECTION_SETTINGS_TYPE, entry)?;
+ pdm_config::metric_collection::save_config(&config)?;
+
+ Ok(())
+}
diff --git a/server/src/api/config/mod.rs b/server/src/api/config/mod.rs
index 7b58c756..15dc42c8 100644
--- a/server/src/api/config/mod.rs
+++ b/server/src/api/config/mod.rs
@@ -5,6 +5,7 @@ use proxmox_sortable_macro::sortable;
pub mod access;
pub mod acme;
pub mod certificate;
+pub mod metric_collection;
pub mod notes;
#[sortable]
@@ -12,6 +13,7 @@ const SUBDIRS: SubdirMap = &sorted!([
("access", &access::ROUTER),
("acme", &acme::ROUTER),
("certificate", &certificate::ROUTER),
+ ("metric-collection", &metric_collection::ROUTER),
("notes", ¬es::ROUTER),
]);
--
2.39.5
_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel
next prev parent reply other threads:[~2025-04-16 12:57 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-16 12:56 [pdm-devel] [PATCH proxmox-datacenter-manager v3 00/26] metric collection improvements (concurrency, config, API, CLI) Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 01/26] pdm-api-types: add CollectionSettings type Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 02/26] pdm-config: add functions for reading/writing metric collection settings Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 03/26] metric collection: split top_entities split into separate module Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 04/26] metric collection: save metric data to RRD in separate task Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 05/26] metric collection: rework metric poll task Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 06/26] metric collection: persist state after metric collection Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 07/26] metric collection: skip if last_collection < MIN_COLLECTION_INTERVAL Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 08/26] metric collection: collect overdue metrics on startup/timer change Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 09/26] metric collection: add tests for the fetch_remotes function Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 10/26] metric collection: add test for fetch_overdue Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 11/26] metric collection: pass rrd cache instance as function parameter Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 12/26] metric collection: add test for rrd task Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 13/26] metric collection: wrap rrd_cache::Cache in a struct Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 14/26] metric collection: record remote response time in metric database Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 15/26] metric collection: save time needed for collection run to RRD Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 16/26] metric collection: periodically clean removed remotes from statefile Lukas Wagner
2025-04-16 12:56 ` Lukas Wagner [this message]
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 18/26] api: add endpoint to trigger metric collection Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 19/26] api: remotes: trigger immediate metric collection for newly added nodes Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 20/26] api: add api for querying metric collection RRD data Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 21/26] api: metric-collection: add status endpoint Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 22/26] pdm-client: add metric collection API methods Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 23/26] cli: add commands for metric-collection settings, trigger, status Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 24/26] metric collection: factor out handle_tick and handle_control_message fns Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 25/26] metric collection: skip missed timer ticks Lukas Wagner
2025-04-16 12:56 ` [pdm-devel] [PATCH proxmox-datacenter-manager v3 26/26] metric collection: use JoinSet instead of joining from handles in a Vec Lukas Wagner
2025-05-12 13:38 ` [pdm-devel] superseded: [PATCH proxmox-datacenter-manager v3 00/26] 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=20250416125642.291552-18-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