feat: add pigeon metrics to telemetry endpoint #1287
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
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.
Related Github tickets
Background
This PR adds pigeon metrics to the telemetry endpoint, where they can be consumed in either JSON or prometheus format.
To get the metrics, we need to enable telemetry on app.toml -
telemetry.enabled = true. If we want to enable the prometheus format, we need to enable prometheus sink as well, by setting prometheus retention to non-zero, e.g.telemetry.prometheus-retention-time = 60to retain metrics for a minute.Metrics will be available on the API, in the
/metricsendpoint, e.g.http://localhost:1317/metrics?format=prometheusPigeon metrics keys are prefixed with
pigeon_.Testing completed
Breaking changes