Class: OpenTelemetry::SDK::Trace::Samplers::Result

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

Overview

The Result class represents an arbitrary sampling result. It has boolean values for the sampling decision and whether to record events, and a collection of attributes to be attached to a sampled root span.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(decision:, attributes: nil) ⇒ Result

Returns a new sampling result with the specified decision and attributes.

Parameters:

  • decision (Symbol) —

    Whether or not a span should be sampled and/or record events.

  • attributes (optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}) (defaults to: nil) —

    A frozen or freezable hash containing attributes to be attached to the span.



33
34
35
36
 
# File 'lib/opentelemetry/sdk/trace/samplers/result.rb', line 33

def initialize(decision:, attributes: nil)
  @decision = decision
  @attributes = attributes.freeze || EMPTY_HASH
end

Instance Attribute Details

#attributes ⇒ Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>} (readonly)

Returns a frozen hash of attributes to be attached span.

Returns:

  • (Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}) 


23
24
25
 
# File 'lib/opentelemetry/sdk/trace/samplers/result.rb', line 23

def attributes
  @attributes
end

Instance Method Details

#recording? ⇒ Boolean

Returns true if this span should record events, attributes, status, etc.

Returns:

  • (Boolean) —

    recording decision



48
49
50
 
# File 'lib/opentelemetry/sdk/trace/samplers/result.rb', line 48

def recording?
  @decision != Decision::DROP
end

#sampled? ⇒ Boolean

Returns true if this span should be sampled.

Returns:

  • (Boolean) —

    sampling decision



41
42
43
 
# File 'lib/opentelemetry/sdk/trace/samplers/result.rb', line 41

def sampled?
  @decision == Decision::RECORD_AND_SAMPLE
end