Rename CorrelationContext to Baggage #857

bogdandrutu · 2020-08-21T18:30:34Z

Signed-off-by: Bogdan Drutu bogdandrutu@gmail.com

Fixes #536

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

cijothomas · 2020-08-21T19:45:31Z

README.md

@@ -13,7 +13,7 @@ The OpenTelemetry specification describes the cross-language requirements and ex
 - [Library Guidelines](specification/library-guidelines.md)
  - [Package/Library Layout](specification/library-layout.md)
 - API Specification
-  - [CorrelationContext](specification/correlationcontext/api.md)
+  - [Baggage](specification/baggage/api.md)


https://github.com/open-telemetry/opentelemetry-specification/blob/master/CHANGELOG.md - Update changelog?

cijothomas · 2020-08-21T20:01:56Z

specification/baggage/api.md

+
+### Baggage
+
+`Baggage` is used to annotate telemetry, adding context and information to metrics, traces, and logs.


Not part of name change, but a question about Baggage - Does all the Baggage entries becomes part of Span attributes automatically? Or user has to write SpanProcessor to read Baggage, then populate it into Span.Attributes?

cijothomas · 2020-08-21T20:10:30Z

specification/baggage/api.md

+### Baggage
+
+`Baggage` is used to annotate telemetry, adding context and information to metrics, traces, and logs.
+It is an abstract data type represented by a set of name/value pairs describing user-defined properties.


is the value "string" type always? or does it follow similar to https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/common/common.md#attributes

FWIW I went with a string in the .NET library because we lose all typing info propagating as W3C Baggage.

cijothomas · 2020-08-21T20:21:07Z

specification/baggage/api.md

+
+#### Header Name
+
+`Baggage` implementations MUST use the header name `otcorrelations`.


Is this still the recommendation or we can now use Baggage?
#536 (comment)

let's track it separately. I think we should keep the renaming PR small. @cijothomas can you file this issue?

@cijothomas have you created an issue?

sorry i didn't hit submit:(
Thanks for creating the issue!

cijothomas · 2020-08-22T04:40:56Z

specification/baggage/api.md

@@ -0,0 +1,138 @@
+# Baggage API


Any thoughts on naming this BaggageContext?
cc: @CodeBlanch

CodeBlanch · 2020-08-22T05:19:28Z

specification/baggage/api.md

+
+`Context` the context containing the `Baggage` from which to get the baggages.
+
+### Get baggage


I just happen to be working on this in the .NET library right now. Here's some questions in case we get into something other than the name change.

What type of case sensitivity should we have for keys?

What should the behavior be when null is passed as name to GetBaggage/SetBaggage/RemoveBaggage? Throw error or return null/do nothing?

What happens if you SetBaggage('name', null)? Is null valid? Should that throw? Should null remove the item if it exists (like we do for tags)?

SergeyKanzhelev

I'd like to keep renaming PR small. It would be great to make some of comments to be issues. @cijothomas @bogdandrutu can you file those?

@cijothomas consider re-reviewing this PR with the smaller scope of just renaming. Keeping big PRs open cause more work merging things

cijothomas

Approve from name change perspective - still need changelog entry.

Opening separate issues to address other questions about Baggage API which is not tied to the renaming PR.

ktoso

Very happy to see Baggage name be adopted in otel; it's also what we set out with and arrived at in (server side) Swift, great that all terms are finally getting fleshed out 👍

(BaggageContext could also be good (in fact, that's what we do today), but Baggage is good, especially since it is carried in a context and one would want to avoid people writing "context.context" which we've seen some, so taking the context part of the name away helps in clarity).

👍

SergeyKanzhelev · 2020-08-25T16:41:05Z

this has enough approvals. Letting this PR cool off for another day and will merge tonight if no objections.

carlosalberto · 2020-08-25T16:59:49Z

@SergeyKanzhelev CHANGELOG entry is missing (but you that can be done in a follow up as well, in order to merge this change fast).

SergeyKanzhelev · 2020-08-25T23:49:41Z

@bogdandrutu can you update the changelog?

* Rename CorrelationContext to Baggage Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com> * Update CHANGELOG.md Co-authored-by: Sergey Kanzhelev <S.Kanzhelev@live.com>

Rename CorrelationContext to Baggage

40b80a0

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

bogdandrutu requested review from a team August 21, 2020 18:30

github-actions bot assigned SergeyKanzhelev Aug 21, 2020

cijothomas reviewed Aug 21, 2020

View reviewed changes

cijothomas reviewed Aug 22, 2020

View reviewed changes

specification/baggage/api.md

@@ -0,0 +1,138 @@

# Baggage API

Copy link

Member

cijothomas Aug 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any thoughts on naming this BaggageContext?
cc: @CodeBlanch

CodeBlanch reviewed Aug 22, 2020

View reviewed changes

carlosalberto added spec:baggage Related to the specification/baggage directory area:api Cross language API specification issue release:required-for-ga Must be resolved before GA release, or nice to have before GA priority:p3 Lowest priority level labels Aug 22, 2020

SergeyKanzhelev approved these changes Aug 24, 2020

View reviewed changes

cijothomas approved these changes Aug 24, 2020

View reviewed changes

cijothomas mentioned this pull request Aug 24, 2020

How does Span gets entries from CorrelationContext/Baggage #867

Open

Merge branch 'master' into baggage

557f1a9

carlosalberto self-requested a review August 25, 2020 13:14

carlosalberto approved these changes Aug 25, 2020

View reviewed changes

ktoso approved these changes Aug 25, 2020

View reviewed changes

Merge branch 'master' into baggage

3eea821

lzchen approved these changes Aug 25, 2020

View reviewed changes

lzchen mentioned this pull request Aug 25, 2020

Review Baggage specs for GA open-telemetry/opentelemetry-python#1041

Closed

Merge branch 'master' into baggage

a10f3d4

SergeyKanzhelev added 2 commits August 25, 2020 23:09

Merge branch 'master' into baggage

5e2383a

Update CHANGELOG.md

3901491

SergeyKanzhelev merged commit 14b5b6a into open-telemetry:master Aug 26, 2020

SergeyKanzhelev mentioned this pull request Aug 26, 2020

Use the draft of Baggage w3c spec instead of custom otcorrelation header #879

Closed

bogdandrutu deleted the baggage branch August 26, 2020 15:06

jtescher mentioned this pull request Aug 26, 2020

Rename CorrelationContext to Baggage open-telemetry/opentelemetry-rust#196

Closed

fbogsany mentioned this pull request Aug 26, 2020

Rename CorrelationContext to Baggage open-telemetry/opentelemetry-ruby#338

Merged

Aneurysm9 mentioned this pull request Aug 31, 2020

Rename CorrelationContext to Baggage open-telemetry/opentelemetry-go#1112

Closed

ffe4 mentioned this pull request Aug 31, 2020

Rename CorrelationContext to Baggage open-telemetry/opentelemetry-python#1060

Merged

6 tasks

andrewhsu mentioned this pull request Oct 15, 2020

update issue tmpl for baggage #1100

Merged

kamalmarhubi mentioned this pull request Dec 15, 2020

add conventions for log correlation open-telemetry/oteps#114

Closed

lalex mentioned this pull request Feb 17, 2021

Psalm Fix open-telemetry/opentelemetry-php#253

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename CorrelationContext to Baggage #857

Rename CorrelationContext to Baggage #857

bogdandrutu commented Aug 21, 2020

cijothomas Aug 21, 2020

cijothomas Aug 21, 2020

cijothomas Aug 21, 2020

CodeBlanch Aug 22, 2020

cijothomas Aug 21, 2020

SergeyKanzhelev Aug 24, 2020

SergeyKanzhelev Aug 25, 2020

SergeyKanzhelev Aug 26, 2020

cijothomas Aug 26, 2020

cijothomas Aug 22, 2020

CodeBlanch Aug 22, 2020 •

edited

Loading

SergeyKanzhelev left a comment

cijothomas left a comment

ktoso left a comment

SergeyKanzhelev commented Aug 25, 2020

carlosalberto commented Aug 25, 2020

SergeyKanzhelev commented Aug 25, 2020


		### Baggage

		`Baggage` is used to annotate telemetry, adding context and information to metrics, traces, and logs.


		#### Header Name

		`Baggage` implementations MUST use the header name `otcorrelations`.


		`Context` the context containing the `Baggage` from which to get the baggages.

		### Get baggage

Rename CorrelationContext to Baggage #857

Rename CorrelationContext to Baggage #857

Conversation

bogdandrutu commented Aug 21, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodeBlanch Aug 22, 2020 • edited Loading

Choose a reason for hiding this comment

SergeyKanzhelev left a comment

Choose a reason for hiding this comment

cijothomas left a comment

Choose a reason for hiding this comment

ktoso left a comment

Choose a reason for hiding this comment

SergeyKanzhelev commented Aug 25, 2020

carlosalberto commented Aug 25, 2020

SergeyKanzhelev commented Aug 25, 2020

CodeBlanch Aug 22, 2020 •

edited

Loading