Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.17 KB

README.md

File metadata and controls

59 lines (38 loc) · 2.17 KB
Raw

OpenTelemetry Baggage Span Processor

The BaggageSpanProcessor reads entries stored in Baggage from the parent context and adds the baggage keys and values to the Span as attributes on start.

Add this span processor to a tracer provider.

Warning!

To repeat: a consequence of adding data to Baggage is that the keys and values will appear in all outgoing trace context headers from the application.

Do not put sensitive information in Baggage.

Usage

Add the span processor when configuring the tracer provider.

To configure the span processor to copy all baggage entries during configuration:

import io.opentelemetry.contrib.baggage.processor;
// ...

Tracer tracer = SdkTracerProvider.builder()
  .addSpanProcessor(new BaggageSpanProcessor(BaggageSpanProcessor.allowAllBaggageKeys))
  .build()

Alternatively, you can provide a custom baggage key predicate to select which baggage keys you want to copy.

For example, to only copy baggage entries that start with my-key:

new BaggageSpanProcessor(baggageKey -> baggageKey.startsWith("my-key"))

For example, to only copy baggage entries that match the regex ^key.+:

Pattern pattern = Pattern.compile("^key.+");
new BaggageSpanProcessor(baggageKey -> pattern.matcher(baggageKey).matches())

Usage with SDK auto-configuration

If you are using the OpenTelemetry SDK auto-configuration, you can add the span processor this library to configure the span processor.

Property Description
otel.java.experimental.span-attributes.copy-from-baggage.include Add baggage entries as span attributes, e.g. key1,key2 or * to add all baggage items as keys.

Component owners

Learn more about component owners in component_owners.yml.