Class: OpenTelemetry::Instrumentation::Excon::Middlewares::TracerMiddleware

Inherits:
Excon::Middleware::Base
  • Object
show all
Defined in:
lib/opentelemetry/instrumentation/excon/middlewares/tracer_middleware.rb

Overview

Excon middleware for instrumentation

Constant Summary collapse

HTTP_METHODS_SYMBOL_TO_STRING =
{
  connect: 'CONNECT',
  delete: 'DELETE',
  get: 'GET',
  head: 'HEAD',
  options: 'OPTIONS',
  patch: 'PATCH',
  post: 'POST',
  put: 'PUT',
  trace: 'TRACE'
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.around_default_stackObject

Returns a copy of the default stack with the trace middleware injected



65
66
67
68
69
70
71
72
73
74
75
# File 'lib/opentelemetry/instrumentation/excon/middlewares/tracer_middleware.rb', line 65

def self.around_default_stack
  ::Excon.defaults[:middlewares].dup.tap do |default_stack|
    # If the default stack contains a version of the trace middleware already...
    existing_trace_middleware = default_stack.find { |m| m <= TracerMiddleware }
    default_stack.delete(existing_trace_middleware) if existing_trace_middleware

    # Inject after the ResponseParser middleware
    response_middleware_index = default_stack.index(::Excon::Middleware::ResponseParser).to_i
    default_stack.insert(response_middleware_index + 1, self)
  end
end

Instance Method Details

#error_call(datum) ⇒ Object



59
60
61
62
# File 'lib/opentelemetry/instrumentation/excon/middlewares/tracer_middleware.rb', line 59

def error_call(datum)
  handle_response(datum)
  @stack.error_call(datum)
end

#request_call(datum) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/MethodLength



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/opentelemetry/instrumentation/excon/middlewares/tracer_middleware.rb', line 25

def request_call(datum) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  begin
    unless datum.key?(:otel_span)
      http_method = HTTP_METHODS_SYMBOL_TO_STRING[datum[:method]]

      tracer.start_span(
        "HTTP #{http_method}",
        attributes: {
          'http.host' => datum[:host],
          'http.method' => http_method,
          'http.scheme' => datum[:scheme],
          'http.target' => datum[:path]
        },
        kind: :client
      ).tap do |span|
        datum[:otel_span] = span
        OpenTelemetry::Trace.with_span(span) do
          OpenTelemetry.propagation.http.inject(datum[:headers])
        end
      end
    end
  rescue StandardError => e
    OpenTelemetry.logger.debug(e.message)
  end

  @stack.request_call(datum)
end

#response_call(datum) ⇒ Object



53
54
55
56
57
# File 'lib/opentelemetry/instrumentation/excon/middlewares/tracer_middleware.rb', line 53

def response_call(datum)
  @stack.response_call(datum).tap do |d|
    handle_response(d)
  end
end