feat(metrics/family): 🍫 add Family::get_or_create_clone()
#244
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cratelyn
force-pushed
the
family-get-or-create-clone
branch
2 times, most recently
from
13dbb03 to
fb14089
Compare
fixes prometheus#231. this introduces a new method to `Family<S, M, C>` to help alleviate the risk of deadlocks when accessing multiple series within a given metrics family. this returns a plain `M`, rather than the `MappedRwLockReadGuard<M>` RAII guard returned by `get_or_create()`. a test case is introduced in this commit to demonstrate that structures accessing multiple series within a single expression will not accidentally create a deadlock. Signed-off-by: katelyn martin <[email protected]>
cratelyn
force-pushed
the
family-get-or-create-clone
branch
from
fb14089 to
708c1ec
Compare
|
i've rebased this commit to address merge conflicts, and added information to the changelog. let me know if there is anything else that needs to be done. i am keen on a release that addresses the deadlocks reported in #231. |
mxinden
reviewed
Feb 3, 2025
| @@ -225,6 +259,10 @@ impl<S: Clone + std::hash::Hash + Eq, M, C: MetricConstructor<M>> Family<S, M, C | |||
| /// // calls. | |||
| /// family.get_or_create(&vec![("method".to_owned(), "GET".to_owned())]).inc(); | |||
| /// ``` | |||
| /// | |||
| /// NB: This method can cause deadlocks if multiple metrics within this family are read at | |||
| /// once. Use [`Family::get_or_create()`] if you would like to avoid this by cloning the | |||
There was a problem hiding this comment.
Suggested change
| /// once. Use [`Family::get_or_create()`] if you would like to avoid this by cloning the | |
| /// once. Use [`Family::get_or_create_clone()`] if you would like to avoid this by cloning the |
| /// | ||
| /// Callers wishing to avoid a clone of the metric `M` can call [`Family::get_or_create()`] to | ||
| /// return a reference to the metric instead. | ||
| pub fn get_or_create_clone(&self, label_set: &S) -> M { |
There was a problem hiding this comment.
Suggested change
| pub fn get_or_create_clone(&self, label_set: &S) -> M { | |
| pub fn get_or_create_owned(&self, label_set: &S) -> M { |
Would this be more intuitive? I am undecided.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #231.
this introduces a new method to
Family<S, M, C>to help alleviate the risk of deadlocks when accessing multiple series within a given metrics family.this returns a plain
M, rather than theMappedRwLockReadGuard<M>RAII guard returned byget_or_create().a test case is introduced in this commit to demonstrate that structures accessing multiple series within a single expression will not accidentally create a deadlock.