refactor!: Make metrics raw atomics, remove `prometheus_client` dependency #22

Frando · 2025-04-28T08:30:57Z

Description

Changes the Counter and Gauge to be a wrapper around raw Atomic values, without Arc
Removes the Clone requirement from Metric. Instead, the metric groups are Arcd.
Removes the help field from Counter and Gauge. Instead, the help is part of the (derived) field iterator, either set from the docstring or with the #[metric(help = "...")] attribute.
Adds a Registry to combine multiple metric sources into one
Adds encoding methods to encode registries into the OpenMetrics text format

Breaking Changes

Metric::help is removed. The help text for metric items is no longer available directly from the item. Instead it is accessible from the MetricsGroup that contains the metrics item. Use MetricsGroup::iter to iterate over the metric items in a group, and MetricItem::help to get the help text for each item.
The metric items types, Counter and Gauge, are both changed:
- They no longer implement Clone. If you need to clone them, put them or an outer struct into an Arc.
- The new method does not take any args anymore. They now also implement Default.
- The help method is removed.
MetricsIter is no longer needed and removed (replaced by iterable::FieldsIter).
The trait MetricsGroupSet has a new required method groups_cloned, returning an iterator of Arc<dyn MetricsGroup>. This means that to implement MetricsGroupSet, a struct has to contain Arc<SomeMetricsGroup>. Because individual metric items are no longer cloneable, this is recommended anyway.
MetricsGroup::register and MetricsGroupSet::register are removed. Use Registry::register and Registry::register_all instead.
static_core::Core::encode is replaced by static_core::Core::encode_openmetrics
The trait iroh_metrics::service::MetricsSource is changed:
- It is longer behind the services feature flag but always available under iroh_metrics::MetricsSource
- The required method is now encode_openmetrics(&self, writer: impl std::fmt::Write). To encode directly into a string, use the provided encode_openmetrics_to_string method.

Notes & open questions

Change checklist

Self-review.
Documentation updates following the style guide, if relevant.
Tests if relevant.
All breaking changes documented.

Frando · 2025-04-28T08:43:34Z

src/base.rs

    }

    impl MetricsGroupSet for CombinedMetrics {
        fn name(&self) -> &'static str {
            "combined"
        }

+        fn groups_cloned(&self) -> impl Iterator<Item = Arc<dyn MetricsGroup>> {


#23 adds a derive macro so users don't have to impl this manually.

Frando · 2025-04-28T08:53:24Z

Cargo.toml

@@ -30,13 +30,12 @@ unexpected_cfgs = { level = "warn", check-cfg = ["cfg(iroh_docsrs)"] }
 unused-async = "warn"

 [dependencies]
+iroh-metrics-derive = { path = "./iroh-metrics-derive", version = "0.1.0" }
+itoa = "1"


This is for faster int to string encoding (prometheus_client used it for that purpose, thought it wouldn't hurt here either)

Frando · 2025-04-28T08:54:00Z

src/base.rs

 };

 /// Trait for structs containing metric items.
 pub trait MetricsGroup:
    Any + Iterable + IntoIterable + std::fmt::Debug + 'static + Send + Sync
 {
-    /// Registers all metric items in this metrics group to a [`prometheus_client::registry::Registry`].
-    #[cfg(feature = "metrics")]
-    fn register(&self, registry: &mut prometheus_client::registry::Registry) {


This is now done the other way round: Registry::register(&dyn MetricsGroup)

github-actions · 2025-04-28T08:55:21Z

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-metrics/pr/22/docs/iroh_metrics/

Last updated: 2025-04-28T11:26:29Z

dignifiedquire · 2025-04-28T09:32:09Z

src/encoding.rs

+    }
+    writer.write_str(name)?;
+    Ok(())
+}


well this was very simple to do :)

## Description * Adds a derive macro for `MetricsGroupSet` Based on #22 ## Breaking Changes  ## Notes & open questions  ## Change checklist - [x] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [x] Tests if relevant. - [x] All breaking changes documented.

## Description Depends on n0-computer/net-tools#20 Until now, we were using a superglobal static `iroh_metrics::core::Core` struct to collect metrics into. This allowed us to use macros to track metrics from anywhere in the codebase. However, this also made it impossible to collect metrics *per endpoint*, which is what you want usually as soon as you have more than one endpoint in your app. This PR builds on n0-computer/iroh-metrics#15, n0-computer/iroh-metrics#22, and n0-computer/iroh-metrics#23. It removes the global metrics collection from all crates in the iroh repository. Instead, we now create and pass metrics collector structs to all places where we need to collect metrics. This PR disables the `static_core` feature from iroh-metrics, which means the macros for superglobal metrics collection are not available anymore. This is good, because otherwise we could easily miss metrics not tracked onto the proper metrics collector. This PR also updates iroh-dns-server and iroh-relay to use manual metrics collection. While this means that we have to pass our metrics structs to more places, it also makes metrics collection more visible, and we can now also split the metrics structs further easily if we want to separate concerns more. This PR should not change anything apart from metrics collection. Most places are straightforward conversions from the macros to methods on the metrics collectors. At a few places, logic was changed slightly to move metrics collection a layer up to save a few clones. ## Breaking Changes * All metrics structs (`iroh::metrics::{MagicsockMetrics, PortmapMetrics, NetReportMetrics}`) now implement `MetricsGroup` from the new version `0.34` of `iroh-metrics` and no longer implement traits from `[email protected]`. * Metrics are no longer registered onto the static superglobal `Core`. `iroh` does not use `static_core` feature of `iroh-metrics`. Metrics are now exposed from the subsystems that track them, see e.g. `Endpoint::metrics`. Several methods now take a `Metrics` argument. You can always pass `Default::default` if you don't want to unify metrics tracking with other sections. #### `iroh` * `iroh::metrics::{MagicsockMetrics, NetReportMetrics, PortmapMetrics}` all are now marked `non_exhaustive`, and implement `iroh_metrics::MetricsGroup` from `[email protected]` and no longer implement `iroh_metrics::Metric` from `[email protected]`. They also no longer implement `Clone` (put them into an `Arc` for cloning instead). * `iroh::net_report::Client::new` now takes `iroh::net_report::metrics::Metrics` as forth argument #### `iroh-dns-server` * `iroh_dns_server::server::Server::spawn` now takes `Metrics` as third argument * `iroh_dns_server::ZoneStore::persistent` now takes `Metrics` as third argument * `iroh_dns_server::ZoneStore::in_memory` now takes `Metrics` as third argument * `iroh_dns_server::ZoneStore::new` now takes `Metrics` as third argument * `iroh_dns_server::state::AppState` now has a public `metrics: Metrics` field * `iroh_dns_server::dns::DnsHandler::new` now takes `Metrics` as third argument * function `iroh_dns_server::metrics::init_metrics` is removed #### `iroh-relay` * `iroh_relay::metrics::{StunMetrics, Metrics}` all are now marked `non_exhaustive`, and implement `iroh_metrics::MetricsGroup` from `[email protected]` and no longer implement `iroh_metrics::Metric` from `[email protected]`. They also no longer implement `Clone` (put them into an `Arc` for cloning instead). ## Notes & open questions  ## Change checklist  - [x] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [x] Tests if relevant. - [x] All breaking changes documented. - [x] List all breaking changes in the above "Breaking Changes" section. - [x] Open an issue or PR on any number0 repos that are affected by this breaking change. Give guidance on how the updates should be handled or do the actual updates themselves. - [x] [`iroh-gossip`](https://github.com/n0-computer/iroh-gossip) - n0-computer/iroh-gossip#58 - [x] [`iroh-blobs`](https://github.com/n0-computer/iroh-blobs) - n0-computer/iroh-blobs#85 - [x] [`iroh-docs`](https://github.com/n0-computer/iroh-docs) - n0-computer/iroh-docs#41 --------- Co-authored-by: dignifiedquire <[email protected]>

wip

ab69b10

Frando force-pushed the Frando/direct-atomics branch from 53cf278 to ab69b10 Compare April 28, 2025 08:41

Frando mentioned this pull request Apr 28, 2025

feat: Add derive for MetricsGroupSet #23

Merged

4 tasks

Frando commented Apr 28, 2025

View reviewed changes

Frando added 2 commits April 28, 2025 10:50

chore: fmt

2686513

chore: update sscache github action

9dbea72

Frando commented Apr 28, 2025

View reviewed changes

Frando marked this pull request as ready for review April 28, 2025 09:06

Frando changed the title ~~feat/refactor: Make metrics raw atomics, remove prometheus_client dependency~~ refactor!: Make metrics raw atomics, remove prometheus_client dependency Apr 28, 2025

dignifiedquire reviewed Apr 28, 2025

View reviewed changes

src/encoding.rs

}

writer.write_str(name)?;

Ok(())

}

Copy link

Contributor

dignifiedquire Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well this was very simple to do :)

Arqu reacted with hooray emoji

This was referenced Apr 28, 2025

refactor(portmapper): update to latest iroh-metrics branch n0-computer/net-tools#23

Merged

refactor: update to latest iroh-metrics branch n0-computer/iroh#3278

Merged

n0bot bot added this to iroh Apr 28, 2025

github-project-automation bot moved this to 🏗 In progress in iroh Apr 28, 2025

tests: add serde test, enable serde rc feature

5ece9c3

dignifiedquire approved these changes Apr 29, 2025

View reviewed changes

Arqu approved these changes Apr 30, 2025

View reviewed changes

Frando merged commit 27fb9b5 into main Apr 30, 2025
23 of 24 checks passed

github-project-automation bot moved this from 🏗 In progress to ✅ Done in iroh Apr 30, 2025

dignifiedquire deleted the Frando/direct-atomics branch April 30, 2025 08:13

This was referenced Apr 30, 2025

ci: update sccache-action to 0.0.9 #21

Closed

chore(deps): bump mozilla-actions/sccache-action from 0.0.7 to 0.0.8 in the github-actions group #13

Closed

feat!: metrics refactor n0-computer/iroh#3262

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor!: Make metrics raw atomics, remove `prometheus_client` dependency #22

refactor!: Make metrics raw atomics, remove `prometheus_client` dependency #22

Uh oh!

Frando commented Apr 28, 2025 •

edited

Loading

Uh oh!

Frando Apr 28, 2025

Uh oh!

Frando Apr 28, 2025

Uh oh!

Frando Apr 28, 2025

Uh oh!

github-actions bot commented Apr 28, 2025 •

edited

Loading

Uh oh!

dignifiedquire Apr 28, 2025

Uh oh!

Uh oh!

Uh oh!

refactor!: Make metrics raw atomics, remove prometheus_client dependency #22

refactor!: Make metrics raw atomics, remove prometheus_client dependency #22

Uh oh!

Conversation

Frando commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Breaking Changes

Notes & open questions

Change checklist

Uh oh!

Frando Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Frando Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Frando Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dignifiedquire Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

refactor!: Make metrics raw atomics, remove `prometheus_client` dependency #22

refactor!: Make metrics raw atomics, remove `prometheus_client` dependency #22

Frando commented Apr 28, 2025 •

edited

Loading

github-actions bot commented Apr 28, 2025 •

edited

Loading