Skip to content

docs: document span_passthrough configuration for ingest_otlp - #59

Closed
nicklas-dohrn wants to merge 1 commit into
SAP-docs:mainfrom
nicklas-dohrn:docs/span-passthrough
Closed

nicklas-dohrn wants to merge 1 commit into
SAP-docs:mainfrom
nicklas-dohrn:docs/span-passthrough

Conversation

@nicklas-dohrn

Copy link
Copy Markdown
Contributor

Summary

  • Adds span_passthrough parameter row to the ingest_otlp configuration table in
    configuration-parameters-1830bca.md, including default value, prerequisite (enabled: true), and
    a note on the service map / trace assembly trade-off
  • Updates the sample JSON to include span_passthrough
  • Adds a note in ingest-via-opentelemetry-api-endpoint-fdc78af.md explaining when and how to use
    span_passthrough, with a sample config snippet and the limitation that the service map is not
    populated

</td>
<td valign="top">

When set to `true`, span \(trace\) data is written to OpenSearch immediately as individual spans, without assembling complete traces. This disables the peer forwarder between Data Prepper replicas and sets a flush interval of 1 second on the trace processor. Defaults to `false`. Requires `enabled` to be `true`.

@christiand93 christiand93 Aug 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Use component agnostic description here (similar to the new note in "Ingest via OpenTelemetry API Endpoint" section)
  • Drop "Requires enabled to be true"

Add span_passthrough parameter to the ingest_otlp configuration table
and sample JSON, and explain its usage and trade-offs (no service map,
incomplete traces) in the OpenTelemetry endpoint guide.

Signed-off-by: Nicklas Dohrn <nicklas.dohrn@sap.com>
@nicklas-dohrn
nicklas-dohrn force-pushed the docs/span-passthrough branch from 339b8ad to 0923cba Compare August 4, 2026 12:33
@Maksimiliana Maksimiliana self-assigned this Aug 6, 2026
@Maksimiliana Maksimiliana added size/m Requires medium effort to get changed. type/content-gaps Something essential is missing in the documentation. labels Aug 6, 2026
@Maksimiliana

Copy link
Copy Markdown
Contributor

Resolved, closing because I can't merge.

@nicklas-dohrn
nicklas-dohrn deleted the docs/span-passthrough branch September 13, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m Requires medium effort to get changed. type/content-gaps Something essential is missing in the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants