Add prometheus endpoint for metrics #740
Merged
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
The existing metrics package used in dkron already supports prometheus, so this just adds in the necessary pieces to hook it up to the API. There is a config value to enable serving this endpoint to allow users the choice with a default of false to keep today's functionality. I know that it was discussed in distribworks#494 that the metrics system was likely going to be updated, but this seems like an easy step in the meantime. The documentation for metrics was updated to align with current configuration keys.
vcastellm
reviewed
Apr 29, 2020
There was a problem hiding this comment.
Thanks @sysadmind! I don't get why don't use prometheus.DefaultRegistry?
|
I changed to using prometheus.DefaultRegistry. I initially thought that the metrics package was already setting up the metrics that come along with the DefaultRegistry, but when I went to compare more closely after your comment, I realized that the DefaultRegistry actually has a lot more metrics and they are more standardized across the prometheus community than those configured by the metrics package so I changed the PR. |
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.
The existing metrics package used in dkron already supports prometheus, so this just adds in the necessary pieces to hook it up to the API. There is a config value to enable serving this endpoint to allow users the choice with a default of false to keep today's functionality. I know that it was discussed in #494 that the metrics system was likely going to be updated, but this seems like an easy step in the meantime.
The documentation for metrics was updated to align with current configuration keys.