Skip to content

Commit

Permalink
Add OpenMetrics scrape validator to OpenMetrics compliance readme
Browse files Browse the repository at this point in the history
Noticed the OpenMetrics scrape validator tool was not directly linked from the readme, adding this for others to more easily discover.
  • Loading branch information
robskillington authored Mar 3, 2022
1 parent b7445eb commit 745ba8d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion openmetrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

While [OpenMetrics](https://openmetrics.io/) is an independent CNCF project, Prometheus designated it as the [official specification](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md) for Prometheus exposition. OpenMetrics is, and will remain, closely aligned to Prometheus.

The test suite can be found on [GitHub](https://github.com/OpenObservability/OpenMetrics/tree/main/src/cmd/openmetricstest). Depending on your implementation, the [individual test cases](https://github.com/OpenObservability/OpenMetrics/tree/main/tests/testdata/parsers) might be of direct interest.
The test suite can be found on [GitHub](https://github.com/OpenObservability/OpenMetrics/tree/main/src/cmd/openmetricstest).

Depending on your implementation, the following might be of interest:
- [Scrape validator tool](https://github.com/OpenObservability/OpenMetrics/tree/main/src/cmd/scrapevalidator) to scrape an OpenMetrics HTTP endpoint and validate the exposition against the OpenMetrics specification.
- [Individual test cases](https://github.com/OpenObservability/OpenMetrics/tree/main/tests/testdata/parsers) to understand valid and invalid OpenMetric expositions.

Prometheus considers OpenMetrics compliance part of Prometheus compliance and compatibility.

0 comments on commit 745ba8d

Please sign in to comment.