| 1 |
// Copyright The OpenTelemetry Authors |
| 2 |
// SPDX-License-Identifier: Apache-2.0 |
| 3 |
|
| 4 |
// Package tracetest is a testing helper package for the SDK. User can |
| 5 |
// configure no-op or in-memory exporters to verify different SDK behaviors or |
| 6 |
// custom instrumentation. |
| 7 |
package tracetest // import "go.opentelemetry.io/otel/sdk/trace/tracetest" |
| 8 |
|
| 9 |
import ( |
| 10 |
"context" |
| 11 |
"sync" |
| 12 |
|
| 13 |
"go.opentelemetry.io/otel/sdk/trace" |
| 14 |
) |
| 15 |
|
| 16 |
var _ trace.SpanExporter = (*NoopExporter)(nil) |
| 17 |
|
| 18 |
// NewNoopExporter returns a new no-op exporter. |
| 19 |
func NewNoopExporter() *NoopExporter { |
| 20 |
return new(NoopExporter) |
| 21 |
} |
| 22 |
|
| 23 |
// NoopExporter is an exporter that drops all received spans and performs no |
| 24 |
// action. |
| 25 |
type NoopExporter struct{} |
| 26 |
|
| 27 |
// ExportSpans handles export of spans by dropping them. |
| 28 |
func (*NoopExporter) ExportSpans(context.Context, []trace.ReadOnlySpan) error { return nil } |
| 29 |
|
| 30 |
// Shutdown stops the exporter by doing nothing. |
| 31 |
func (*NoopExporter) Shutdown(context.Context) error { return nil } |
| 32 |
|
| 33 |
var _ trace.SpanExporter = (*InMemoryExporter)(nil) |
| 34 |
|
| 35 |
// NewInMemoryExporter returns a new InMemoryExporter. |
| 36 |
func NewInMemoryExporter() *InMemoryExporter { |
| 37 |
return new(InMemoryExporter) |
| 38 |
} |
| 39 |
|
| 40 |
// InMemoryExporter is an exporter that stores all received spans in-memory. |
| 41 |
type InMemoryExporter struct { |
| 42 |
mu sync.Mutex |
| 43 |
ss SpanStubs |
| 44 |
} |
| 45 |
|
| 46 |
// ExportSpans handles export of spans by storing them in memory. |
| 47 |
func (imsb *InMemoryExporter) ExportSpans(_ context.Context, spans []trace.ReadOnlySpan) error { |
| 48 |
imsb.mu.Lock() |
| 49 |
defer imsb.mu.Unlock() |
| 50 |
imsb.ss = append(imsb.ss, SpanStubsFromReadOnlySpans(spans)...) |
| 51 |
return nil |
| 52 |
} |
| 53 |
|
| 54 |
// Shutdown stops the exporter by clearing spans held in memory. |
| 55 |
func (imsb *InMemoryExporter) Shutdown(context.Context) error { |
| 56 |
imsb.Reset() |
| 57 |
return nil |
| 58 |
} |
| 59 |
|
| 60 |
// Reset the current in-memory storage. |
| 61 |
func (imsb *InMemoryExporter) Reset() { |
| 62 |
imsb.mu.Lock() |
| 63 |
defer imsb.mu.Unlock() |
| 64 |
imsb.ss = nil |
| 65 |
} |
| 66 |
|
| 67 |
// GetSpans returns the current in-memory stored spans. |
| 68 |
func (imsb *InMemoryExporter) GetSpans() SpanStubs { |
| 69 |
imsb.mu.Lock() |
| 70 |
defer imsb.mu.Unlock() |
| 71 |
ret := make(SpanStubs, len(imsb.ss)) |
| 72 |
copy(ret, imsb.ss) |
| 73 |
return ret |
| 74 |
} |