Skip to content

Commit 9201587

Browse files
rlankfoFiery-Fenix
authored andcommitted
[exporter/loadbalancing] update README and include attributes routing key (open-telemetry#39107)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Doc update related to open-telemetry#36567 <!--Describe the documentation added.--> #### Documentation Adds attributes routing_key to table in README and a minor documentation fix. --------- Signed-off-by: Robbie Lankford <[email protected]>
1 parent c73c638 commit 9201587

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

exporter/loadbalancingexporter/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The options for `routing_key` are: `service`, `traceID`, `metric` (metric name),
2626
| resource | metrics |
2727
| metric | metrics |
2828
| streamID | metrics |
29+
| attributes | spans |
2930

3031
If no `routing_key` is configured, the default routing mechanism is `traceID` for traces, while `service` is the default for metrics. This means that spans belonging to the same `traceID` (or `service.name`, when `service` is used as the `routing_key`) will be sent to the same backend.
3132

@@ -114,8 +115,8 @@ Refer to [config.yaml](./testdata/config.yaml) for detailed examples on using th
114115
* This resolver currently returns a maximum of 100 hosts.
115116
* `TODO`: Feature request [29771](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/29771) aims to cover the pagination for this scenario
116117
* The `routing_key` property is used to specify how to route values (spans or metrics) to exporters based on different parameters. This functionality is currently enabled only for `trace` and `metric` pipeline types. It supports one of the following values:
117-
* `service`: Routes values based on their service name. This is useful when using processors like the span metrics, so all spans for each service are sent to consistent collector instances for metric collection. Otherwise, metrics for the same services are sent to different collectors, making aggregations inaccurate. In addition to resource / span attributes, `span.kind`, `span.name` (the top level properties of a span) are also supported.
118-
* `attributes`: Routes based on values in the attributes of the traces. This is similar to service, but useful for situations in which a single service overwhelms any given instance of the collector, and should be split over multiple collectors.
118+
* `service`: Routes values based on their service name. This is useful when using processors like the span metrics, so all spans for each service are sent to consistent collector instances for metric collection. Otherwise, metrics for the same services are sent to different collectors, making aggregations inaccurate.
119+
* `attributes`: Routes based on values in the attributes of the traces. This is similar to service, but useful for situations in which a single service overwhelms any given instance of the collector, and should be split over multiple collectors. In addition to resource / span attributes, `span.kind`, `span.name` (the top level properties of a span) are also supported.
119120
* `traceID`: Routes spans based on their `traceID`. Invalid for metrics.
120121
* `metric`: Routes metrics based on their metric name. Invalid for spans.
121122
* `streamID`: Routes metrics based on their datapoint streamID. That's the unique hash of all it's attributes, plus the attributes and identifying information of its resource, scope, and metric data

0 commit comments

Comments
 (0)