allow the metric names to be changed with compile-time env vars #6
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
It is common for applications metrics to have an application-specific prefix. Metrics can be renamed at scrape time of course, but in some environments an application is expected to merely expose metrics on a given port and no other configuration is allowed. This commit allows the metric names to be changed at compile time by setting the following environment variables: - `AXUM_HTTP_REQUESTS_TOTAL` - `AXUM_HTTP_REQUESTS_DURATION_SECONDS` - `AXUM_HTTP_REQUESTS_PENDING` In the absence of these environment variables, the metric names are unchanged. This commit also documents the usage of these envs and suggests setting them in .cargo/config.toml
|
Thanks @dylanwh! |
Ptrskay3
approved these changes
Dec 19, 2022
|
I also updated the docs for the constants, so that someone reading the docs will know they can change them. |
|
Great! I'm planning to release 0.3 this weekend along with other changes - you can use the master branch until then. |
|
Just released 0.3, and includes this change. |
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.
To match local conventions I needed to adjust the metric names and I'm not able to modify the scrape config. Thus, I made this patch which allows these
AXUM_HTTP_*constants to be changed via envs.It is common for applications metrics to have an application-specific prefix. Metrics can be renamed at scrape time of course, but in some environments an application is expected to merely expose metrics on a given port and no other configuration is allowed.
This commit allows the metric names to be changed at compile time by setting the following environment variables:
AXUM_HTTP_REQUESTS_TOTALAXUM_HTTP_REQUESTS_DURATION_SECONDSAXUM_HTTP_REQUESTS_PENDINGIn the absence of these environment variables, the metric names are unchanged.
This commit also documents the usage of these envs and suggests setting them in .cargo/config.toml