open-telemetry
/
opentelemetry-python-contrib
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.rst (#2575)

This commit is contained in:
Leighton Chen 2024-06-04 09:19:48 -07:00 committed by GitHub
parent 768694cf75
commit c06fd1dd53
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
processor/opentelemetry-processor-baggage/README.rst
View File

@ -1,10 +1,22 @@
OpenTelemetry Baggage Span Processor OpenTelemetry Baggage Span Processor
==================================== ====================================
|pypi|
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-processor-baggage.svg
:target: https://pypi.org/project/opentelemetry-processor-baggage/
The BaggageSpanProcessor reads entries stored in Baggage The BaggageSpanProcessor reads entries stored in Baggage
from the parent context and adds the baggage entries' keys and from the parent context and adds the baggage entries' keys and
values to the span as attributes on span start. values to the span as attributes on span start.
Installation
------------
::
pip install opentelemetry-processor-baggage
Add this span processor to a tracer provider. Add this span processor to a tracer provider.
Keys and values added to Baggage will appear on subsequent child Keys and values added to Baggage will appear on subsequent child
@ -48,4 +60,4 @@ For example, to only copy baggage entries that match the regex `^key.+`:
```python ```python
regex_predicate = lambda baggage_key: baggage_key.startswith("^key.+") regex_predicate = lambda baggage_key: baggage_key.startswith("^key.+")
tracer_provider.add_span_processor(BaggageSpanProcessor(regex_predicate)) tracer_provider.add_span_processor(BaggageSpanProcessor(regex_predicate))
``` ```