feat(metrics): add Summary implementation #249
Closed
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
This commit introduces the `Summary` metric type for the Rust Prometheus client, addressing the requirements outlined in prometheus#40. - Implements the `Summary` type to represent summary statistics such as sum, count, and quantiles. - The implementation does not include a specific quantile calculation algorithm. Users are expected to provide precomputed quantiles based on their chosen algorithm. - Supports encoding summary metrics following the OpenMetrics standard. - `Summary` provides: - `reset` method to update its internal state with sum, count, and quantiles. - Integration with the `TypedMetric` and `EncodeMetric` traits to support encoding and registration with the Prometheus client. - Documentation and tests have been added to ensure correct usage and behavior. - This implementation is designed to give users flexibility in handling quantile computation. - Future work could explore integrating popular quantile calculation algorithms to offer built-in support while retaining the option for custom implementations. Signed-off-by: zth <[email protected]>
the test suite in this repository has some implicit dependencies upon `protoc` and the Python client library. in order to help newcomers get situated and effectively contributing to this project, a `CONTRIBUTING.md` file is added to help provide some guidance on how to install the protocol buffer compiler, and how to create and activate a virtual environment with the Python library installed. Signed-off-by: katelyn martin <[email protected]>
|
@zhangtianhao why close here? Are you no longer interested in contributing this feature? |
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.
This commit introduces the
Summarymetric type for the Rust Prometheus client, addressing the requirements outlined in #40.Key Highlights:
Summarytype to represent summary statistics such as sum, count, and quantiles.Details:
Summaryprovides:resetmethod to update its internal state with sum, count, and quantiles.TypedMetricandEncodeMetrictraits to support encoding and registration with the Prometheus client.Documentation and tests have been added to ensure correct usage and behavior.
This implementation is designed to give users flexibility in handling quantile computation.
Notes:
Signed-off-by: zth [email protected]