Prometheus Conformance

Prometheus is the standard for metric monitoring and observability in the cloud native ecosystem and beyond. To ensure interoperability, to protect users from suprises, and to enable more parallel innovation, the Prometheus project is certifying individual interface compliance and Prometheus compatibility under the Prometheus conformance program.

This repository is the official reference. Working code, test results, etc. can be found in the respective Prometheus repositories.

Updates to the Conformance Program

This conformance program will evolve over time as we find time to document, specify, and test current behavior and as the functionality of Prometheus itself evolves. If you want to contribute ideas to improve, extend, or update the conformance process, you are strongly encouraged to propose your desired changes by creating issues in the prometheus/compliance repository.

Applying for Conformance Certification

All vendors are invited to submit conformance testing results for review by the Prometheus project and subsequent certification by the CNCF, which formally certifies conformant implementations.

Benefits of Certification

In addition to providing confidence to end users of your Prometheus compatibility, offerings that certify are able to:

Display interface compliance in their their marketing materials
Display the "Prometheus Compatible" word and logo marks on their marketing materials

Certification

The tests can be found in prometheus/compliance.

Certification Types

There are two types of conformance certification:

Interface Compliance

Interfaces carry their own test suite. Compliance is calculated as a percentage based on the tests and checklists in the relevant directories. When 100% compliance has been reached, a timestamped mark "foo YYYY-MM compliant", e.g. "PromQL 2021-04 compliant" will be awarded.

Currently, there are three interface compliance tests:

Prometheus Compatibility

All relevant interface compliance scores are multiplied into a Prometheus compatibility score. When 100% compatibility has been reached, a versioned mark "Prometheus X.Y Compatible" will be awarded.

Recertification

Certification of conformance is valid for 12 weeks, or two minor Prometheus releases, whichever is longer. This should allow all projects and vendors enough time to update while being current and useful for users.

Neither compliance nor compatibility scores can carry across major versions of interfaces or Prometheus.

isabella232 / prometheus-conformance Goto Github PK