scuffle-metrics: tests and docs

[lennartkloock]

• Add test coverage
• Add docs

Closes CLOUD-6

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 62.77%. Comparing base (494a60b) to head (2e946bd).
Report is 36 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
crates/bootstrap/telemetry/src/opentelemetry.rs	90.00%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #252      +/-   ##
==========================================
+ Coverage   55.74%   62.77%   +7.03%     
==========================================
  Files         195      196       +1     
  Lines       15850    15850              
==========================================
+ Hits         8835     9950    +1115     
+ Misses       7015     5900    -1115     

Files with missing lines	Coverage Δ
crates/bootstrap/telemetry/src/lib.rs	76.78% <ø> (+76.78%)	⬆️
crates/metrics/derive/src/lib.rs	80.00% <ø> (ø)
crates/metrics/src/collector.rs	30.76% <ø> (+30.76%)	⬆️
crates/metrics/src/prometheus/mod.rs	62.08% <ø> (+62.08%)	⬆️
crates/bootstrap/telemetry/src/opentelemetry.rs	90.00% <90.00%> (ø)

... and 14 files with indirect coverage changes

Components	Coverage Δ
scuffle-batching	100.00% <ø> (ø)
scuffle-bootstrap	86.50% <90.00%> (+33.89%)	⬆️
scuffle-context	100.00% <ø> (ø)
scuffle-ffmpeg	31.81% <ø> (ø)
scuffle-h3-webtransport	0.00% <ø> (ø)
scuffle-http	22.48% <ø> (+22.48%)	⬆️
scuffle-metrics	66.39% <ø> (+23.70%)	⬆️
scuffle-pprof	100.00% <ø> (+100.00%)	⬆️
scuffle-settings	0.00% <ø> (ø)
scuffle-signal	100.00% <ø> (ø)
postcompile	76.87% <ø> (+76.87%)	⬆️
scuffle-image-processor	∅ <ø> (∅)

[cloudflare-workers-and-pages]

Deploying scuffle-docrs with    Cloudflare Pages

Latest commit:	2e946bd
Status:	✅  Deploy successful!
Preview URL:	https://11ece6b0.scuffle-docrs.pages.dev
Branch Preview URL:	https://pr-252.scuffle-docrs.pages.dev

View logs

[TroyKomodo]

We should likely add an example using it with the scuffle_bootstrap_telemetry crate or just somehow to add it to the open telemetry exporter.

We should add what the #[metrics] attribute does here in the #[derive(MetricEnum)] context.

We are missing docs on the types under the scuffle_metrics::collector and scuffle_metrics::prometheus modules.

Is there a way to fix the weird formatting here?

We should add a doc example with using it with the bootstrap crate on the TelemetrySvc or on the root scuffle_bootstrap_telemetry?

Missing some documentation on scuffle_bootstrap_telemetry::opentelemetry::OpenTelemetry & scuffle_bootstrap_telemetry::opentelemetry::OpenTelemetryError

[TroyKomodo]

The derive macro also allows for renaming fields.

https://pr-252.scuffle-docrs.pages.dev/scuffle_metrics/collector/struct.Collector the new function here talks about a metrics! macro but this is a bit misleading since this is a attribute macro not a declarative macro. I think better phrasing should be, this is typically used internally for constructing types when using the #[metrics] module or function attribute.

https://pr-252.scuffle-docrs.pages.dev/scuffle_metrics/prometheus/struct.PrometheusExporter the links here do not embed, not sure if desired. perhaps link directly to the upstream docs.rs?

[TroyKomodo]

?brawl merge

[scuffle-brawl]

📌 Commit 2e946bd has been approved and added to the merge queue.

Requested by: @TroyKomodo

Approved by: @TroyKomodo

[scuffle-brawl]

⌛ Trying commit 2e946bd with merge fa14d64...

[scuffle-brawl]

🎉 Build successful!
Completed in 8:23

• brawl-done

Approved by: @TroyKomodo
Pushing fa14d64 to main