Add drain method to AtomicHistogram #113
Merged
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.
Problem
I would like to use
AtomicHistogram
in a metrics-collection/publishing context. In order to avoid additional synchronization primitives, I need the ability to simultaneously produce a new histogram for analysis while draining all stored values from the histogram.Some of the docs were also out of date, and I fixed those as well.
Solution
Add a
drain
method that usesAtomicU64::swap
to reset buckets to zero as they are consumed. This method is only available on platforms where 64 bit atomics are available and is cfg-gated accordingly.