Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Initial commit of the Prometheus/OpenTelemetry compatibility spec #25

Merged
merged 5 commits into from
Mar 20, 2021

Conversation

rakyll
Copy link
Contributor

@rakyll rakyll commented Mar 9, 2021

This is an early draft that outlines the goals and expectations
from OpenTelemetry in order to provide Prometheus support. The
work is in the early stages, behavioral expectations from the
collector and the libraries might change or be expanded in the
future. In the long term, we will graduate this doc to the
OpenTelemetry compatibility specs under the opentelemetry-specification
repo.

This is an early draft that outlines the goals and expectations
from OpenTelemetry in order to provide Prometheus support. The
work is in the early stages, behavioral expectations from the
collector and the libraries might change or be expanded in the
future. In the long term, we will graduate this doc to the
OpenTelemetry compatibility specs under the opentelemetry-specification
repo.
@rakyll rakyll requested review from bogdandrutu and jmacd March 9, 2021 03:16
specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@rakyll rakyll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed some of the feedback, will send another revision for the open items.

specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Show resolved Hide resolved
specification.md Show resolved Hide resolved
Add more details and future work.
Copy link
Contributor Author

@rakyll rakyll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed a new version that removes the vague sentences and parts calling out for the lack of support/incompatibility though there is a reasonable path. The language was unnecessarily strong in a few sections and I removed them as well. The behavior expected from the collector and client libraries are categorized under the "implementation requirements" now. I think there is a challenge of trying to communicate these requirements in the context of describing compatibility/support.

@jmacd Regarding to your final question about "custom collectors", it is aligning what's proposed for the client libraries based on your code. I haven't found a clear definition of a custom collector in the Prometheus docs, and hence avoided to use it here.

specification.md Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Outdated Show resolved Hide resolved
specification.md Show resolved Hide resolved
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants