Skip to content

Add OpenMetrics scrape validator to OpenMetrics compliance readme #77

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.

Sign up for GitHub

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

Open
robskillington wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add OpenMetrics scrape validator to OpenMetrics compliance readme #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion openmetrics/README.md
View file
Open in desktop
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.