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

Renaming otcorrelations header to baggage (#1267) 

* Renaming otcorrelations header to baggage

* Update CHANGELOG.md

* cleanup comment
This commit is contained in:
alrex 2020-10-20 10:51:17 -07:00 committed by GitHub
parent d6dd84f6fa
commit c9bc90b3e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -32,6 +32,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
- The function signature of the Span `AddEvent` method in `go.opentelemetry.io/otel` is updated to no longer take an unused context and instead take a required name and a variable number of `EventOption`s. (#1254) - The function signature of the Span `AddEvent` method in `go.opentelemetry.io/otel` is updated to no longer take an unused context and instead take a required name and a variable number of `EventOption`s. (#1254)
- The function signature of the Span `RecordError` method in `go.opentelemetry.io/otel` is updated to no longer take an unused context and instead take a required error value and a variable number of `EventOption`s. (#1254) - The function signature of the Span `RecordError` method in `go.opentelemetry.io/otel` is updated to no longer take an unused context and instead take a required error value and a variable number of `EventOption`s. (#1254)
- Move the `go.opentelemetry.io/otel/api/global` package to `go.opentelemetry.io/otel/global`. (#1262) - Move the `go.opentelemetry.io/otel/api/global` package to `go.opentelemetry.io/otel/global`. (#1262)
- Rename correlation context header from `"otcorrelations"` to `"baggage"` to match the OpenTelemetry specification. (#1267)
### Removed ### Removed

4
propagators/baggage.go
View File

@ -24,9 +24,7 @@ import (
"go.opentelemetry.io/otel/label" "go.opentelemetry.io/otel/label"
) )
// Temporary header name until W3C finalizes format. const baggageHeader = "baggage"
// https://github.com/open-telemetry/opentelemetry-specification/blob/18b2752ebe6c7f0cdd8c7b2bcbdceb0ae3f5ad95/specification/correlationcontext/api.md#header-name
const baggageHeader = "otcorrelations"
// Baggage is a propagator that supports the W3C Baggage format. // Baggage is a propagator that supports the W3C Baggage format.
// //

12
propagators/baggage_test.go
View File

@ -88,7 +88,7 @@ func TestExtractValidBaggageFromHTTPReq(t *testing.T) {
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
req, _ := http.NewRequest("GET", "http://example.com", nil) req, _ := http.NewRequest("GET", "http://example.com", nil)
req.Header.Set("otcorrelations", tt.header) req.Header.Set("baggage", tt.header)
ctx := context.Background() ctx := context.Background()
ctx = prop.Extract(ctx, req.Header) ctx = prop.Extract(ctx, req.Header)
@ -149,7 +149,7 @@ func TestExtractInvalidDistributedContextFromHTTPReq(t *testing.T) {
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
req, _ := http.NewRequest("GET", "http://example.com", nil) req, _ := http.NewRequest("GET", "http://example.com", nil)
req.Header.Set("otcorrelations", tt.header) req.Header.Set("baggage", tt.header)
ctx := baggage.NewContext(context.Background(), tt.hasKVs...) ctx := baggage.NewContext(context.Background(), tt.hasKVs...)
wantBaggage := baggage.MapFromContext(ctx) wantBaggage := baggage.MapFromContext(ctx)
@ -231,17 +231,17 @@ func TestInjectBaggageToHTTPReq(t *testing.T) {
ctx := baggage.ContextWithMap(context.Background(), baggage.NewMap(baggage.MapUpdate{MultiKV: tt.kvs})) ctx := baggage.ContextWithMap(context.Background(), baggage.NewMap(baggage.MapUpdate{MultiKV: tt.kvs}))
propagator.Inject(ctx, req.Header) propagator.Inject(ctx, req.Header)
gotHeader := req.Header.Get("otcorrelations") gotHeader := req.Header.Get("baggage")
wantedLen := len(strings.Join(tt.wantInHeader, ",")) wantedLen := len(strings.Join(tt.wantInHeader, ","))
if wantedLen != len(gotHeader) { if wantedLen != len(gotHeader) {
t.Errorf( t.Errorf(
"%s: Inject otcorrelations incorrect length %d != %d.", tt.name, tt.wantedLen, len(gotHeader), "%s: Inject baggage incorrect length %d != %d.", tt.name, tt.wantedLen, len(gotHeader),
) )
} }
for _, inHeader := range tt.wantInHeader { for _, inHeader := range tt.wantInHeader {
if !strings.Contains(gotHeader, inHeader) { if !strings.Contains(gotHeader, inHeader) {
t.Errorf( t.Errorf(
"%s: Inject otcorrelations missing part of header: %s in %s", tt.name, inHeader, gotHeader, "%s: Inject baggage missing part of header: %s in %s", tt.name, inHeader, gotHeader,
) )
} }
} }
@ -251,7 +251,7 @@ func TestInjectBaggageToHTTPReq(t *testing.T) {
func TestBaggagePropagatorGetAllKeys(t *testing.T) { func TestBaggagePropagatorGetAllKeys(t *testing.T) {
var propagator propagators.Baggage var propagator propagators.Baggage
want := []string{"otcorrelations"} want := []string{"baggage"}
got := propagator.Fields() got := propagator.Fields()
if diff := cmp.Diff(got, want); diff != "" { if diff := cmp.Diff(got, want); diff != "" {
t.Errorf("GetAllKeys: -got +want %s", diff) t.Errorf("GetAllKeys: -got +want %s", diff)