mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-08 09:49:50 +02:00
6b4acf47b8
* Rename distributedcontext package to correlation Correlation is the name we agreed upon. * Move trace propagators to api/trace The trace propagators tests had to be moved to a testtrace subpackage to avoid import cycles between api/trace and internal/trace. Needed to shut up golint about stutter in trace.TraceContext - TraceContext is a name of a W3C spec, so this stutter is expected. It's certainly still better than golint's suggestion of having trace.Context. * Rename api/propagators to api/propagation This package will not contain any propagators in the long run, just the interface definitions. Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
56 lines
2.4 KiB
Go
56 lines
2.4 KiB
Go
// Copyright 2019, OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package propagation
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/api/core"
|
|
"go.opentelemetry.io/otel/api/correlation"
|
|
)
|
|
|
|
// TextFormat is an interface that specifies methods to inject and extract SpanContext
|
|
// and distributed context into/from a carrier using Supplier interface.
|
|
// For example, HTTP Trace Context propagator would encode SpanContext into W3C Trace
|
|
// Context Header and set the header into HttpRequest.
|
|
type TextFormat interface {
|
|
// Inject method retrieves current SpanContext from the ctx, encodes it into propagator
|
|
// specific format and then injects the encoded SpanContext using supplier into a carrier
|
|
// associated with the supplier. It also takes a correlationCtx whose values will be
|
|
// injected into a carrier using the supplier.
|
|
Inject(ctx context.Context, supplier Supplier)
|
|
|
|
// Extract method retrieves encoded SpanContext using supplier from the associated carrier.
|
|
// It decodes the SpanContext and returns it and a baggage of correlated context.
|
|
// If no SpanContext was retrieved OR if the retrieved SpanContext is invalid then
|
|
// an empty SpanContext is returned.
|
|
Extract(ctx context.Context, supplier Supplier) (core.SpanContext, correlation.Map)
|
|
|
|
// GetAllKeys returns all the keys that this propagator injects/extracts into/from a
|
|
// carrier. The use cases for this are
|
|
// * allow pre-allocation of fields, especially in systems like gRPC Metadata
|
|
// * allow a single-pass over an iterator (ex OpenTracing has no getter in TextMap)
|
|
GetAllKeys() []string
|
|
}
|
|
|
|
// Supplier is an interface that specifies methods to retrieve and store
|
|
// value for a key to an associated carrier.
|
|
// Get method retrieves the value for a given key.
|
|
// Set method stores the value for a given key.
|
|
type Supplier interface {
|
|
Get(key string) string
|
|
Set(key string, value string)
|
|
}
|