Skip to main content

OpenTelemetry Baggage Span Processor

Project description

pypi

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

Installation

pip install opentelemetry-processor-baggage

Add this span processor to a tracer provider.

Keys and values added to Baggage will appear on subsequent child spans for a trace within this service and be propagated to external services in accordance with any configured propagation formats configured. If the external services also have a Baggage span processor, the keys and values will appear in those child spans as well.

[!WARNING]

Do not put sensitive information in Baggage.

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

## Usage

Add the span processor when configuring the tracer provider.

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

from opentelemetry.processor.baggage import BaggageSpanProcessor, ALLOW_ALL_BAGGAGE_KEYS

tracer_provider = TracerProvider()
tracer_provider.add_span_processor(BaggageSpanProcessor(ALLOW_ALL_BAGGAGE_KEYS))

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:

starts_with_predicate = lambda baggage_key: baggage_key.startswith("my-key")
tracer_provider.add_span_processor(BaggageSpanProcessor(starts_with_predicate))

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

regex_predicate = lambda baggage_key: baggage_key.startswith("^key.+")
tracer_provider.add_span_processor(BaggageSpanProcessor(regex_predicate))

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file opentelemetry_processor_baggage-0.49b1.tar.gz.

File metadata

File hashes

Hashes for opentelemetry_processor_baggage-0.49b1.tar.gz
Algorithm Hash digest
SHA256 bcf1b0c8cab66316642a7e0d07e06c9cfa91dbd901d4b0086185b2f02f2d6452
MD5 b1df10f5a09df3d8625504c60c09613d
BLAKE2b-256 29d57762dd7ec674068b956470d710bc14509c5e7251a07eab5cc68818c080ad

See more details on using hashes here.

Provenance

File details

Details for the file opentelemetry_processor_baggage-0.49b1-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_processor_baggage-0.49b1-py3-none-any.whl
Algorithm Hash digest
SHA256 a68df6a9eddae5ec9d5974cd5af94873f9bd5fe82a4eb0dd9a2420c14a1f5ecd
MD5 15b03612588ab674c81559ae0d844094
BLAKE2b-256 6680f406bba0e822a0165bda82371062b490b0a5297702d77344afb1fd11d7c2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page