search

open-telemetry / prometheus-interoperability-spec

Workgroup for building Prometheus-OTLP interoperability for the OTEL Collector and Prometheus related discussions.
Apache License 2.0
41 stars 6 forks source link

Which prometheus "internal" metrics are required for conformance? #52

Closed dashpole closed 3 years ago

dashpole commented 3 years ago

Currently, conformance tests require the 'up' metric be present. However, there are other internal metrics, such as scrape_duration_seconds, scrape_samples_post_metric_relabeling, scrape_samples_scraped, and scrape_series_added that a prometheus server would also produce that are designed to make debugging prometheus endpoints easier.

I asked this question at the wg today, and we weren't sure which would be required by conformance. There is a separate question of which are useful, but we should probably start with ones that are required.

@RichiH agreed to raise this with question with prometheus folks.

alolita commented 3 years ago

PR #3116 addresses all these metrics.

rakyll commented 3 years ago

Is this an issue to be better filed at https://github.com/prometheus/compliance/ for visibility?

dashpole commented 3 years ago

We decided to add all of the metrics instead of just limiting to "up", so we should be all set either way.

RichiH commented 3 years ago

That took some time... For tracking: https://docs.google.com/document/d/11LC3wJcVk00l8w5P3oLQ-m3Y37iom6INAMEu2ZAGIIE/edit#heading=h.lzyjvpwsbi8m

CONSENSUS: The scrape* metrics we currently have are well-defined. We intend to reserve the scrape prefix with the next major version. scrape_ metrics are recommended, but not required. If they are present, they must be tied to a specific target and can not be relabeled or otherwise detached from said target. If present, their value must not be changed.