Introduce option for behavior of Peep.Plug for paths that don't match the metrics path #19
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 option supports two values: - `halt`: This preserves the current behavior of Peep responding with 404. This option is useful when Peep.Plug is used to serve metrics on its own port, which is an encouraged option by other libraries that export Prometheus metrics. - `continue`: This allows for subsequent Plugs in a router to be executed. This option is useful when Peep.Plug is part of a router for a Phoenix application, or a router that matches other paths after Peep.Plug.
rkallos
changed the title
|
This should be good enough
Encourage what precisely? Use an entire endpoint just for the metrics? |
Exactly right. An example I see often when the metrics scraping agent runs on the same machine as a service; the metrics endpoint listens on a separate port that only listens on localhost. |
|
Hey @rkallos are you intending to release this any time soon? |
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 leads to a confusing behavior when Peep.Plug is used as part of a larger Plug router.
It's worth noting that other Elixir libraries that export Prometheus metrics seem to start a separate HTTP listener on a separate port, supporting only the metrics endpoint. This is something Peep may want to encourage in the future, and the behavior of Peep.Plug before the changes in this PR seem to be a perfect fit for that sort of Plug module.