lil docs

metalbear-co · Jan 22, 2025 · caaca9a · caaca9a
1 parent aaa750f
commit caaca9a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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,