Skip to content

Commit

Permalink
Update README.rst (#2575)
Browse files Browse the repository at this point in the history
  • Loading branch information
lzchen authored Jun 4, 2024
1 parent 768694c commit c06fd1d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion processor/opentelemetry-processor-baggage/README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
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
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
Expand Down Expand Up @@ -48,4 +60,4 @@ For example, to only copy baggage entries that match the regex `^key.+`:
```python
regex_predicate = lambda baggage_key: baggage_key.startswith("^key.+")
tracer_provider.add_span_processor(BaggageSpanProcessor(regex_predicate))
```
```

0 comments on commit c06fd1d

Please sign in to comment.