[pbs-devel] [PATCH proxmox-backup 02/13] metric collection: add doc comments for public functions

From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 02/13] metric collection: add doc comments for public functions
Date: Fri, 11 Oct 2024 12:51:26 +0200	[thread overview]
Message-ID: <20241011105137.131530-3-l.wagner@proxmox.com> (raw)
In-Reply-To: <20241011105137.131530-1-l.wagner@proxmox.com>

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 src/server/metric_collection/mod.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/server/metric_collection/mod.rs b/src/server/metric_collection/mod.rs
index e220f51a..1ca13222 100644
--- a/src/server/metric_collection/mod.rs
+++ b/src/server/metric_collection/mod.rs
@@ -21,12 +21,20 @@ use crate::{
     tools::disks::{zfs_dataset_stats, BlockDevStat, DiskManage},
 };
 
+/// Initialize the metric collection subsystem.
+///
+/// Any datapoints in the RRD journal will be committed.
 pub fn init() -> Result<(), Error> {
     let rrd_cache = initialize_rrd_cache()?;
     rrd_cache.apply_journal()?;
     Ok(())
 }
 
+/// Spawns a tokio task for regular metric collection.
+///
+/// Every 10 seconds, host and disk stats will be collected and
+///   - stored in the RRD
+///   - sent to any configured metric servers
 pub fn start_collection_task() {
     tokio::spawn(async {
         let abort_future = pin!(proxmox_daemon::shutdown_future());
-- 
2.39.5



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

