Class: ScoutApm::Instruments::HttpClient

Inherits:
Object
  • Object
show all
Defined in:
lib/scout_apm/instruments/http_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context) ⇒ HttpClient

Returns a new instance of HttpClient.



6
7
8
9
 
# File 'lib/scout_apm/instruments/http_client.rb', line 6

def initialize(context)
  @context = context
  @installed = false
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



4
5
6
 
# File 'lib/scout_apm/instruments/http_client.rb', line 4

def context
  @context
end

Instance Method Details

#install(prepend:) ⇒ Object 



28
29
30
31
32
33
34
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
 
# File 'lib/scout_apm/instruments/http_client.rb', line 28

def install(prepend:)
  require_library
  if defined?(::HTTPClient)
    @installed = true

    logger.info "Instrumenting HTTPClient. Prepend: #{prepend}"

    if prepend
      ::HTTPClient.send(:include, ScoutApm::Tracer)
      ::HTTPClient.send(:prepend, HttpClientInstrumentationPrepend)
    else
      ::HTTPClient.class_eval do
        include ScoutApm::Tracer

        def request_with_scout_instruments(*args, &block)

          method = args[0].to_s
          url = args[1]

          max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
          url = url && url.to_s[0..(max_length - 1)]

          self.class.instrument("HTTP", method, :desc => url) do
            request_without_scout_instruments(*args, &block)
          end
        end

        alias request_without_scout_instruments request
        alias request request_with_scout_instruments
      end
    end
  end
end

#installed? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/scout_apm/instruments/http_client.rb', line 15

def installed?
  @installed
end

#logger ⇒ Object 



11
12
13
 
# File 'lib/scout_apm/instruments/http_client.rb', line 11

def logger
  context.logger
end

#require_library ⇒ Object 



19
20
21
22
23
24
25
26
 
# File 'lib/scout_apm/instruments/http_client.rb', line 19

def require_library
  unless defined?(::HTTPClient)
    begin
      require 'httpclient'
    rescue LoadError
    end
  end
end