Class: OpenTelemetry::SDK::Trace::Samplers::TraceIdRatioBased Private

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

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Implements sampling based on a probability.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(probability) ⇒ TraceIdRatioBased

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of TraceIdRatioBased.



17
18
19
20
21
# File 'lib/opentelemetry/sdk/trace/samplers/trace_id_ratio_based.rb', line 17

def initialize(probability)
  @probability = probability
  @id_upper_bound = (probability * (2**64 - 1)).ceil
  @description = format('TraceIdRatioBased{%.6f}', probability)
end

Instance Attribute Details

#descriptionObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



15
16
17
# File 'lib/opentelemetry/sdk/trace/samplers/trace_id_ratio_based.rb', line 15

def description
  @description
end

Instance Method Details

#should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See OpenTelemetry::SDK::Trace::Samplers.

Returns:

  • (Boolean)


26
27
28
29
30
31
32
33
34
# File 'lib/opentelemetry/sdk/trace/samplers/trace_id_ratio_based.rb', line 26

def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
  # Ignored for sampling decision: parent_context:, links, name, kind, attributes.

  if sample?(trace_id)
    RECORD_AND_SAMPLE
  else
    DROP
  end
end