Module: OpenTelemetry::Propagator::XRay

Extended by:
XRay
Included in:
XRay
Defined in:
lib/opentelemetry/propagator/xray/text_map_propagator.rb,
lib/opentelemetry/propagator/xray/version.rb,
lib/opentelemetry/propagator/xray/id_generator.rb,
lib/opentelemetry/propagator/xray/lambda_text_map_propagator.rb,
lib/opentelemetry/propagator/xray.rb

Overview

Namespace for OpenTelemetry XRay propagation

Defined Under Namespace

Modules: IDGenerator Classes: LambdaTextMapPropagator, TextMapPropagator

Constant Summary collapse

VERSION =
'0.24.0'

Instance Method Summary collapse

Instance Method Details

#context_with_debug(context) ⇒ Object

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 context with the xray debug flag enabled



31
32
33
# File 'lib/opentelemetry/propagator/xray.rb', line 31

def context_with_debug(context)
  context.set_value(DEBUG_CONTEXT_KEY, true)
end

#debug?(context) ⇒ 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.

Read the XRay debug flag from the provided context

Returns:

  • (Boolean)


37
38
39
# File 'lib/opentelemetry/propagator/xray.rb', line 37

def debug?(context)
  !context.value(DEBUG_CONTEXT_KEY).nil?
end

#lambda_text_map_propagatorObject

Returns a text map propagator that propagates context in the XRay format with special handling for Lambda environment.



49
50
51
# File 'lib/opentelemetry/propagator/xray.rb', line 49

def lambda_text_map_propagator
  LAMBDA_TEXT_MAP_PROPAGATOR
end

#text_map_propagatorObject

Returns a text map propagator that propagates context in the XRay format.



43
44
45
# File 'lib/opentelemetry/propagator/xray.rb', line 43

def text_map_propagator
  TEXT_MAP_PROPAGATOR
end