remove macros, retaining only `register_` and `describe_` macros #394

hlbarber · 2023-10-01T18:00:17Z

Motivation

Simplification of the existing macro API

Changes

Remove increment_counter, absolute_counter, increment_gauge, decrement_gauge, gauge, histogram.
Rename register_counter, register_gauge, and record_histogram to counter, gauge, and histogram respectively.
Update documentation.

LukeMathWalker · 2023-10-07T09:50:52Z

What prevents the describe_* macro family from being converted into a set of methods on the respective metric types?
Having a single macro per metric type would be quite interesting—it would entirely remove ambiguity when it comes to "what macro do I need".

hlbarber · 2023-10-07T22:44:12Z

What prevents the describe_* macro family from being converted into a set of methods on the respective metric types?

Yeah removing the family of describe_* macros and adding them as just an extra methods on the handles would be super slick.

The obstruction I see here is that Recorder::describe_* takes a KeyName (example) whereas Recorder::register_*takes Key (example), meaning that register_* requires labels to be specified whereas describe_* doesn't. Given that the current counter! API accepts label arguments it might be confusing that counter!("name", a => b).describe(...) disregards a => b.

What you could imagine is moving the label arguments from counter! and putting them into the increment method - counter!("name").increment(3, labels) or maybe counter!("name").labels(labels).increment(3). This would mean that we forgo some of the performance conscious "specialization" taken by the macro - would have to benchmark to check for regressions.

tobz · 2023-10-09T14:36:00Z

I have Thoughts (tm) about all of this, and it's probably worth a new issue to avoid polluting this PR.

tobz

Overall all, this looks good to me. 👍🏻

Left one super small nit.

metrics/examples/basic.rs

tobz · 2023-10-09T14:45:18Z

Just gonna merge since the feature checks are known to go boom on the free GHA runners... something I need to eventually take care of.

* fix prometheus metric name and label key sanitizer (metrics-rs#296) Co-authored-by: Toby Lawrence <tobz@users.noreply.github.com> * metrics-util: add ability to collect metrics on a per-thread basis via DebuggingRecorder (metrics-rs#299) Signed-off-by: Toby Lawrence <toby@nuclearfurnace.com> * (cargo-release) version 0.12.1 * Improve handling of the global recorder instance (metrics-rs#302) This gets rid of the dangerous `static mut`, adds more comments about the code, relaxes the orderings and documents the unsoundness of the `clear` function, in addition to marking it unsafe. It implements a small once_cell-like abstraction. Co-authored-by: Toby Lawrence <toby@nuclearfurnace.com> * Fix `metrics::Cow` provenance issue (metrics-rs#303) * Quantile Remapping Fix (metrics-rs#304) * update changelogs prior to release * (cargo-release) version 0.19.0 * (cargo-release) version 0.13.0 * (cargo-release) version 0.11.0 * (cargo-release) version 0.10.0 * Update CHANGELOG.md * Update README.md * Update ci.yml * Update ci.yml * Add RollingSummary to prevent summary saturation (metrics-rs#306) * Update quanta requirement from 0.9.3 to 0.10.0 (metrics-rs#301) Updates the requirements on [quanta](https://github.com/metrics-rs/quanta) to permit the latest version. - [Release notes](https://github.com/metrics-rs/quanta/releases) - [Changelog](https://github.com/metrics-rs/quanta/blob/main/CHANGELOG.md) - [Commits](metrics-rs/quanta@v0.9.3...v0.10.0) --- updated-dependencies: - dependency-name: quanta dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Document CI enforced msrv in readme and rust-version fields (metrics-rs#311) * Change description to be SharedString (metrics-rs#312) * Update hashbrown requirement from 0.11 to 0.12 (metrics-rs#266) Updates the requirements on [hashbrown](https://github.com/rust-lang/hashbrown) to permit the latest version. - [Release notes](https://github.com/rust-lang/hashbrown/releases) - [Changelog](https://github.com/rust-lang/hashbrown/blob/master/CHANGELOG.md) - [Commits](rust-lang/hashbrown@v0.11.0...v0.12.0) --- updated-dependencies: - dependency-name: hashbrown dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Toby Lawrence <tobz@users.noreply.github.com> * Shims remaining AtomicU64 usage (metrics-rs#313) * Update parking_lot requirement from 0.11 to 0.12 (metrics-rs#268) Updates the requirements on [parking_lot](https://github.com/Amanieu/parking_lot) to permit the latest version. - [Release notes](https://github.com/Amanieu/parking_lot/releases) - [Changelog](https://github.com/Amanieu/parking_lot/blob/master/CHANGELOG.md) - [Commits](Amanieu/parking_lot@0.11.0...0.12.0) --- updated-dependencies: - dependency-name: parking_lot dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Toby Lawrence <tobz@users.noreply.github.com> * update changelogs * (cargo-release) version 0.13.1 * add std atomics handle support back + changelogs * (cargo-release) version 0.20.0 * (cargo-release) version 0.14.0 * (cargo-release) version 0.11.0 * changelog * (cargo-release) version 0.12.0 * (cargo-release) version 0.7.0 * update changelog * (cargo-release) version 0.6.0 * update changelog * (cargo-release) version 0.20.1 * Remove incorrect return info (metrics-rs#316) * Add a `KeyName` argument to `LabelFilter::should_include_label` (metrics-rs#342) * rewind * (cargo-release) version 0.13.0 * Use std sync primitives instead of parking_lot. (metrics-rs#344) * Use std::sync::Mutex instead of parking_lot::Mutex. * Bump MSRV to 1.60.0 for CI. Co-authored-by: Toby Lawrence <tobz@users.noreply.github.com> * clean up github CI workflow + rust-toolchain.toml to match quanta * update portable-atomic to 1.0 * bump to prost 0.11 + fix spelling issue in metrics-tracing-context * bump MSRV to 1.61 + update hashbrown/ahash deps * update termion/ordered-float and pin predicates-* to avoid stupid 1.64 MSRV * update syn * update quanta + clean up semver notation in cargo.toml * cleanup README wording for MSRV policy * Add white background to splash image (metrics-rs#348) * Install protoc in CI. * fix spelling error in CI workflow * Update ci.yml * no need to run CI against macOS/Windows specifically * Bring the metrics-observer protobufs up to date (metrics-rs#345) * Use global paths for macros (metrics-rs#358) * fix changes to fully qualified metrics crate ref change in macros * update changelog * update tui to 0.19 * bump numpy dep * impl std::error::Error for metrics_exporter_tcp::Error * changelog * tweak test to avoid unused code * rework 32 vs 64-bit arch atomics support + a lot of import consolidation/cleanup * const-ify some stuff + rewrite some comments for the global recorder init code * clean up clippy lints * bump MSRV to 1.61.0 * (cargo-release) version 0.7.0 * (cargo-release) version 0.21.0 * (cargo-release) version 0.15.0 * (cargo-release) version 0.14.0 * (cargo-release) version 0.8.0 * (cargo-release) version 0.12.0 * allow publishing * (cargo-release) version 0.2.0 * make it publishable pt 2 * push-gateway support authentication (metrics-rs#366) * update changelog + fix failing feature check test * (cargo-release) version 0.12.1 * feat(util): new helper type for recovering recorder after installing it (metrics-rs#362) * Update aho-corasick to 1.0. * Impl From<std::borrow::Cow> for KeyName (metrics-rs#378) * changelog * Add `Borrow` impl to `KeyName` (metrics-rs#381) * bump deps + clippy stuff * changelog * pin hashbrown to avoid MSRV bump * (cargo-release) version 0.15.1 * (cargo-release) version 0.21.1 * Add metadata to metrics (metrics-rs#380) * add https support in Prometheus gateway (metrics-rs#392) * migrate from procedural to declarative macros (metrics-rs#386) * Make `Unit` methods return `&'static str` where possible (metrics-rs#393) * simplify macros (metrics-rs#394) * Add support for `Arc<T>` to `metrics::Cow<'a, T>`. (metrics-rs#402) * Add support for `tracing::Span::record`ed fields in `metrics-tracing-context` (metrics-rs#408) * fix(prom): `RollingSummary` overflow panic (metrics-rs#423) * update CHANGELOG * (cargo-release) version 0.12.2 * Remove unneeded unsafe from test (metrics-rs#427) * Fix feature check in CI (metrics-rs#428) * update changelogs/release notes * fix unsafe/incorrect crossbeam-epoch usage in Block<T> * Add a clippy CI check (metrics-rs#416) (metrics-rs#417) * Try other resolved addresses if the first one fails (metrics-rs#429) * update changelog * Update quanta requirement from 0.11 to 0.12 (metrics-rs#396) Updates the requirements on [quanta](https://github.com/metrics-rs/quanta) to permit the latest version. - [Changelog](https://github.com/metrics-rs/quanta/blob/v0.12.0/CHANGELOG.md) - [Commits](metrics-rs/quanta@v0.11.0...v0.12.0) --- updated-dependencies: - dependency-name: quanta dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Toby Lawrence <tobz@users.noreply.github.com> * Update ordered-float requirement from 3.4 to 4.2 (metrics-rs#421) Updates the requirements on [ordered-float](https://github.com/reem/rust-ordered-float) to permit the latest version. - [Release notes](https://github.com/reem/rust-ordered-float/releases) - [Commits](reem/rust-ordered-float@v3.4.0...v4.2.0) --- updated-dependencies: - dependency-name: ordered-float dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix quantile api * missing clear * reintroduce old way to avoid big refactor --------- Signed-off-by: Toby Lawrence <toby@nuclearfurnace.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Shaoyuan CHEN <chensy20@mails.tsinghua.edu.cn> Co-authored-by: Toby Lawrence <tobz@users.noreply.github.com> Co-authored-by: Toby Lawrence <toby@nuclearfurnace.com> Co-authored-by: nils <48135649+Nilstrieb@users.noreply.github.com> Co-authored-by: Dan Wilbanks <78116928+dfwilbanks395@users.noreply.github.com> Co-authored-by: Daniel Nelson <daniel@wavesofdawn.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Lucas Kent <rubickent@gmail.com> Co-authored-by: Fredrik Enestad <fredrik@enestad.com> Co-authored-by: Christopher Hunt <huntchr@gmail.com> Co-authored-by: zohnannor <35764628+zohnannor@users.noreply.github.com> Co-authored-by: Sinotov Aleksandr <bratsinot@gmail.com> Co-authored-by: Jacob Kiesel <kieseljake@live.com> Co-authored-by: C J Silverio <ceejceej@gmail.com> Co-authored-by: CinchBlue <aytasato@gmail.com> Co-authored-by: JasonLi <lijingxuan92@126.com> Co-authored-by: Mostafa Elhemali <mostafa.elhemaly@gmail.com> Co-authored-by: Harry Barber <106155934+hlbarber@users.noreply.github.com> Co-authored-by: Qingwen Zhao <864593343@qq.com> Co-authored-by: david-perez <d@vidp.dev> Co-authored-by: Lucio Franco <luciofranco14@gmail.com> Co-authored-by: Nicolas Stinus <nicolas.stinus@gmail.com> Co-authored-by: Valeriy V. Vorotyntsev <valery.vv@gmail.com>

metrics-rs/metrics@metrics-v0.21.1...metrics-v0.22.0 There are some breaking changes: - metrics-rs/metrics#414 Added a generic recorder to `SetRecorderError` and removed `set_boxed_recorder` - metrics-rs/metrics#380 Added metadata to the metrics - metrics-rs/metrics#394 Reworked the macros

Also bumps metrics-exporter-prometheus. The biggest change from 0.21 -> 0.22 is in this PR metrics-rs/metrics#394

* Update metrics crate Also bumps metrics-exporter-prometheus. The biggest change from 0.21 -> 0.22 is in this PR metrics-rs/metrics#394 * allow for versions greater than 0.22 this may change if the api to metrics changes _again_ before a major version.

* Add client_requests timing module to metrics - Add a timing span to anything that can be instrumented and returns a Result. Example: ```ignore let client = GatewayClient::new(channel); client.info(req) .with_timing("iot_fetch_info") .await?; ``` This will result in a prometheus metric >> client_request_duration_seconds{name = "iot_fetch_info", quantile="xxx"} - Install the `ApiTimingLayer`. Adding `.with_span_events(FmtSpan::CLOSE)` to a regular format layer will print the timing spans to stdout as well. Example: ```ignore tracing_subscriber::registry() .with(tracing_subscriber::fmt::layer().with_span_events(FmtSpan::CLOSE)) .with(metrics::client_requests::client_request_timing_layer("histogram_name")) .init(); ``` - Remove unused `install_metrics` function, replace with nested `install` function that `start_metrics` delegates to. This allows us to start metrics in tests without needing to make a `Settings` struct. * Update metrics (#805) * Update metrics crate Also bumps metrics-exporter-prometheus. The biggest change from 0.21 -> 0.22 is in this PR metrics-rs/metrics#394 * allow for versions greater than 0.22 this may change if the api to metrics changes _again_ before a major version. * make string values consts Makes the values hide a little bit less in the code

kornelski · 2024-05-28T10:48:41Z

This change wasn't mentioned in the changelog.

tobz · 2024-05-28T11:03:22Z

Ah yeah, it does look like I forgot to add a link to RELEASES.md in the change log for this specific change.

Easy enough to backport. Thanks for reporting. 👍

hlbarber changed the title ~~simplify macros~~ remove macros, retaining only register_* and describe_* macros Oct 1, 2023

hlbarber force-pushed the harryb/simplify-macro-api branch 2 times, most recently from db5d79b to 3ae58be Compare October 4, 2023 08:02

simplify macros

054016f

hlbarber force-pushed the harryb/simplify-macro-api branch from 3ae58be to 054016f Compare October 4, 2023 08:03

hlbarber marked this pull request as ready for review October 7, 2023 22:44

tobz approved these changes Oct 9, 2023

View reviewed changes

metrics/examples/basic.rs Outdated Show resolved Hide resolved

Update metrics/examples/basic.rs

ec5b481

tobz merged commit 3fca508 into metrics-rs:main Oct 9, 2023
7 of 10 checks passed

hlbarber deleted the harryb/simplify-macro-api branch October 11, 2023 15:35

hlbarber mentioned this pull request Oct 21, 2023

Evaluate whether or not counter-related macros can be renamed/simplified. #369

Closed

dezyh mentioned this pull request Nov 27, 2023

prometheus exporter: idle metrics not re-exported when becoming active again #372

Open

ijc mentioned this pull request Jan 8, 2024

Bump to metrics 0.22 github/metrics-exporter-statsd#44

Merged

mnpw pushed a commit to mnpw/metrics that referenced this pull request Mar 8, 2024

simplify macros (metrics-rs#394)

b0994bc

michaeldjeffrey added a commit to helium/oracles that referenced this pull request May 3, 2024

Update metrics crate

bab73b8

Also bumps metrics-exporter-prometheus. The biggest change from 0.21 -> 0.22 is in this PR metrics-rs/metrics#394

michaeldjeffrey mentioned this pull request May 3, 2024

Update metrics helium/oracles#805

Merged

TennyZhuang mentioned this pull request Jul 1, 2024

chore(deps): bump metrics from 0.20.1 to 0.23.0 in /core apache/opendal#4843

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

remove macros, retaining only `register_` and `describe_` macros #394

remove macros, retaining only `register_` and `describe_` macros #394

hlbarber commented Oct 1, 2023 •

edited

Loading

LukeMathWalker commented Oct 7, 2023

hlbarber commented Oct 7, 2023 •

edited

Loading

tobz commented Oct 9, 2023

tobz left a comment

tobz commented Oct 9, 2023

kornelski commented May 28, 2024

tobz commented May 28, 2024

remove macros, retaining only register_* and describe_* macros #394

remove macros, retaining only register_* and describe_* macros #394

Conversation

hlbarber commented Oct 1, 2023 • edited Loading

Motivation

Changes

LukeMathWalker commented Oct 7, 2023

hlbarber commented Oct 7, 2023 • edited Loading

tobz commented Oct 9, 2023

tobz left a comment

Choose a reason for hiding this comment

tobz commented Oct 9, 2023

kornelski commented May 28, 2024

tobz commented May 28, 2024

remove macros, retaining only `register_` and `describe_` macros #394

remove macros, retaining only `register_` and `describe_` macros #394

hlbarber commented Oct 1, 2023 •

edited

Loading

hlbarber commented Oct 7, 2023 •

edited

Loading