-
Notifications
You must be signed in to change notification settings - Fork 771
Fix broken link in Prometheus exporter README. Fixes #4399 #4485
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
Merged
xrmx
merged 12 commits into
open-telemetry:main
from
yrsuthari:fix-prometheus-exporter-link
Jul 22, 2025
Merged
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
ba0885b
Fix broken link in Prometheus exporter README and add missing documen…
yrsuthari 3143d11
Merge branch 'main' into fix-prometheus-exporter-link
emdneto cae1d02
Update docs/exporter/prometheus/prometheus.rst
yrsuthari 623ef54
Apply suggestions from code review
xrmx 6941c15
Merge branch 'main' into fix-prometheus-exporter-link
xrmx 38ebaa6
Update CHANGELOG.md
xrmx fb44405
Update CHANGELOG.md
xrmx 82d58ab
Update docs/exporter/prometheus/prometheus.rst
xrmx e2dba83
Merge branch 'main' into fix-prometheus-exporter-link
xrmx 1298229
Update docs-requirements.txt
xrmx 6864fb3
Merge branch 'main' into fix-prometheus-exporter-link
xrmx 5d64bcb
Merge branch 'main' into fix-prometheus-exporter-link
xrmx 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,54 @@ | ||
| OpenTelemetry Prometheus Exporter | ||
| ================================= | ||
|
|
||
| .. automodule:: opentelemetry.exporter.prometheus | ||
| :members: | ||
| :undoc-members: | ||
| :show-inheritance: | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| The OpenTelemetry Prometheus Exporter package is available on PyPI:: | ||
|
|
||
| pip install opentelemetry-exporter-prometheus | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| The Prometheus exporter starts an HTTP server that collects metrics and serializes them to | ||
| Prometheus text format on request:: | ||
|
|
||
| from prometheus_client import start_http_server | ||
|
|
||
| from opentelemetry import metrics | ||
| from opentelemetry.exporter.prometheus import PrometheusMetricReader | ||
| from opentelemetry.sdk.metrics import MeterProvider | ||
| from opentelemetry.sdk.resources import SERVICE_NAME, Resource | ||
|
|
||
| # Service name is required for most backends | ||
| resource = Resource(attributes={ | ||
| SERVICE_NAME: "your-service-name" | ||
| }) | ||
|
|
||
| # Start Prometheus client | ||
| start_http_server(port=9464, addr="localhost") | ||
| # Initialize PrometheusMetricReader which pulls metrics from the SDK | ||
| # on-demand to respond to scrape requests | ||
| reader = PrometheusMetricReader() | ||
| provider = MeterProvider(resource=resource, metric_readers=[reader]) | ||
| metrics.set_meter_provider(provider) | ||
|
|
||
| Configuration | ||
| ------------ | ||
yrsuthari marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
xrmx marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The following environment variables are supported: | ||
|
|
||
| * ``OTEL_EXPORTER_PROMETHEUS_HOST`` (default: "localhost"): The host to bind to | ||
| * ``OTEL_EXPORTER_PROMETHEUS_PORT`` (default: 9464): The port to bind to | ||
|
|
||
| References | ||
| ---------- | ||
|
|
||
| * `Prometheus <https://prometheus.io/>`_ | ||
| * `OpenTelemetry Project <https://opentelemetry.io/>`_ | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.