Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusion over PromEx.Plug, because docs maybe contradict in their explaining about it? #215

Open
gaggle opened this issue Sep 26, 2023 · 0 comments
Assignees

Comments

@gaggle
Copy link

gaggle commented Sep 26, 2023

This document: https://hexdocs.pm/prom_ex/running-multiple-agents.html#endpoints states: "You can configure each agent to scrape the same set of metrics", and then points to registering plug PromEx.Plug in endpoint.ex. But this leads me to think plug PromEx.Plug is about scraping, when I think it's actually about making the metrics endpoint available. Or am I wrong?

Perhaps this is a subtle point, but my confusion is I'm not sure which part of PromEx does the actual collecting and which part makes the endpoint available, and this document adds to the confusion because https://hexdocs.pm/prom_ex/PromEx.Plug.html states "Use this plug in your Endpoint file to expose your metrics", and so the two documents seem to be conflicting in their language.

Describe the solution you would like to see
I think maybe multiple-agents page could specify using plug PromEx.Plug as an example of exposing the metrics via different paths?

Additional context
I am not exposing metrics via /metrics, but instead using the metrics-server to expose metrics on a different port. For security reasons.

Anyway, I think this is probably a small consideration, feel free to just close this issue if it's not relevant. And thanks for making this great library available!

@gaggle gaggle changed the title [FEATURE] Confusion over PromEx.Plug, because docs maybe contradict in their explaining about it? Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants