|
| 1 | +OpenTelemetry Prometheus Exporter |
| 2 | +================================ |
| 3 | + |
| 4 | +.. automodule:: opentelemetry.exporter.prometheus |
| 5 | + :members: |
| 6 | + :undoc-members: |
| 7 | + :show-inheritance: |
| 8 | + |
| 9 | +Installation |
| 10 | +----------- |
| 11 | + |
| 12 | +The OpenTelemetry Prometheus Exporter package is available on PyPI:: |
| 13 | + |
| 14 | + pip install opentelemetry-exporter-prometheus |
| 15 | + |
| 16 | +Usage |
| 17 | +----- |
| 18 | + |
| 19 | +The Prometheus exporter starts an HTTP server that collects metrics and serializes them to |
| 20 | +Prometheus text format on request:: |
| 21 | + |
| 22 | + from prometheus_client import start_http_server |
| 23 | + |
| 24 | + from opentelemetry import metrics |
| 25 | + from opentelemetry.exporter.prometheus import PrometheusMetricReader |
| 26 | + from opentelemetry.sdk.metrics import MeterProvider |
| 27 | + from opentelemetry.sdk.resources import SERVICE_NAME, Resource |
| 28 | + |
| 29 | + # Service name is required for most backends |
| 30 | + resource = Resource(attributes={ |
| 31 | + SERVICE_NAME: "your-service-name" |
| 32 | + }) |
| 33 | + |
| 34 | + # Start Prometheus client |
| 35 | + start_http_server(port=9464, addr="localhost") |
| 36 | + # Initialize PrometheusMetricReader which pulls metrics from the SDK |
| 37 | + # on-demand to respond to scrape requests |
| 38 | + reader = PrometheusMetricReader() |
| 39 | + provider = MeterProvider(resource=resource, metric_readers=[reader]) |
| 40 | + metrics.set_meter_provider(provider) |
| 41 | + |
| 42 | +Configuration |
| 43 | +------------ |
| 44 | + |
| 45 | +The following environment variables are supported: |
| 46 | + |
| 47 | +* ``OTEL_EXPORTER_PROMETHEUS_HOST`` (default: "localhost"): The host to bind to |
| 48 | +* ``OTEL_EXPORTER_PROMETHEUS_PORT`` (default: 9464): The port to bind to |
| 49 | + |
| 50 | +References |
| 51 | +---------- |
| 52 | + |
| 53 | +* `Prometheus <https://prometheus.io/>`_ |
| 54 | +* `OpenTelemetry Project <https://opentelemetry.io/>`_ |
0 commit comments