Uptime: Wiki | The metric declaration table as JSON.

Overview

Same METRICS const that produces the # HELP / # TYPE lines at scrape time, so a consumer building a dashboard reads names, kinds and help text from the same source the exporter emits from. That is the whole point: a separately-written metrics reference is the classic thing to leave stale.

Answers before a world exists, because the catalog describes what WILL be emitted and does not depend on any world state.

Try the endpoint

Code example

curl -X GET "https://example.com/api/v1/metrics/catalog"

Response example

[  {    "name": "string",    "help": "string",    "kind": "gauge",    "unit": "string"  }]

Response body

200Every metric this exporter declares

application/json

[index: integer]?

One declared metric. Name, help text, and kind live together so they cannot drift apart.