Class: OpenTelemetry::SDK::Trace::MultiSpanProcessor

Inherits:
Object
  • Object
show all
Defined in:
lib/opentelemetry/sdk/trace/multi_span_processor.rb

Overview

Implementation of the SpanProcessor duck type that simply forwards all received events to a list of SpanProcessors.

Instance Method Summary collapse

Constructor Details

#initialize(span_processors) ⇒ MultiSpanProcessor

Creates a new OpenTelemetry::SDK::Trace::MultiSpanProcessor.

Parameters:

  • span_processors (Enumerable<SpanProcessor>) —

    a collection of SpanProcessors.



18
19
20
 
# File 'lib/opentelemetry/sdk/trace/multi_span_processor.rb', line 18

def initialize(span_processors)
  @span_processors = span_processors.to_a.freeze
end

Instance Method Details

#force_flush(timeout: nil) ⇒ Integer

Export all ended spans to the configured Exporter that have not yet been exported.

This method should only be called in cases where it is absolutely necessary, such as when using some FaaS providers that may suspend the process after an invocation, but before the Processor exports the completed spans.

Parameters:

  • timeout (optional Numeric) (defaults to: nil) —

    An optional timeout in seconds.

Returns:

  • (Integer) —

    Export::SUCCESS if no error occurred, Export::FAILURE if a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/opentelemetry/sdk/trace/multi_span_processor.rb', line 57

def force_flush(timeout: nil)
  start_time = Time.now
  results = @span_processors.map do |processor|
    remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
    return Export::TIMEOUT if remaining_timeout&.zero?

    processor.force_flush(timeout: remaining_timeout)
  end
  results.uniq.max
end

#on_finish(span) ⇒ Object

Called when a Span is ended, if the Span#recording? returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Parameters:

  • span (Span) —

    the Span that just ended.



42
43
44
 
# File 'lib/opentelemetry/sdk/trace/multi_span_processor.rb', line 42

def on_finish(span)
  @span_processors.each { |processor| processor.on_finish(span) }
end

#on_start(span, parent_context) ⇒ Object

Called when a Span is started, if the Span#recording? returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Parameters:

  • span (Span) —

    the Span that just started.

  • parent_context (Context) —

    the parent Context of the newly started span.



31
32
33
 
# File 'lib/opentelemetry/sdk/trace/multi_span_processor.rb', line 31

def on_start(span, parent_context)
  @span_processors.each { |processor| processor.on_start(span, parent_context) }
end

#shutdown(timeout: nil) ⇒ Integer

Called when TracerProvider#shutdown is called.

Parameters:

  • timeout (optional Numeric) (defaults to: nil) —

    An optional timeout in seconds.

Returns:

  • (Integer) —

    Export::SUCCESS if no error occurred, Export::FAILURE if a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/opentelemetry/sdk/trace/multi_span_processor.rb', line 73

def shutdown(timeout: nil)
  start_time = Time.now
  results = @span_processors.map do |processor|
    remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
    return Export::TIMEOUT if remaining_timeout&.zero?

    processor.shutdown(timeout: remaining_timeout)
  end
  results.uniq.max
end