Module: Net::Http::Instrumentation

Defined in:
lib/net/http/instrumentation.rb,
lib/net/http/instrumentation/version.rb

Constant Summary collapse

VERSION = 
"0.2.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.ignore_request ⇒ Object

Returns the value of attribute ignore_request.



10
11
12
 
# File 'lib/net/http/instrumentation.rb', line 10

def ignore_request
  @ignore_request
end

.status_codes ⇒ Object

Returns the value of attribute status_codes.



10
11
12
 
# File 'lib/net/http/instrumentation.rb', line 10

def status_codes
  @status_codes
end

.tracer ⇒ Object

Returns the value of attribute tracer.



10
11
12
 
# File 'lib/net/http/instrumentation.rb', line 10

def tracer
  @tracer
end

Class Method Details

.instrument(tracer: OpenTracing.global_tracer, ignore_request: nil, status_code_errors: [ ::Net::HTTPServerError ]) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/net/http/instrumentation.rb', line 12

def instrument(tracer: OpenTracing.global_tracer,
               ignore_request: nil,
               status_code_errors: [ ::Net::HTTPServerError ])
  @ignore_request = ignore_request
  @tracer = tracer
  @status_codes = status_code_errors

  patch_request if !@instrumented
  @instrumented = true
end

.patch_request ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/net/http/instrumentation.rb', line 35

def patch_request

  ::Net::HTTP.module_eval do
    alias_method :request_original, :request

    def request(req, body = nil, &block)
      res = ''

      if ::Net::Http::Instrumentation.ignore_request.respond_to?(:call) &&
         ::Net::Http::Instrumentation.ignore_request.call

        res = request_original(req, body, &block)
      else
        if req.uri
          url = req.uri.to_s 
        else
          if @address
            uri = URI(@address)
            if uri.relative?
              url = @address + req.path
            else
              url = (uri + req.path).to_s
            end
          else
            url = req.path
          end
        end
        tags = {
          "component" => "Net::HTTP",
          "span.kind" => "client",
          "http.method" => req.method,
          "http.url" => url,
          "peer.host" => @address,
          "peer.port" => @port,
        }
        ::Net::Http::Instrumentation.tracer.start_active_span("net_http.request", tags: tags) do |scope|
          # inject the trace so it's available to the remote service
          OpenTracing.inject(scope.span.context, OpenTracing::FORMAT_RACK, req)

          # call the original request method
          res = request_original(req, body, &block)

          # set response code and error if applicable
          scope.span.set_tag("http.status_code", res.code)
          scope.span.set_tag("error", true) if ::Net::Http::Instrumentation.status_codes.any? { |e| res.is_a? e }
        end
      end

      res
    end
  end
end

.remove ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/net/http/instrumentation.rb', line 23

def remove
  return if !@instrumented

  ::Net::HTTP.module_eval do
    remove_method :request
    alias_method :request, :request_original
    remove_method :request_original
  end

  @instrumented = false
end