Skip to content

Commit 1cd839e

Browse files
authored
Merge pull request #64716 from pavolloffay/otel-prometheus-exporter
TRACING-3270| Document OpenTelemetry prometheus exporter
2 parents bb41161 + e985a74 commit 1cd839e

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

modules/distr-tracing-otel-config-collector.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,3 +401,48 @@ The Logging exporter prints data to the standard output.
401401
exporters: [logging]
402402
----
403403
<1> Verbosity of the logging export: `detailed` or `normal` or `basic`. When set to `detailed`, pipeline data is verbosely logged. Defaults to `normal`.
404+
405+
[id="prometheus-exporter_{context}"]
406+
==== Prometheus exporter
407+
408+
The Prometheus exporter exports data using the Prometheus or OpenMetrics formats.
409+
410+
* Support level: link:https://access.redhat.com/support/offerings/techpreview[Technology Preview]
411+
* Supported signals: metrics
412+
413+
.OpenTelemetry Collector custom resource with an enabled Prometheus exporter
414+
[source,yaml]
415+
----
416+
ports:
417+
- name: promexporter <1>
418+
port: 8889
419+
protocol: TCP
420+
config: |
421+
exporters:
422+
prometheus:
423+
endpoint: 0.0.0.0:8889 <2>
424+
tls: <3>
425+
ca_file: ca.pem
426+
cert_file: cert.pem
427+
key_file: key.pem
428+
namespace: prefix <4>
429+
const_labels: <5>
430+
label1: value1
431+
enable_open_metrics: true <6>
432+
resource_to_telemetry_conversion: <7>
433+
enabled: true
434+
metric_expiration: 180m <8>
435+
service:
436+
pipelines:
437+
metrics:
438+
exporters: [prometheus]
439+
----
440+
<1> Exposes the Prometheus port from the collector pod and service. You can enable scraping of metrics by Prometheus by using the port name in `ServiceMonitor` or `PodMonitor` custom resource.
441+
<2> The network endpoint where the metrics are exposed.
442+
<3> The server-side TLS configuration. Defines paths to TLS certificates.
443+
<4> If set, exports metrics under the provided value. No default.
444+
<5> Key-value pair labels that are applied for every exported metric. No default.
445+
<6> If `true`, metrics are exported using the OpenMetrics format. Exemplars are only exported in the OpenMetrics format and only for histogram and monotonic sum metrics such as `counter`. Disabled by default.
446+
<7> If `enabled` is `true`, all the resource attributes are converted to metric labels by default. Disabled by default.
447+
<8> Defines how long metrics are exposed without updates. The default is `5m`.
448+

0 commit comments

Comments
 (0)