From c06fd1dd534513ae26c16ed5eb5916a5f8eb4cf0 Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Tue, 4 Jun 2024 09:19:48 -0700 Subject: [PATCH] Update README.rst (#2575) --- .../opentelemetry-processor-baggage/README.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/processor/opentelemetry-processor-baggage/README.rst b/processor/opentelemetry-processor-baggage/README.rst index a111166ce..83c4e91ed 100644 --- a/processor/opentelemetry-processor-baggage/README.rst +++ b/processor/opentelemetry-processor-baggage/README.rst @@ -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 @@ -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)) -``` \ No newline at end of file +```