-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs: add OTLP bridge tutorial for client_golang users #2034
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.
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
happysnaker
wants to merge
1
commit into
prometheus:main
Choose a base branch
from
happysnaker:docs-otlp-bridge-tutorial
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # client_golang Tutorial: Export Prometheus instrumentation with OpenTelemetry OTLP | ||
|
|
||
| `client_golang` is built around the Prometheus pull model. For most long-running | ||
| services, exposing `/metrics` with `promhttp` is still the recommended setup. | ||
|
|
||
| If you already instrumented your code with `client_golang` but need to send | ||
| metrics into an OpenTelemetry pipeline, you can bridge a Prometheus | ||
| `Gatherer` into the OpenTelemetry SDK and export it with OTLP. | ||
|
|
||
| This is useful for: | ||
|
|
||
| - short-lived batch jobs that may exit before being scraped | ||
| - environments standardized on OTLP and the OpenTelemetry Collector | ||
| - gradual migrations where existing Prometheus instrumentation should stay | ||
| unchanged | ||
|
|
||
| ## Example | ||
|
|
||
| The example below keeps existing Prometheus instrumentation, bridges a custom | ||
| registry into the OpenTelemetry SDK, and exports the resulting metrics with the | ||
| OTLP HTTP exporter. | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
|
|
||
| bridgeprometheus "go.opentelemetry.io/contrib/bridges/prometheus" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp" | ||
| sdkmetric "go.opentelemetry.io/otel/sdk/metric" | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus" | ||
| ) | ||
|
|
||
| func main() { | ||
| ctx := context.Background() | ||
|
|
||
| reg := prometheus.NewRegistry() | ||
| jobsProcessed := prometheus.NewCounter(prometheus.CounterOpts{ | ||
| Name: "jobs_processed_total", | ||
| Help: "Total number of processed jobs.", | ||
| }) | ||
| reg.MustRegister(jobsProcessed) | ||
|
|
||
| exporter, err := otlpmetrichttp.New( | ||
| ctx, | ||
| otlpmetrichttp.WithEndpoint("localhost:4318"), | ||
| otlpmetrichttp.WithInsecure(), | ||
| ) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| bridge := bridgeprometheus.NewMetricProducer( | ||
| bridgeprometheus.WithGatherer(reg), | ||
| ) | ||
|
|
||
| meterProvider := sdkmetric.NewMeterProvider( | ||
| sdkmetric.WithReader( | ||
| sdkmetric.NewPeriodicReader(exporter, sdkmetric.WithProducer(bridge)), | ||
| ), | ||
| ) | ||
| defer func() { | ||
| if err := meterProvider.Shutdown(ctx); err != nil { | ||
| log.Printf("shutdown metric provider: %v", err) | ||
| } | ||
| }() | ||
|
|
||
| jobsProcessed.Inc() | ||
| } | ||
| ``` | ||
|
|
||
| ## Notes | ||
|
|
||
| - If your application uses the default Prometheus registry, you can omit | ||
| `bridgeprometheus.WithGatherer(reg)` and `NewMetricProducer` will read from | ||
| `prometheus.DefaultGatherer`. | ||
| - `Shutdown` flushes pending metric data. For short-lived jobs, make sure you | ||
| shut the provider down before exit. | ||
| - If you also use native OpenTelemetry metrics, attach them to the same | ||
| `MeterProvider` so both pipelines are exported together. | ||
|
|
||
| ## Related documentation | ||
|
|
||
| - Prometheus bridge package: | ||
| <https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/prometheus> | ||
| - OTLP metric HTTP exporter: | ||
| <https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp> | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add example to examples/ instead? Likely with a separate go.mod