Skip to content

TRACING-4224: add documentation for routing connector #78614

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

TRACING-4224: add documentation for routing connector #78614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions observability/otel/otel-collector/otel-collector-connectors.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,45 @@ toc::[]

A connector connects two pipelines. It consumes data as an exporter at the end of one pipeline and emits data as a receiver at the start of another pipeline. It can consume and emit data of the same or different data type. It can generate and emit data to summarize the consumed data, or it can merely replicate or route data.

[id="routing-connector_{context}"]
== Routing Connector

:FeatureName: The Routing Connector
include::snippets/technology-preview.adoc[]

.OpenTelemetry Collector custom resource with an enabled Routing Connector
[source,yaml]
----
config: |
connectors:
routing:
table: <1>
- statement: route() where attributes["X-Tenant"] == "dev" <2>
pipelines: [traces/dev] <3>
- statement: route() where attributes["X-Tenant"] == "prod"
pipelines: [traces/prod]
default_pipelines: [traces/dev] <4>
error_mode: ignore <5>
match_once: false <6>
service:
pipelines:
traces/in:
receivers: [otlp]
exporters: [routing]
traces/dev:
receivers: [routing]
exporters: [otlp/dev]
traces/prod:
receivers: [routing]
exporters: [otlp/prod]
----
<1> Connector routing table.
<2> Routing condition writen as OTTL statement.
<3> Pipelines where the matching telemetry data will be exported.
<4> Pipeline where the telemetry data will be sent when none of the conditions is satisfied.
<5> Determines how the error should be managed. `propagate` (default) will log an error and drop the payload. `ignore` will ignore the condition and try to match with the next one. `silent` will do the same as `ignore` but without logging the error.
<6> When enabled (default is `false`), the payload will be routed only to the first pipeline whose routing condition is met.

[id="forward-connector_{context}"]
== Forward Connector

Expand Down