Module: OpenTelemetry::Instrumentation::Bunny::PatchHelpers

Defined in:
lib/opentelemetry/instrumentation/bunny/patch_helpers.rb

Overview

The PatchHelper module provides functionality shared between patches.

For additional details around trace messaging semantics See https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#messaging-attributes

Class Method Summary collapse

Class Method Details

.basic_attributes(channel, transport, exchange, routing_key) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 67

def self.basic_attributes(channel, transport, exchange, routing_key)
  attributes = {
    'messaging.system' => 'rabbitmq',
    'messaging.destination' => exchange,
    'messaging.destination_kind' => destination_kind(channel, exchange),
    'messaging.protocol' => 'AMQP',
    'messaging.protocol_version' => ::Bunny.protocol_version,
    'net.peer.name' => transport.host,
    'net.peer.port' => transport.port
  }
  attributes['messaging.rabbitmq.routing_key'] = routing_key if routing_key
  attributes
end

.destination_kind(channel, exchange) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 81

def self.destination_kind(channel, exchange)
  # The default exchange with no name is always a direct exchange
  # https://github.com/ruby-amqp/bunny/blob/master/lib/bunny/exchange.rb#L33
  return 'queue' if exchange == ''

  # All exchange types https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges
  # except direct exchanges are mapped to topic
  return 'queue' if channel.find_exchange(exchange)&.type == :direct

  'topic'
end

.destination_name(exchange, routing_key) ⇒ Object 



31
32
33
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 31

def self.destination_name(exchange, routing_key)
  [exchange, routing_key].compact.join('.')
end

.extract_context(properties) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 35

def self.extract_context(properties)
  # use the receive span as parent context
  parent_context = OpenTelemetry.propagation.extract(properties[:tracer_receive_headers])
  return [parent_context, nil] if properties[:headers].nil?

  # link to the producer context
  producer_context = OpenTelemetry.propagation.extract(properties[:headers])
  producer_span_context = OpenTelemetry::Trace.current_span(producer_context).context
  links = [OpenTelemetry::Trace::Link.new(producer_span_context)] if producer_span_context.valid?

  [parent_context, links]
end

.inject_context_into_property(properties, key) ⇒ Object 



48
49
50
51
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 48

def self.inject_context_into_property(properties, key)
  properties[key] ||= {}
  OpenTelemetry.propagation.inject(properties[key])
end

.trace_enrich_receive_span(span, channel, delivery_info, properties) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 53

def self.trace_enrich_receive_span(span, channel, delivery_info, properties)
  exchange = delivery_info.exchange
  routing_key = delivery_info.routing_key
  destination = OpenTelemetry::Instrumentation::Bunny::PatchHelpers.destination_name(exchange, routing_key)
  destination_kind = OpenTelemetry::Instrumentation::Bunny::PatchHelpers.destination_kind(channel, exchange)
  span.name = "#{destination} receive"
  span['messaging.destination'] = exchange
  span['messaging.destination_kind'] = destination_kind
  span['messaging.rabbitmq.routing_key'] = routing_key if routing_key
  span['messaging.operation'] = 'receive'

  inject_context_into_property(properties, :tracer_receive_headers)
end

.with_process_span(channel, tracer, delivery_info, properties, &block) ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 22

def self.with_process_span(channel, tracer, delivery_info, properties, &block)
  destination = destination_name(delivery_info[:exchange], delivery_info[:routing_key])
  parent_context, links = extract_context(properties)

  OpenTelemetry::Context.with_current(parent_context) do
    tracer.in_span("#{destination} process", links: links, kind: :consumer, &block)
  end
end

.with_send_span(channel, tracer, exchange, routing_key, &block) ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/opentelemetry/instrumentation/bunny/patch_helpers.rb', line 15

def self.with_send_span(channel, tracer, exchange, routing_key, &block)
  attributes = basic_attributes(channel, channel.connection, exchange, routing_key)
  destination = destination_name(exchange, routing_key)

  tracer.in_span("#{destination} publish", attributes: attributes, kind: :producer, &block)
end