Skip to content

README: document the OpenTelemetry OTLP push bridge #1987

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
mvanhorn wants to merge 2 commits into
base: main
Choose a base branch
from
Open

README: document the OpenTelemetry OTLP push bridge #1987

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
128fce6
README: document the OpenTelemetry OTLP push bridge
mvanhorn Apr 22, 2026
8e587a7
Merge branch 'main' into osc/1495-doc-otel-bridge
kakkoyun Apr 23, 2026
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,25 @@ The
[`examples` directory](https://github.com/prometheus/client_golang/tree/main/examples)
contains simple examples of instrumented code.

## Pushing metrics via OpenTelemetry OTLP

Applications instrumented with `client_golang` can also export their
metrics via the OpenTelemetry OTLP push protocol without re-instrumenting
against a different metric API. The
[`go.opentelemetry.io/contrib/bridges/prometheus`](https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/prometheus)
module wraps a `prometheus.Registry` as an OpenTelemetry metric producer,
which an OTLP exporter (HTTP or gRPC) can then push to an OTel collector
or OTLP-accepting backend. This is useful for batch jobs or environments
where pull-based `/metrics` scraping is not an option.

Pull-based collection via `promhttp` remains the recommended default for
reliability, central discovery, and failover. The bridge is intended as
an additional option, not a replacement.

See the [bridge's Go reference](https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/prometheus)
and [source](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/bridges/prometheus)
for setup details.

## Client for the Prometheus HTTP API

[![Go Reference](https://pkg.go.dev/badge/github.com/prometheus/client_golang/api.svg)](https://pkg.go.dev/github.com/prometheus/client_golang/api)
Expand Down
Loading