Skip to content

Commit

Permalink
Update SpanProcessor docs (open-telemetry#1611)
Browse files Browse the repository at this point in the history
Included all directives from the specification, clarify english, and
translate specifics for the Go language.
  • Loading branch information
MrAlias authored and ldelossa committed Mar 5, 2021
1 parent 613ea74 commit 32745a7
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions sdk/trace/span_processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,27 @@ import (
"sync"
)

// SpanProcessor is interface to add hooks to start and end method invocations.
// 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 method is invoked when span is started. It is a synchronous call
// and hence should not block.
// OnStart is called when a span is started. It is called synchronously
// and should not block.
OnStart(parent context.Context, s ReadWriteSpan)

// OnEnd method is invoked when span is finished. It is a synchronous call
// and hence should not block.
// OnEnd is called when span is finished. It is called synchronously and
// hence not block.
OnEnd(s ReadOnlySpan)

// Shutdown is invoked when SDK shuts down. Use this call to cleanup any processor
// data. No calls to OnStart and OnEnd method is invoked after Shutdown call is
// made. It should not be blocked indefinitely.
// 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
Expand Down

0 comments on commit 32745a7

Please sign in to comment.