search

gebn / bmc_exporter

Exposes Baseboard Management Controller data in Prometheus format.
GNU Lesser General Public License v3.0
45 stars 3 forks source link

Exporter endpoints should use more standard location. #71

Open ArKam opened 3 months ago

ArKam commented 3 months ago

Hi team, the exporter currently leverage three different endpoints:

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:

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?