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 19/28] api: add endpoint for updating metric collection settings
Date: Fri, 14 Feb 2025 14:06:44 +0100	[thread overview]
Message-ID: <20250214130653.283012-20-l.wagner@proxmox.com> (raw)
In-Reply-To: <20250214130653.283012-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>
---
 server/src/api/config/metric_collection.rs | 156 +++++++++++++++++++++
 server/src/api/config/mod.rs               |   2 +
 2 files changed, 158 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..0915179d
--- /dev/null
+++ b/server/src/api/config/metric_collection.rs
@@ -0,0 +1,156 @@
+use anyhow::{bail, 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")
+    };
+
+    let mut interval_offset_changed = false;
+    let mut connection_delay_changed = false;
+
+    if let Some(delete) = delete {
+        for property in delete {
+            use DeletableCollectionSettingsProperty::*;
+
+            match property {
+                MaxIntervalOffset => {
+                    entry.max_interval_offset = None;
+                    interval_offset_changed = true;
+                }
+                MinIntervalOffset => {
+                    entry.min_interval_offset = None;
+                    interval_offset_changed = true;
+                }
+                MaxConnectionDelay => {
+                    entry.max_connection_delay = None;
+                    connection_delay_changed = true;
+                }
+                MinConnectionDelay => {
+                    entry.min_connection_delay = None;
+                    connection_delay_changed = true;
+                }
+                MaxConcurrentConnections => entry.max_concurrent_connections = None,
+                CollectionInterval => entry.collection_interval = None,
+            }
+        }
+    }
+
+    let CollectionSettingsUpdater {
+        collection_interval,
+        max_concurrent_connections,
+        max_interval_offset,
+        min_interval_offset,
+        max_connection_delay,
+        min_connection_delay,
+    } = updater;
+
+    if let Some(value) = collection_interval {
+        entry.collection_interval = Some(value);
+    }
+    if let Some(value) = max_concurrent_connections {
+        entry.max_concurrent_connections = Some(value);
+    }
+    if let Some(value) = max_interval_offset {
+        entry.max_interval_offset = Some(value);
+        interval_offset_changed = true;
+    }
+    if let Some(value) = min_interval_offset {
+        entry.min_interval_offset = Some(value);
+        interval_offset_changed = true;
+    }
+    if let Some(value) = max_connection_delay {
+        entry.max_connection_delay = Some(value);
+        connection_delay_changed = true;
+    }
+    if let Some(value) = min_connection_delay {
+        entry.min_connection_delay = Some(value);
+        connection_delay_changed = true;
+    }
+
+    // Ensure that the minimum value is <= the maximum value - but only if we have
+    // actually changed the value. We do not want to fail if the config already contains
+    // something invalid and we are changing *other* settings.
+    if entry.min_interval_offset_or_default() > entry.max_interval_offset_or_default()
+        && interval_offset_changed
+    {
+        bail!("min-interval-offset must not be larger than max-interval-offset");
+    }
+
+    if (entry.min_connection_delay_or_default() > entry.max_connection_delay_or_default())
+        && connection_delay_changed
+    {
+        bail!("min-connection-delay must not be larger than max-connection-delay");
+    }
+
+    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", &notes::ROUTER),
 ]);
 
-- 
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 ` Lukas Wagner [this message]
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 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 24/28] pdm-client: add metric collection API methods Lukas Wagner
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-20-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