Module: Oboe::Inst::HTTPClient

Defined in:
lib/oboe/inst/httpclient.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



7
8
9
10
11
 
# File 'lib/oboe/inst/httpclient.rb', line 7

def self.included(klass)
  ::Oboe::Util.method_alias(klass, :do_request, ::HTTPClient)
  ::Oboe::Util.method_alias(klass, :do_request_async, ::HTTPClient)
  ::Oboe::Util.method_alias(klass, :do_get_stream, ::HTTPClient)
end

Instance Method Details

#do_get_stream_with_oboe(req, proxy, conn) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oboe/inst/httpclient.rb', line 105

def do_get_stream_with_oboe(req, proxy, conn)
  unless req.headers.key?("oboe.context")
    return do_get_stream_without_oboe(req, proxy, conn)
  end

  # Pickup context and delete the headers stowaway
  Oboe::Context.fromString req.headers["oboe.context"]
  req.header.delete "oboe.context"

  begin
    response = nil
    response_context = nil
    uri = req.http_header.request_uri
    method = req.http_header.request_method

    # Avoid cross host tracing for blacklisted domains
    blacklisted = Oboe::API.blacklisted?(uri.hostname)

    kvs = oboe_collect(method, uri)
    kvs['Blacklisted'] = true if blacklisted
    kvs['Async'] = 1

    Oboe::API.log_entry('httpclient', kvs)
    kvs.clear

    req_context = Oboe::Context.toString()
    req.header.add('X-Trace', req_context)

    # The core httpclient call
    result = do_get_stream_without_oboe(req, proxy, conn)

    # Older HTTPClient < 2.6.0 returns HTTPClient::Connection
    if result.is_a?(::HTTP::Message)
      response = result
    else
      response = conn.pop
    end

    response_context = response.headers['X-Trace']
    kvs['HTTPStatus'] = response.status_code

    # If we get a redirect, report the location header
    if ((300..308).to_a.include? response.status.to_i) && response.headers.key?("Location")
      kvs["Location"] = response.headers["Location"]
    end

    if response_context && !blacklisted
      Oboe::XTrace.continue_service_context(req_context, response_context)
    end

    # Older HTTPClient < 2.6.0 returns HTTPClient::Connection
    conn.push response if result.is_a?(::HTTPClient::Connection)
    result
  rescue => e
    Oboe::API.log_exception('httpclient', e)
    raise e
  ensure
    # Oboe::API.log_exit('httpclient', kvs.merge('Async' => 1))
    Oboe::API.log_exit('httpclient', kvs)
  end
end

#do_request_async_with_oboe(method, uri, query, body, header) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oboe/inst/httpclient.rb', line 89

def do_request_async_with_oboe(method, uri, query, body, header)
  if Oboe.tracing?
    # Since async is done by calling Thread.new { .. }, we somehow
    # have to pass the tracing context into that new thread.  Here
    # we stowaway the context in the request headers to be picked up
    # (and removed from req headers) in do_get_stream.
    if header.is_a?(Array)
      header.push ["oboe.context", Oboe::Context.toString]
    elsif header.is_a?(Hash)
      header['oboe.context'] = Oboe::Context.toString
    end
  end

  do_request_async_without_oboe(method, uri, query, body, header)
end

#do_request_with_oboe(method, uri, query, body, header, &block) ⇒ Object 



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
87
 
# File 'lib/oboe/inst/httpclient.rb', line 38

def do_request_with_oboe(method, uri, query, body, header, &block)
  # If we're not tracing, just do a fast return.
  if !Oboe.tracing?
    return request_without_oboe(method, uri, query, body, header, &block)
  end

  begin
    response_context = nil

    # Avoid cross host tracing for blacklisted domains
    blacklisted = Oboe::API.blacklisted?(uri.hostname)

    kvs = oboe_collect(method, uri, query)
    kvs['Blacklisted'] = true if blacklisted

    Oboe::API.log_entry('httpclient', kvs)
    kvs.clear

    req_context = Oboe::Context.toString()

    # Be aware of various ways to call/use httpclient
    if header.is_a?(Array)
      header.push ["X-Trace", req_context]
    elsif header.is_a?(Hash)
      header['X-Trace'] = req_context unless blacklisted
    end

    # The core httpclient call
    response = do_request_without_oboe(method, uri, query, body, header, &block)

    response_context = response.headers['X-Trace']
    kvs['HTTPStatus'] = response.status_code

    # If we get a redirect, report the location header
    if ((300..308).to_a.include? response.status.to_i) && response.headers.key?("Location")
      kvs["Location"] = response.headers["Location"]
    end

    if response_context && !blacklisted
      Oboe::XTrace.continue_service_context(req_context, response_context)
    end

    response
  rescue => e
    Oboe::API.log_exception('httpclient', e)
    raise e
  ensure
    Oboe::API.log_exit('httpclient', kvs)
  end
end

#oboe_collect(method, uri, query = nil) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/oboe/inst/httpclient.rb', line 13

def oboe_collect(method, uri, query = nil)
  kvs = {}
  kvs['IsService'] = 1

  # Conditionally log URL query params
  # Because of the hook points, the query arg can come in under <tt>query</tt>
  # or as a part of <tt>uri</tt> (not both).  Here we handle both cases.
  if Oboe::Config[:httpclient][:log_args]
    if query
      kvs['RemoteURL'] = uri.to_s + '?' + Oboe::Util.to_query(query)
    else
      kvs['RemoteURL'] = uri.to_s
    end
  else
    kvs['RemoteURL'] = uri.to_s.split('?').first
  end

  kvs['HTTPMethod'] = ::Oboe::Util.upcase(method)
  kvs['Backtrace'] = Oboe::API.backtrace if Oboe::Config[:httpclient][:collect_backtraces]
  kvs
rescue => e
  Oboe.logger.debug "[oboe/debug] Error capturing httpclient KVs: #{e.message}"
  Oboe.logger.debug e.backtrace.join('\n') if ::Oboe::Config[:verbose]
end