Skip to content
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.

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

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/metrics/family.rs
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,26 @@ impl<S: Clone + std::hash::Hash + Eq, M, C: MetricConstructor<M>> Family<S, M, C
self.metrics.write().clear()
}

/// Returns `true` if the given label set exists within the metric family.
///
/// ```
/// # use prometheus_client::metrics::counter::{Atomic, Counter};
/// # use prometheus_client::metrics::family::Family;
/// #
/// let family = Family::<Vec<(String, String)>, Counter>::default();
/// let get = vec![("method".to_owned(), "GET".to_owned())];
/// let post = vec![("method".to_owned(), "POST".to_owned())];
///
/// // Create the metric with labels `method="GET"`.
/// family.get_or_create(&get).inc();
///
/// assert!(family.contains(&get), "a `method=\"GET\"`-labeled metric exists");
/// assert!(!family.contains(&post), "a `method=\"POST\"`-labeled metric does NOT exist");
/// ```
pub fn contains(&self, label_set: &S) -> bool {
self.metrics.read().get(label_set).is_some()
}

pub(crate) fn read(&self) -> RwLockReadGuard<HashMap<S, M>> {
self.metrics.read()
}
Expand Down