Skip to content

Commit 55009ea

Browse files
authored
Merge pull request #76563 from max-cx/OBSDOCS-1024
OBSDOCS-1024/TRACING-4073: Write documentation for loadbalancer exporter component
2 parents 8238088 + 6289e22 commit 55009ea

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

modules/otel-collector-components.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -651,6 +651,46 @@ The Debug exporter prints traces and metrics to the standard output.
651651
----
652652
<1> Verbosity of the debug export: `detailed` or `normal` or `basic`. When set to `detailed`, pipeline data is verbosely logged. Defaults to `normal`.
653653

654+
[id="load-balancing-exporter_{context}"]
655+
=== Load Balancing Exporter
656+
657+
The Load Balancing Exporter consistently exports spans, metrics, and logs according to the `routing_key` configuration.
658+
659+
:FeatureName: The Load Balancing Exporter
660+
include::snippets/technology-preview.adoc[leveloffset=+1]
661+
662+
.OpenTelemetry Collector custom resource with an enabled Load Balancing Exporter
663+
[source,yaml]
664+
----
665+
# ...
666+
config: |
667+
exporters:
668+
loadbalancing:
669+
routing_key: "service" # <1>
670+
protocol:
671+
otlp: # <2>
672+
timeout: 1s
673+
resolver: # <3>
674+
static: # <4>
675+
hostnames:
676+
- backend-1:4317
677+
- backend-2:4317
678+
dns: # <5>
679+
hostname: otelcol-headless.observability.svc.cluster.local
680+
k8s: # <6>
681+
service: lb-svc.kube-public
682+
ports:
683+
- 15317
684+
- 16317
685+
# ...
686+
----
687+
<1> The `routing_key: service` exports spans for the same service name to the same Collector instance to provide accurate aggregation. The `routing_key: traceID` exports spans based on their `traceID`. The implicit default is `traceID` based routing.
688+
<2> The OTLP is the only supported load-balancing protocol. All options of the OTLP exporter are supported.
689+
<3> You can configure only one resolver.
690+
<4> The static resolver distributes the load across the listed endpoints.
691+
<5> You can use the DNS resolver only with a Kubernetes headless service.
692+
<6> The Kubernetes resolver is recommended.
693+
654694
[id="prometheus-exporter_{context}"]
655695
=== Prometheus exporter
656696

0 commit comments

Comments
 (0)