Module: Datadog::Tracing::Pipeline

Defined in:

lib/datadog/tracing/pipeline.rb,
lib/datadog/tracing/pipeline/span_filter.rb,
lib/datadog/tracing/pipeline/span_processor.rb,
sig/datadog/tracing/pipeline.rbs,
sig/datadog/tracing/pipeline/span_filter.rbs,
sig/datadog/tracing/pipeline/span_processor.rbs

Overview

Modifies traces through a set of filters and processors

Defined Under Namespace

Classes: SpanFilter, SpanProcessor

Class Method Summary

• .before_flush(*processors, &processor_block) ⇒ void
• .process!(traces) ⇒ Object
• .processors=(value) ⇒ Object

Class Method Details

.before_flush(*processors) ⇒ void .before_flush {|trace| ... } ⇒ void

This method returns an undefined value.

Overloads:

• .before_flush(*processors) ⇒ void

  Parameters:

  • processors (Array<Datadog::Tracing::Pipeline::SpanProcessor>) —

    a list of processors that can modify or filter the trace.

  • processors (Array<#call(Datadog::Tracing::TraceSegment)>) —

    a list of callable objects that receive a TraceSegment and can modify or filter the trace.

• .before_flush {|trace| ... } ⇒ void

  Yields:

  • Receive a TraceSegment and can modify or filter the trace.

  Yield Parameters:

  • trace (Datadog::Tracing::TraceSegment) —

    trace object that can be modified or filtered.

  Yield Returns:

  • (Datadog::Tracing::TraceSegment) —

    the trace object that will be passed to the next processor. Normally the same trace parameter object should be returned.

Parameters:

• processors (Object)

See Also:

• Configuring the transport layer

# File 'lib/datadog/tracing/pipeline.rb', line 25

def self.before_flush(*processors, &processor_block)
  processors << processor_block if processor_block

  @mutex.synchronize do
    @processors.concat(processors)
  end
end

.process!(traces) ⇒ Object

Parameters:

• traces (Object)

Returns:

• (Object)

# File 'lib/datadog/tracing/pipeline.rb', line 33

def self.process!(traces)
  @mutex.synchronize do
    traces
      .map { |trace| apply_processors!(trace) }
      .compact
  end
end

.processors=(value) ⇒ Object

Parameters:

• value (Object)

Returns:

• (Object)

# File 'lib/datadog/tracing/pipeline.rb', line 41

def self.processors=(value)
  @processors = value
end