From 745ba8d12b1476e4e5b8dd8827779ce03892599c Mon Sep 17 00:00:00 2001 From: Rob Skillington Date: Thu, 3 Mar 2022 14:10:02 -0500 Subject: [PATCH] Add OpenMetrics scrape validator to OpenMetrics compliance readme Noticed the OpenMetrics scrape validator tool was not directly linked from the readme, adding this for others to more easily discover. --- openmetrics/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/openmetrics/README.md b/openmetrics/README.md index fec00f15..bad6b475 100644 --- a/openmetrics/README.md +++ b/openmetrics/README.md @@ -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.