Skip to content

feat(metrics/family): 🍬 contains() checks if metrics exist #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mxinden merged 2 commits into from
Jan 23, 2026
Merged

feat(metrics/family): 🍬 contains() checks if metrics exist #245

mxinden merged 2 commits into from
Jan 23, 2026

Conversation

@cratelyn
Copy link
Contributor

@cratelyn cratelyn commented Nov 18, 2024

this commit introduces a small accessor to the Family<S, M, C> metric family type. this new contains() method allows callers to check whether or not a metric with the provided set of labels exists.

if no metric has been created via e.g. get_or_create(), this method will return false.

cratelyn added a commit to cratelyn/prometheus-client that referenced this pull request Nov 18, 2024
@cratelyn
feat(metrics/family): len() returns the number of metrics
27a2e49 
this commit introduces a `len()` method to `Family<S, M, C>`, which
returns the number of series within a metric family.

see also prometheus#245, which allows callers to check if a family `contains()` a
given label set.

Signed-off-by: katelyn martin <me+cratelyn@katelyn.world>
@cratelyn cratelyn mentioned this pull request Nov 18, 2024
Merged
@cratelyn
Copy link
Contributor Author

cratelyn commented Sep 2, 2025

my understanding is that this could be added behind the test-util flag proposed in #283.

mxinden
mxinden reviewed Jan 19, 2026
View reviewed changes
Copy link
Member

@mxinden mxinden left a comment

Choose a reason for hiding this comment

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

Let's move forward here once #242 merged.

cratelyn added a commit to cratelyn/prometheus-client that referenced this pull request Jan 22, 2026
@cratelyn
feat(metrics/family): len() returns the number of metrics
4218100 
this commit introduces a `len()` method to `Family<S, M, C>`, which
returns the number of series within a metric family.

see also prometheus#245, which allows callers to check if a family `contains()` a
given label set.

```shell
$ cargo clippy --all-features --all-targets --tests
   Compiling prometheus-client v0.23.0 (/path/to/prometheus-client)
warning: struct `Family` has a public `len` method, but no `is_empty` method
   --> src/metrics/family.rs:309:5
    |
309 |     pub fn len(&self) -> usize {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#len_without_is_empty
    = note: `#[warn(clippy::len_without_is_empty)]` on by default

warning: `prometheus-client` (lib) generated 1 warning
warning: `prometheus-client` (lib test) generated 1 warning (1 duplicate)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.63s
```

Signed-off-by: katelyn martin <git@katelyn.world>
cratelyn
cratelyn commented Jan 22, 2026
View reviewed changes
@cratelyn
feat(metrics/family): contains() checks if metrics exist
1d32d56 
this commit introduces a small accessor to the `Family<S, M, C>` metric
family type. this new `contains()` method allows callers to check
whether or not a metric with the provided set of labels exists.

if no metric has been created via e.g. `get_or_create()`, this method
will return `false`.

Signed-off-by: katelyn martin <git@katelyn.world>
cratelyn added a commit to cratelyn/prometheus-client that referenced this pull request Jan 22, 2026
@cratelyn
feat(metrics/family): len() returns the number of metrics
22a8b81 
this commit introduces a `len()` method to `Family<S, M, C>`, which
returns the number of series within a metric family.

see also prometheus#245, which allows callers to check if a family `contains()` a
given label set.

```shell
$ cargo clippy --all-features --all-targets --tests
   Compiling prometheus-client v0.23.0 (/path/to/prometheus-client)
warning: struct `Family` has a public `len` method, but no `is_empty` method
   --> src/metrics/family.rs:309:5
    |
309 |     pub fn len(&self) -> usize {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#len_without_is_empty
    = note: `#[warn(clippy::len_without_is_empty)]` on by default

warning: `prometheus-client` (lib) generated 1 warning
warning: `prometheus-client` (lib test) generated 1 warning (1 duplicate)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.63s
```

Signed-off-by: katelyn martin <git@katelyn.world>
cratelyn
cratelyn commented Jan 22, 2026
View reviewed changes
mxinden
mxinden approved these changes Jan 23, 2026
View reviewed changes
@mxinden
Update CHANGELOG.md
d31aa78 
Signed-off-by: Max Inden <mail@max-inden.de>
@mxinden mxinden added this pull request to the merge queue Jan 23, 2026
Merged via the queue into prometheus:master with commit bffe835 Jan 23, 2026
10 checks passed
@cratelyn cratelyn deleted the family-contains branch January 28, 2026 16:19
cratelyn added a commit to cratelyn/prometheus-client that referenced this pull request Jan 28, 2026
@cratelyn
feat(metrics/family): len() returns the number of metrics
a3c065e 
this commit introduces a `len()` method to `Family<S, M, C>`, which
returns the number of series within a metric family.

see also prometheus#245, which allows callers to check if a family `contains()` a
given label set.

```shell
$ cargo clippy --all-features --all-targets --tests
   Compiling prometheus-client v0.23.0 (/path/to/prometheus-client)
warning: struct `Family` has a public `len` method, but no `is_empty` method
   --> src/metrics/family.rs:309:5
    |
309 |     pub fn len(&self) -> usize {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#len_without_is_empty
    = note: `#[warn(clippy::len_without_is_empty)]` on by default

warning: `prometheus-client` (lib) generated 1 warning
warning: `prometheus-client` (lib test) generated 1 warning (1 duplicate)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.63s
```

Signed-off-by: katelyn martin <git@katelyn.world>
github-merge-queue bot pushed a commit that referenced this pull request Jan 29, 2026
@cratelyn
feat(metrics/family): 🍭 len() returns the number of metrics (#246)
3942d06 
feat(metrics/family): `len()` returns the number of metrics

this commit introduces a `len()` method to `Family<S, M, C>`, which
returns the number of series within a metric family.

see also #245, which allows callers to check if a family `contains()` a
given label set.

```shell
$ cargo clippy --all-features --all-targets --tests
   Compiling prometheus-client v0.23.0 (/path/to/prometheus-client)
warning: struct `Family` has a public `len` method, but no `is_empty` method
   --> src/metrics/family.rs:309:5
    |
309 |     pub fn len(&self) -> usize {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#len_without_is_empty
    = note: `#[warn(clippy::len_without_is_empty)]` on by default

warning: `prometheus-client` (lib) generated 1 warning
warning: `prometheus-client` (lib test) generated 1 warning (1 duplicate)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.63s
```

Signed-off-by: katelyn martin <git@katelyn.world>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mxinden mxinden mxinden approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cratelyn @mxinden