[pdm-devel] [PATCH proxmox-datacenter-manager v2 03/28] pdm-api-types: add CollectionSettings type

[Lukas Wagner <l.wagner@proxmox.com>]

This commit adds the CollectionSettings type which holds settings for
the metric collection system. Included are collection interval, max
concurrency and upper/lower bounds for the metric collection loop.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 lib/pdm-api-types/src/lib.rs               |   3 +
 lib/pdm-api-types/src/metric_collection.rs | 188 +++++++++++++++++++++
 2 files changed, 191 insertions(+)
 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 38449071..6115e41c 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..92487d6c
--- /dev/null
+++ b/lib/pdm-api-types/src/metric_collection.rs
@@ -0,0 +1,188 @@
+//! API types for metric collection settings.
+
+use serde::{Deserialize, Serialize};
+
+use proxmox_schema::{api, Updater};
+
+/// Default metric collection interval.
+pub const DEFAULT_COLLECTION_INTERVAL: u64 = 600;
+
+/// Minimum metric collection interval.
+pub const MIN_COLLECTION_INTERVAL: u64 = 10;
+
+/// Maximum metric collection interval.
+/// PVE and PBS keep 30 minutes of metric history,
+/// maximum is set to 25 minutes to leave some headroom.
+pub const MAX_COLLECTION_INTERVAL: u64 = 1500;
+
+/// Default number of concurrent connections.
+pub const DEFAULT_CONCURRENCY: usize = 10;
+/// Maximum number of concurrent connections.
+pub const MAX_CONCURRENCY: u64 = 50;
+/// Minimum number of concurrent connections (no concurrency).
+pub const MIN_CONCURRENCY: u64 = 1;
+
+/// Default upper bound for the random delay for the
+/// main metric collection loop.
+pub const DEFAULT_MAX_OFFSET: u64 = 10;
+/// Default lower bound for the random delay for the
+/// main metric collection loop.
+pub const DEFAULT_MIN_OFFSET: u64 = 0;
+
+/// Highest configurable upper bound for the random interval offset for the main loop.
+pub const MAX_INTERVAL_OFFSET: u64 = 300;
+/// Lowest configureable lower bound for the random interval offset for the main loop.
+pub const MIN_INTERVAL_OFFSET: u64 = 0;
+
+/// Default upper bound for the random individual connection delay.
+pub const DEFAULT_MAX_CONNECTION_DELAY: u64 = 100;
+/// Default lower bound for the random individual connection delay.
+pub const DEFAULT_MIN_CONNECTION_DELAY: u64 = 0;
+
+/// Highest configurable upper bound for the random individual connection delay.
+pub const MAX_CONNECTION_DELAY: u64 = 1000;
+/// Lowest configurable lower bound for the random individual connection delay.
+pub const MIN_CONNECTION_DELAY: u64 = 0;
+
+#[api(
+    properties: {
+        "collection-interval" : {
+            optional: true,
+            default: DEFAULT_COLLECTION_INTERVAL as isize,
+            minimum: MIN_COLLECTION_INTERVAL as isize,
+            maximum: MAX_COLLECTION_INTERVAL as isize,
+        },
+        "max-concurrent-connections" : {
+            optional: true,
+            default: DEFAULT_CONCURRENCY as isize,
+            minimum: MIN_CONCURRENCY as isize,
+            maximum: MAX_CONCURRENCY as isize,
+        },
+        "max-interval-offset" : {
+            optional: true,
+            default: DEFAULT_MAX_OFFSET as isize,
+            minimum: MIN_INTERVAL_OFFSET as isize,
+            maximum: MAX_INTERVAL_OFFSET as isize,
+        },
+        "min-interval-offset" : {
+            optional: true,
+            default: DEFAULT_MIN_OFFSET as isize,
+            minimum: MIN_INTERVAL_OFFSET as isize,
+            maximum: MAX_INTERVAL_OFFSET as isize,
+        },
+        "max-connection-delay" : {
+            optional: true,
+            default: DEFAULT_MAX_CONNECTION_DELAY as isize,
+            minimum: MIN_CONNECTION_DELAY as isize,
+            maximum: MAX_CONNECTION_DELAY as isize,
+        },
+        "min-connection-delay" : {
+            optional: true,
+            default: DEFAULT_MIN_CONNECTION_DELAY as isize,
+            minimum: MIN_CONNECTION_DELAY as isize,
+            maximum: MAX_CONNECTION_DELAY as isize,
+        },
+    },
+)]
+#[derive(Clone, Default, Deserialize, Serialize, Updater)]
+#[serde(rename_all = "kebab-case")]
+/// Settings for the metric collection system.
+pub struct CollectionSettings {
+    /// Collection settings ID
+    #[updater(skip)]
+    pub id: String,
+
+    /// Interval in seconds at which to collect metrics.
+    /// The point in time at which metrics are collected
+    /// are aligned based on the collection interval. For instance,
+    /// a collection interval of 300 (5 minutes) would schedule metric collection
+    /// at 11:00:00, 11:05:00 (without accounting for the random offset).
+    ///
+    /// To avoid load spikes, metric collection runs are offeset by
+    /// a random number of seconds between min_interval_offset and max_interval_offset.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub collection_interval: Option<u64>,
+
+    /// Maximum number of concurrent connections while collecting metrics.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub max_concurrent_connections: Option<usize>,
+
+    /// Maximum offset in seconds for the metric collection interval.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub max_interval_offset: Option<u64>,
+
+    /// Minimum offset in seconds for the metric collection interval.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub min_interval_offset: Option<u64>,
+
+    /// Maximum random delay in milliseconds for each outgoing connection.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub max_connection_delay: Option<u64>,
+
+    /// Minimum random delay in milliseconds for each outgoing connection.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub min_connection_delay: Option<u64>,
+}
+
+#[api]
+#[derive(Copy, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "kebab-case")]
+/// Deletable property for [`CollectionSettings`].
+pub enum DeletableCollectionSettingsProperty {
+    /// Delete 'collection-interval'.
+    CollectionInterval,
+    /// Delete 'max-concurrent-connections'.
+    MaxConcurrentConnections,
+    /// Delete 'max-interval-offset'.
+    MaxIntervalOffset,
+    /// Delete 'min-interval-offset'.
+    MinIntervalOffset,
+    /// Delete 'min-connection-delay'.
+    MaxConnectionDelay,
+    /// Delete 'min-connection-delay'.
+    MinConnectionDelay,
+}
+
+impl CollectionSettings {
+    /// Create a new settings instance with a given `id`.
+    pub fn new(id: &str) -> Self {
+        Self {
+            id: id.into(),
+            ..Default::default()
+        }
+    }
+
+    /// Return the collection interval or the default if not configured.
+    pub fn collection_interval_or_default(&self) -> u64 {
+        self.collection_interval
+            .unwrap_or(DEFAULT_COLLECTION_INTERVAL)
+    }
+
+    /// Return the number of allowed concurrent connections or the default if not configured.
+    pub fn max_concurrent_connections_or_default(&self) -> usize {
+        self.max_concurrent_connections
+            .unwrap_or(DEFAULT_CONCURRENCY)
+    }
+
+    /// Return the upper bound for the main loop delay or the default if not configured.
+    pub fn max_interval_offset_or_default(&self) -> u64 {
+        self.max_interval_offset.unwrap_or(DEFAULT_MAX_OFFSET)
+    }
+
+    /// Return the lower bound for the main loop delay or the default if not configured.
+    pub fn min_interval_offset_or_default(&self) -> u64 {
+        self.min_interval_offset.unwrap_or(DEFAULT_MIN_OFFSET)
+    }
+
+    /// Return the upper bound for the connection delay or the default if not configured.
+    pub fn max_connection_delay_or_default(&self) -> u64 {
+        self.max_connection_delay
+            .unwrap_or(DEFAULT_MAX_CONNECTION_DELAY)
+    }
+
+    /// Return the lower bound for the connection delay or the default if not configured.
+    pub fn min_connection_delay_or_default(&self) -> u64 {
+        self.min_connection_delay
+            .unwrap_or(DEFAULT_MIN_CONNECTION_DELAY)
+    }
+}
-- 
2.39.5



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