Add further clarification and align with wording in internal docs - #62
Open
nicklas-dohrn wants to merge 1 commit into
Open
nicklas-dohrn wants to merge 1 commit into
nicklas-dohrn wants to merge 1 commit into
Conversation
JannikBrand
reviewed
Sep 17, 2026
Comment on lines
32
to
+44
| > ### Note: | ||
| > By default, the trace pipeline assembles complete traces and populates the service map \(`otel-v1-apm-service-map index`\). If you only need raw span data and do not require service map or full trace assembly, you can enable span passthrough mode: | ||
| > | ||
| > ``` | ||
| > { | ||
| > "ingest_otlp": { | ||
| > "enabled": true, | ||
| > "span_passthrough": true | ||
| > } | ||
| > } | ||
| > ``` | ||
| > | ||
| > When `span_passthrough` is set to `true`, spans are written to OpenSearch individually as they arrive. The service map is not populated and trace views may show incomplete traces. | ||
| > When `span_passthrough` is set to `true`, spans are written to OpenSearch individually as they arrive, without assembling complete traces. This can be useful if you know that root/parent spans will be missing from your telemetry \(e.g., when only a subset of services in a request path emit spans\), so trace assembly cannot succeed anyway. In this case it lowers ingestion latency at the cost of trace completeness. Furthermore, when enabled, the `otel-v1-apm-service-map` index is not populated, so the Service Map view in the Observability plugin of OpenSearch Dashboards will not function and the Trace Analytics view may show orphaned spans rather than complete trace trees. |
Contributor
There was a problem hiding this comment.
To avoid duplication I would prefer to reference the span_passthrough parameter description from the configuration-parameter page.
Suggested change
| > When `span_passthrough` is set to `true`, spans are written to OpenSearch individually as they arrive, without assembling complete traces. This can be useful if you know that root/parent spans will be missing from your telemetry \(e.g., when only a subset of services in a request path emit spans\), so trace assembly cannot succeed anyway. In this case it lowers ingestion latency at the cost of trace completeness. Furthermore, when enabled, the `otel-v1-apm-service-map` index is not populated, so the Service Map view in the Observability plugin of OpenSearch Dashboards will not function and the Trace Analytics view may show orphaned spans rather than complete trace trees. | |
| > ### Note: | |
| > If you only need raw span data and do not require service map or full trace assembly, you can enable span passthrough mode (see [ingest_otlp configuration parameter](configuration-parameters-1830bca.md#loio1830bca1b060484e9cfabc0e62472e8e__table_zcy_jjx_jzb)): | |
| > | |
| > ``` | |
| > { | |
| > "ingest_otlp": { | |
| > "enabled": true, | |
| > "span_passthrough": true | |
| > } | |
| > } | |
| > ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Just a further improvement/alignment on this documentation to remove some ambiguity.