mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +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>
57 lines
2.0 KiB
Go
57 lines
2.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 "go.opentelemetry.io/otel/sdk/trace"
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
)
|
|
|
|
// SpanProcessor is a processing pipeline for spans in the trace signal.
|
|
// SpanProcessors registered with a TracerProvider and are called at the start
|
|
// and end of a Span's lifecycle, and are called in the order they are
|
|
// registered.
|
|
type SpanProcessor interface {
|
|
// OnStart is called when a span is started. It is called synchronously
|
|
// and should not block.
|
|
OnStart(parent context.Context, s ReadWriteSpan)
|
|
|
|
// OnEnd is called when span is finished. It is called synchronously and
|
|
// hence not block.
|
|
OnEnd(s ReadOnlySpan)
|
|
|
|
// Shutdown is called when the SDK shuts down. Any cleanup or release of
|
|
// resources held by the processor should be done in this call.
|
|
//
|
|
// Calls to OnStart, OnEnd, or ForceFlush after this has been called
|
|
// should be ignored.
|
|
//
|
|
// All timeouts and cancellations contained in ctx must be honored, this
|
|
// should not block indefinitely.
|
|
Shutdown(ctx context.Context) error
|
|
|
|
// ForceFlush exports all ended spans to the configured Exporter that have not yet
|
|
// been exported. It should only be called when absolutely necessary, such as when
|
|
// using a FaaS provider that may suspend the process after an invocation, but before
|
|
// the Processor can export the completed spans.
|
|
ForceFlush(ctx context.Context) error
|
|
}
|
|
|
|
type spanProcessorState struct {
|
|
sp SpanProcessor
|
|
state *sync.Once
|
|
}
|
|
type spanProcessorStates []*spanProcessorState
|