mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-01-05 22:54:18 +02:00
3dc91f2d76
* Add ForceFlush method to TracerProvider The specification requires that a TracerProvider have a ForceFlush method that can be set with a timeout, return any error to the caller, and have all the registered span processors export their spans. This updates the SpanProcessor.ForceFlush method to accept a context and return an error and plumbs this method into a new ForceFlush method of the SDK TracerProvider. Additionally, this corrects the TracerProvider Shutdown method. This method as well needs to return to the caller any failure it encounters according to the specification. This returns an error if it cannot type assert the spanProcessorStates or if shutting down a span processor results in an error. Resolves #1606 * Add changes to changelog * Apply suggestions from code review Co-authored-by: Steven E. Harris <seh@panix.com> * Cancel export context when BSP stops * Defer cancel call in BSP span processor funcs Co-authored-by: Steven E. Harris <seh@panix.com>
99 lines
3.0 KiB
Go
99 lines
3.0 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 (
|
|
"context"
|
|
"time"
|
|
|
|
"go.opentelemetry.io/otel/sdk/export/trace/tracetest"
|
|
)
|
|
|
|
// DurationFilter is a SpanProcessor that filters spans that have lifetimes
|
|
// outside of a defined range.
|
|
type DurationFilter struct {
|
|
// Next is the next SpanProcessor in the chain.
|
|
Next SpanProcessor
|
|
|
|
// Min is the duration under which spans are dropped.
|
|
Min time.Duration
|
|
// Max is the duration over which spans are dropped.
|
|
Max time.Duration
|
|
}
|
|
|
|
func (f DurationFilter) OnStart(parent context.Context, s ReadWriteSpan) {
|
|
f.Next.OnStart(parent, s)
|
|
}
|
|
func (f DurationFilter) Shutdown(ctx context.Context) error { return f.Next.Shutdown(ctx) }
|
|
func (f DurationFilter) ForceFlush(ctx context.Context) error { return f.Next.ForceFlush(ctx) }
|
|
func (f DurationFilter) OnEnd(s ReadOnlySpan) {
|
|
if f.Min > 0 && s.EndTime().Sub(s.StartTime()) < f.Min {
|
|
// Drop short lived spans.
|
|
return
|
|
}
|
|
if f.Max > 0 && s.EndTime().Sub(s.StartTime()) > f.Max {
|
|
// Drop long lived spans.
|
|
return
|
|
}
|
|
f.Next.OnEnd(s)
|
|
}
|
|
|
|
// InstrumentationBlacklist is a SpanProcessor that drops all spans from
|
|
// certain instrumentation.
|
|
type InstrumentationBlacklist struct {
|
|
// Next is the next SpanProcessor in the chain.
|
|
Next SpanProcessor
|
|
|
|
// Blacklist is the set of instrumentation names for which spans will be
|
|
// dropped.
|
|
Blacklist map[string]bool
|
|
}
|
|
|
|
func (f InstrumentationBlacklist) OnStart(parent context.Context, s ReadWriteSpan) {
|
|
f.Next.OnStart(parent, s)
|
|
}
|
|
func (f InstrumentationBlacklist) Shutdown(ctx context.Context) error { return f.Next.Shutdown(ctx) }
|
|
func (f InstrumentationBlacklist) ForceFlush(ctx context.Context) error {
|
|
return f.Next.ForceFlush(ctx)
|
|
}
|
|
func (f InstrumentationBlacklist) OnEnd(s ReadOnlySpan) {
|
|
if f.Blacklist != nil && f.Blacklist[s.InstrumentationLibrary().Name] {
|
|
// Drop spans from this instrumentation
|
|
return
|
|
}
|
|
f.Next.OnEnd(s)
|
|
}
|
|
|
|
func ExampleSpanProcessor() {
|
|
exportSP := NewSimpleSpanProcessor(tracetest.NewNoopExporter())
|
|
|
|
// Build a SpanProcessor chain to filter out all spans from the pernicious
|
|
// "naughty-instrumentation" dependency and only allow spans shorter than
|
|
// an minute and longer than a second to be exported with the exportSP.
|
|
filter := DurationFilter{
|
|
Next: InstrumentationBlacklist{
|
|
Next: exportSP,
|
|
Blacklist: map[string]bool{
|
|
"naughty-instrumentation": true,
|
|
},
|
|
},
|
|
Min: time.Second,
|
|
Max: time.Minute,
|
|
}
|
|
|
|
_ = NewTracerProvider(WithSpanProcessor(filter))
|
|
// ...
|
|
}
|