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>
85 lines
2.1 KiB
Go
85 lines
2.1 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"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type basicSpanProcesor struct {
|
|
running bool
|
|
injectShutdownError error
|
|
}
|
|
|
|
func (t *basicSpanProcesor) Shutdown(context.Context) error {
|
|
t.running = false
|
|
return t.injectShutdownError
|
|
}
|
|
|
|
func (t *basicSpanProcesor) OnStart(context.Context, ReadWriteSpan) {}
|
|
func (t *basicSpanProcesor) OnEnd(ReadOnlySpan) {}
|
|
func (t *basicSpanProcesor) ForceFlush(context.Context) error {
|
|
return nil
|
|
}
|
|
|
|
func TestShutdownTraceProvider(t *testing.T) {
|
|
stp := NewTracerProvider()
|
|
sp := &basicSpanProcesor{}
|
|
stp.RegisterSpanProcessor(sp)
|
|
|
|
sp.running = true
|
|
|
|
_ = stp.Shutdown(context.Background())
|
|
|
|
if sp.running != false {
|
|
t.Errorf("Error shutdown basicSpanProcesor\n")
|
|
}
|
|
}
|
|
|
|
func TestFailedProcessorShutdown(t *testing.T) {
|
|
stp := NewTracerProvider()
|
|
spErr := errors.New("basic span processor shutdown failure")
|
|
sp := &basicSpanProcesor{
|
|
running: true,
|
|
injectShutdownError: spErr,
|
|
}
|
|
stp.RegisterSpanProcessor(sp)
|
|
|
|
err := stp.Shutdown(context.Background())
|
|
assert.Error(t, err)
|
|
assert.Equal(t, err, spErr)
|
|
}
|
|
|
|
func TestFailedProcessorShutdownInUnregister(t *testing.T) {
|
|
handler.Reset()
|
|
stp := NewTracerProvider()
|
|
spErr := errors.New("basic span processor shutdown failure")
|
|
sp := &basicSpanProcesor{
|
|
running: true,
|
|
injectShutdownError: spErr,
|
|
}
|
|
stp.RegisterSpanProcessor(sp)
|
|
stp.UnregisterSpanProcessor(sp)
|
|
|
|
assert.Contains(t, handler.errs, spErr)
|
|
|
|
err := stp.Shutdown(context.Background())
|
|
assert.NoError(t, err)
|
|
}
|