README: document the OpenTelemetry OTLP push bridge#1987
Open
mvanhorn wants to merge 2 commits intoprometheus:mainfrom
Open
README: document the OpenTelemetry OTLP push bridge#1987mvanhorn wants to merge 2 commits intoprometheus:mainfrom
mvanhorn wants to merge 2 commits intoprometheus:mainfrom
Conversation
Adds a short section pointing users at `go.opentelemetry.io/contrib/bridges/prometheus`, which wraps a `prometheus.Registry` so client_golang-instrumented applications can push metrics via OTLP without re-instrumenting against a different metric API. Keeps the upstream recommendation that pull-based `promhttp` is still the default; the bridge is positioned as an additional option for batch jobs and push-only environments. Closes prometheus#1495. Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
mvanhorn
force-pushed
the
osc/1495-doc-otel-bridge
branch
from
4a1b916 to
128fce6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1495.
The OTel contrib bridge at
go.opentelemetry.io/contrib/bridges/prometheushas been shipped for a while, but there's no mention of it inclient_golang's README, so users who want OTLP push from an app already instrumented withprometheus.Registrydon't know it exists and end up double-instrumenting or running the OTel collector's Prometheus receiver.This adds a short "Pushing metrics via OpenTelemetry OTLP" section to the README after "Instrumenting applications". It:
pkg.go.devand theopentelemetry-go-contribsource),promhttpis still the default and the bridge is an additional option, not a replacement -- per the wording in the issue body.No code changes; doc-only.
Notes
docs/— a contributor mentioned planning a fuller guide there and that's orthogonal to the "link exists from the README" gap this PR closes. If the longer guide lands, this short section can point to it with a single edit.