docs: add metrics docs

gusinacio · gusinacio · commit cd525886f069 · 2025-02-06T16:48:00.000+01:00
Signed-off-by: Gustavo Inacio &lt;gustavo@semiotic.ai&gt;
diff --git a/crates/tap-agent/src/metrics.rs b/crates/tap-agent/src/metrics.rs
@@ -48,6 +48,9 @@ async fn _run_server(port: u16) {
     };
 }
 
+/// Run the server on a given `port`.
+///
+/// This is recommended to run inside a Task
 pub async fn run_server(port: u16) {
     // Code here is to abort program if there is a panic in _run_server
     // Otherwise, when spawning the task, the panic will be silently ignored

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,9 @@ async fn _run_server(port: u16) {`
`48`	`48`	`};`
`49`	`49`	`}`
`50`	`50`
	`51`	+/// Run the server on a given `port`.
	`52`	`+///`
	`53`	`+/// This is recommended to run inside a Task`
`51`	`54`	`pub async fn run_server(port: u16) {`
`52`	`55`	`// Code here is to abort program if there is a panic in _run_server`
`53`	`56`	`// Otherwise, when spawning the task, the panic will be silently ignored`