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

Exporter endpoints should use more standard location. #71

Open
ArKam opened this issue Jun 18, 2024 · 0 comments
Open

Exporter endpoints should use more standard location. #71

ArKam opened this issue Jun 18, 2024 · 0 comments

Comments

@ArKam
Copy link

ArKam commented Jun 18, 2024

Hi team, the exporter currently leverage three different endpoints:

  • /
  • /bmc
  • /metrics

the root (/) endpoint is used as a simple helper webpage.
the /bmc endpoint is used as the scrape endpoint for prometheus server.
the /metrics endpoint is used as a global statistic endpoint.

Within prometheus world, you can reassign the scrape endpoint, BUT exporter authors tends to all use the same logical naming convention as it allow easier and straight forward automation process and exporter integration.

I'm currently working on integrating this exporter among openstack kolla/kolla-ansible project.
The various exporter we integrate usually tend to rather use the following pattern:

  • /graph
  • /metrics

the /graph endpoint is used as a simple helper webpage (as for prometheus server WebUI used to request its dataset).
the /metrics endpoint is used as the scrape endpoint for prometheus server to retrieve metrics data AND exporter statistics (promhttp_metric_handler_errors_total for example).

If you really want to split the exporter statistics from the /metrics endpoint, a better suited endpoint name could be /stats

What do you think guys?

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

1 participant