Skip to content

README.md

Latest commit

 

History

History
104 lines (72 loc) · 4.4 KB

README.md

File metadata and controls

104 lines (72 loc) · 4.4 KB

OpenTelemetry Baggage Span and Log Record Processor

Maven

The BaggageSpanProcessor and BaggageLogRecordProcessor read entries stored in Baggage from the parent context and adds the baggage keys and values to the Span, respectively LogRecord, as attributes on start, respectively emit.

Add these span and log processors to the tracer and logger providers.

Warning!

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

Do not put sensitive information in Baggage.

Usage

Usage with SDK auto-configuration

If you are using the OpenTelemetry SDK auto-configuration, you can add the span and log baggage processors through configuration.

Property Description
otel.java.experimental.span-attributes.copy-from-baggage.include Add baggage entries as span attributes, e.g. key1,key*, wildcard pattern mathinc is supported.
otel.java.experimental.log-attributes.copy-from-baggage.include Add baggage entries as log attributes, e.g. key1,key*, wildcard pattern mathinc is supported.

[Wildcard pattern matching](wildcard pattern matching) is supported for both properties.

Usage with declarative configuration

You can configure the baggage span and log record processors using declarative YAML configuration with the OpenTelemetry SDK.

For the tracer provider (span processor):

file_format: '1.0'
tracer_provider:
  processors:
    - baggage:
        included: [foo]
        excluded: [bar]

For the logger provider (log record processor):

file_format: '1.0'
logger_provider:
  processors:
    - baggage:
        included: [foo]
        excluded: [bar]

This will configure the respective processor to include baggage keys listed in included and exclude those in excluded as explained in Properties requiring pattern matching.

When both included and excluded are empty or not set, all the baggage entries will be copied. When only included is set, only the baggage entries matching the patterns in included will be copied (opt-in). When only excluded is set, all baggage entries except those matching the patterns in excluded will be copied (opt-out). When a value matches both included and excluded, then it is excluded.

Usage through programmatic activation

Add the span and log processor when configuring the tracer and logger providers.

To configure the span and log processors to copy all baggage entries during configuration:

import io.opentelemetry.contrib.baggage.processor.BaggageSpanProcessor;
import io.opentelemetry.contrib.baggage.processor.BaggageLogProcessor;

// ...

TracerProvider tracerProvider = SdkTracerProvider.builder()
    .addSpanProcessor(BaggageSpanProcessor.allowAllBaggageKeys())
    .build();

LoggerProvider loggerProvider = SdkLoggerProvider.builder()
    .addLogProcessor(BaggageLogRecordProcessor.allowAllBaggageKeys())
    .build();

Alternatively, you can provide a custom baggage key wildcards to select which baggage keys you want to include/exclude for copy.

For example, to only copy baggage entries that start with my-key and ignore keys that end with *-ignored

new BaggageSpanProcessor(Collections.singletonList("my-key*"), Collections.singletonList("*-ignored"));
new BaggageLogRecordProcessor(Collections.singletonList("my-key*"), Collections.singletonList("*-ignored"));

Component owners

Learn more about component owners in component_owners.yml.