From 9fef03556c4b2437cd10378939bf6dd82299dd9a Mon Sep 17 00:00:00 2001 From: Mike Goldsmth Date: Mon, 29 Apr 2024 12:38:43 +0100 Subject: [PATCH] add warning about sensitive data to readme --- processor/baggage/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/processor/baggage/README.md b/processor/baggage/README.md index 900e99f43..b880f1150 100644 --- a/processor/baggage/README.md +++ b/processor/baggage/README.md @@ -2,6 +2,13 @@ This is an OpenTelemetry [span processor](https://opentelemetry.io/docs/specs/otel/trace/sdk/#span-processor) that reads key/values stored in [Baggage](https://opentelemetry.io/docs/specs/otel/baggage/api/) in the starting span's parent context and adds them as attributes to the span. +Keys and values added to Baggage will appear on all subsequent child spans for a trace within this service *and* will be propagated to external services via propagation headers. +If the external services also have a Baggage span processor, the keys and values will appear in those child spans as well. + +⚠️ Waning ⚠️ +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. +Do not put sensitive information in Baggage. + ## How do I get started? Install the gem using: