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_TO_UPPERCASE = 
%w[connect delete get head options patch post put trace].each_with_object({}) do |method, hash|
  uppercase_method = method.upcase
  hash[method] = uppercase_method
  hash[method.to_sym] = uppercase_method
  hash[uppercase_method] = uppercase_method
end.freeze
HTTP_METHODS_TO_SPAN_NAMES = 
HTTP_METHODS_TO_UPPERCASE.values.each_with_object({}) do |uppercase_method, hash|
  hash[uppercase_method] ||= "HTTP #{uppercase_method}"
end.freeze
HTTP_STATUS_SUCCESS_RANGE =

Constant for the HTTP status range

(100..399)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.around_default_stack ⇒ Object

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



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

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 



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

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

#request_call(datum) ⇒ Object 



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

def request_call(datum)
  return @stack.request_call(datum) if untraced?(datum)

  http_method = HTTP_METHODS_TO_UPPERCASE[datum[:method]]
  attributes = {
    OpenTelemetry::SemanticConventions::Trace::HTTP_HOST => datum[:host],
    OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => http_method,
    OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => datum[:scheme],
    OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => datum[:path],
    OpenTelemetry::SemanticConventions::Trace::HTTP_URL => OpenTelemetry::Common::Utilities.cleanse_url(::Excon::Utils.request_uri(datum)),
    OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => datum[:hostname],
    OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => datum[:port]
  }
  peer_service = Excon::Instrumentation.instance.config[:peer_service]
  attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = peer_service if peer_service
  attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
  span = tracer.start_span(HTTP_METHODS_TO_SPAN_NAMES[http_method], attributes: attributes, kind: :client)
  ctx = OpenTelemetry::Trace.context_with_span(span)
  datum[:otel_span] = span
  datum[:otel_token] = OpenTelemetry::Context.attach(ctx)
  OpenTelemetry.propagation.inject(datum[:headers])
  @stack.request_call(datum)
end

#response_call(datum) ⇒ Object 



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

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