mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-14 10:13:10 +02:00
992837f195
* Add TracerProvider tests to oteltest harness * Update Tracer method docs * Fix grammar
261 lines
7.3 KiB
Go
261 lines
7.3 KiB
Go
// Copyright The 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 trace // import "go.opentelemetry.io/otel/sdk/trace"
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
"sync/atomic"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/trace"
|
|
|
|
export "go.opentelemetry.io/otel/sdk/export/trace"
|
|
"go.opentelemetry.io/otel/sdk/instrumentation"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
)
|
|
|
|
const (
|
|
defaultTracerName = "go.opentelemetry.io/otel/sdk/tracer"
|
|
)
|
|
|
|
// TODO (MrAlias): unify this API option design:
|
|
// https://github.com/open-telemetry/opentelemetry-go/issues/536
|
|
|
|
// TracerProviderConfig
|
|
type TracerProviderConfig struct {
|
|
processors []SpanProcessor
|
|
config Config
|
|
}
|
|
|
|
type TracerProviderOption func(*TracerProviderConfig)
|
|
|
|
type TracerProvider struct {
|
|
mu sync.Mutex
|
|
namedTracer map[instrumentation.Library]*tracer
|
|
spanProcessors atomic.Value
|
|
config atomic.Value // access atomically
|
|
}
|
|
|
|
var _ trace.TracerProvider = &TracerProvider{}
|
|
|
|
// NewTracerProvider creates an instance of trace provider. Optional
|
|
// parameter configures the provider with common options applicable
|
|
// to all tracer instances that will be created by this provider.
|
|
func NewTracerProvider(opts ...TracerProviderOption) *TracerProvider {
|
|
o := &TracerProviderConfig{}
|
|
|
|
for _, opt := range opts {
|
|
opt(o)
|
|
}
|
|
|
|
tp := &TracerProvider{
|
|
namedTracer: make(map[instrumentation.Library]*tracer),
|
|
}
|
|
tp.config.Store(&Config{
|
|
DefaultSampler: ParentBased(AlwaysSample()),
|
|
IDGenerator: defaultIDGenerator(),
|
|
SpanLimits: SpanLimits{
|
|
AttributeCountLimit: DefaultAttributeCountLimit,
|
|
EventCountLimit: DefaultEventCountLimit,
|
|
LinkCountLimit: DefaultLinkCountLimit,
|
|
AttributePerEventCountLimit: DefaultAttributePerEventCountLimit,
|
|
AttributePerLinkCountLimit: DefaultAttributePerLinkCountLimit,
|
|
},
|
|
})
|
|
|
|
for _, sp := range o.processors {
|
|
tp.RegisterSpanProcessor(sp)
|
|
}
|
|
|
|
tp.ApplyConfig(o.config)
|
|
|
|
return tp
|
|
}
|
|
|
|
// Tracer returns a Tracer with the given name and options. If a Tracer for
|
|
// the given name and options does not exist it is created, otherwise the
|
|
// existing Tracer is returned.
|
|
//
|
|
// If name is empty, DefaultTracerName is used instead.
|
|
//
|
|
// This method is safe to be called concurrently.
|
|
func (p *TracerProvider) Tracer(name string, opts ...trace.TracerOption) trace.Tracer {
|
|
c := trace.NewTracerConfig(opts...)
|
|
|
|
p.mu.Lock()
|
|
defer p.mu.Unlock()
|
|
if name == "" {
|
|
name = defaultTracerName
|
|
}
|
|
il := instrumentation.Library{
|
|
Name: name,
|
|
Version: c.InstrumentationVersion,
|
|
}
|
|
t, ok := p.namedTracer[il]
|
|
if !ok {
|
|
t = &tracer{
|
|
provider: p,
|
|
instrumentationLibrary: il,
|
|
}
|
|
p.namedTracer[il] = t
|
|
}
|
|
return t
|
|
}
|
|
|
|
// RegisterSpanProcessor adds the given SpanProcessor to the list of SpanProcessors
|
|
func (p *TracerProvider) RegisterSpanProcessor(s SpanProcessor) {
|
|
p.mu.Lock()
|
|
defer p.mu.Unlock()
|
|
new := spanProcessorStates{}
|
|
if old, ok := p.spanProcessors.Load().(spanProcessorStates); ok {
|
|
new = append(new, old...)
|
|
}
|
|
newSpanSync := &spanProcessorState{
|
|
sp: s,
|
|
state: &sync.Once{},
|
|
}
|
|
new = append(new, newSpanSync)
|
|
p.spanProcessors.Store(new)
|
|
}
|
|
|
|
// UnregisterSpanProcessor removes the given SpanProcessor from the list of SpanProcessors
|
|
func (p *TracerProvider) UnregisterSpanProcessor(s SpanProcessor) {
|
|
p.mu.Lock()
|
|
defer p.mu.Unlock()
|
|
spss := spanProcessorStates{}
|
|
old, ok := p.spanProcessors.Load().(spanProcessorStates)
|
|
if !ok || len(old) == 0 {
|
|
return
|
|
}
|
|
spss = append(spss, old...)
|
|
|
|
// stop the span processor if it is started and remove it from the list
|
|
var stopOnce *spanProcessorState
|
|
var idx int
|
|
for i, sps := range spss {
|
|
if sps.sp == s {
|
|
stopOnce = sps
|
|
idx = i
|
|
}
|
|
}
|
|
if stopOnce != nil {
|
|
stopOnce.state.Do(func() {
|
|
if err := s.Shutdown(context.Background()); err != nil {
|
|
otel.Handle(err)
|
|
}
|
|
})
|
|
}
|
|
if len(spss) > 1 {
|
|
copy(spss[idx:], spss[idx+1:])
|
|
}
|
|
spss[len(spss)-1] = nil
|
|
spss = spss[:len(spss)-1]
|
|
|
|
p.spanProcessors.Store(spss)
|
|
}
|
|
|
|
// ApplyConfig changes the configuration of the provider.
|
|
// If a field in the configuration is empty or nil then its original value is preserved.
|
|
func (p *TracerProvider) ApplyConfig(cfg Config) {
|
|
p.mu.Lock()
|
|
defer p.mu.Unlock()
|
|
c := *p.config.Load().(*Config)
|
|
if cfg.DefaultSampler != nil {
|
|
c.DefaultSampler = cfg.DefaultSampler
|
|
}
|
|
if cfg.IDGenerator != nil {
|
|
c.IDGenerator = cfg.IDGenerator
|
|
}
|
|
if cfg.SpanLimits.EventCountLimit > 0 {
|
|
c.SpanLimits.EventCountLimit = cfg.SpanLimits.EventCountLimit
|
|
}
|
|
if cfg.SpanLimits.AttributeCountLimit > 0 {
|
|
c.SpanLimits.AttributeCountLimit = cfg.SpanLimits.AttributeCountLimit
|
|
}
|
|
if cfg.SpanLimits.LinkCountLimit > 0 {
|
|
c.SpanLimits.LinkCountLimit = cfg.SpanLimits.LinkCountLimit
|
|
}
|
|
if cfg.SpanLimits.AttributePerEventCountLimit > 0 {
|
|
c.SpanLimits.AttributePerEventCountLimit = cfg.SpanLimits.AttributePerEventCountLimit
|
|
}
|
|
if cfg.SpanLimits.AttributePerLinkCountLimit > 0 {
|
|
c.SpanLimits.AttributePerLinkCountLimit = cfg.SpanLimits.AttributePerLinkCountLimit
|
|
}
|
|
c.Resource = cfg.Resource
|
|
if c.Resource == nil {
|
|
c.Resource = resource.Default()
|
|
}
|
|
p.config.Store(&c)
|
|
}
|
|
|
|
// Shutdown shuts down the span processors in the order they were registered
|
|
func (p *TracerProvider) Shutdown(ctx context.Context) error {
|
|
spss, ok := p.spanProcessors.Load().(spanProcessorStates)
|
|
if !ok || len(spss) == 0 {
|
|
return nil
|
|
}
|
|
|
|
for _, sps := range spss {
|
|
sps.state.Do(func() {
|
|
if err := sps.sp.Shutdown(ctx); err != nil {
|
|
otel.Handle(err)
|
|
}
|
|
})
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// WithSyncer registers the exporter with the TracerProvider using a
|
|
// SimpleSpanProcessor.
|
|
func WithSyncer(e export.SpanExporter) TracerProviderOption {
|
|
return WithSpanProcessor(NewSimpleSpanProcessor(e))
|
|
}
|
|
|
|
// WithBatcher registers the exporter with the TracerProvider using a
|
|
// BatchSpanProcessor configured with the passed opts.
|
|
func WithBatcher(e export.SpanExporter, opts ...BatchSpanProcessorOption) TracerProviderOption {
|
|
return WithSpanProcessor(NewBatchSpanProcessor(e, opts...))
|
|
}
|
|
|
|
// WithSpanProcessor registers the SpanProcessor with a TracerProvider.
|
|
func WithSpanProcessor(sp SpanProcessor) TracerProviderOption {
|
|
return func(opts *TracerProviderConfig) {
|
|
opts.processors = append(opts.processors, sp)
|
|
}
|
|
}
|
|
|
|
// WithConfig option sets the configuration to provider.
|
|
func WithConfig(config Config) TracerProviderOption {
|
|
return func(opts *TracerProviderConfig) {
|
|
opts.config = config
|
|
}
|
|
}
|
|
|
|
// WithResource option attaches a resource to the provider.
|
|
// The resource is added to the span when it is started.
|
|
func WithResource(r *resource.Resource) TracerProviderOption {
|
|
return func(opts *TracerProviderConfig) {
|
|
opts.config.Resource = r
|
|
}
|
|
}
|
|
|
|
// WithIDGenerator option registers an IDGenerator with the TracerProvider.
|
|
func WithIDGenerator(g IDGenerator) TracerProviderOption {
|
|
return func(opts *TracerProviderConfig) {
|
|
opts.config.IDGenerator = g
|
|
}
|
|
}
|