From caaca9a2e7063ada54e67de96842f6a84932b1ff Mon Sep 17 00:00:00 2001
From: meowjesty <meowjesty_nyan@outlook.com>
Date: Wed, 22 Jan 2025 12:30:59 -0300
Subject: [PATCH] lil docs

---
 mirrord/agent/src/metrics.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/mirrord/agent/src/metrics.rs b/mirrord/agent/src/metrics.rs
index 9e2fcfb545d..59fefbc2305 100644
--- a/mirrord/agent/src/metrics.rs
+++ b/mirrord/agent/src/metrics.rs
@@ -289,6 +289,11 @@ async fn get_metrics(State(state): State<Arc<Metrics>>) -> (StatusCode, String)
     }
 }
 
+/// Starts the mirrord-agent prometheus metrics service.
+///
+/// You can get the metrics from `GET address/metrics`.
+///
+/// - `address`: comes from a mirrord-agent config.
 #[tracing::instrument(level = Level::TRACE, skip_all, ret ,err)]
 pub(crate) async fn start_metrics(
     address: SocketAddr,