oboe 2.7.16.1 → 2.7.17.1

data/lib/oboe/version.rb

@@ -8,7 +8,7 @@ module Oboe
   module Version
     MAJOR = 2
     MINOR = 7
-    PATCH = 16
+    PATCH = 17
     BUILD = 1
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -1,9 +1,6 @@
 # AppNeta TraceView Initializer (the oboe gem)
 # http://www.appneta.com/products/traceview/
 #
-# Details on configuring your sample rate:
-# https://support.appneta.com/cloud/configuring-sampling
-#
 # More information on instrumenting Ruby applications can be found here:
 # https://support.appneta.com/cloud/installing-ruby-instrumentation
 
@@ -15,12 +12,36 @@ if defined?(Oboe::Config)
   # order to initiate tracing from Ruby.
   Oboe::Config[:tracing_mode] = '<%= @tracing_mode %>'
 
-  # sample_rate is a value from 0 - 1m indicating the fraction of requests per million to trace
-  # Oboe::Config[:sample_rate] = <%= @sample_rate %>
-
   # Verbose output of instrumentation initialization
   # Oboe::Config[:verbose] = <%= @verbose %>
 
+  # Logging of outgoing HTTP query args
+  #
+  # This optionally disables the logging of query args of outgoing
+  # HTTP clients such as Net::HTTP, excon, typhoeus and others.
+  #
+  # This flag is global to all HTTP client instrumentation.
+  #
+  # To configure this on a per instrumentation basis, set this
+  # option to true and instead disable the instrumenstation specific
+  # option <tt>log_args</tt>:
+  #
+  #   Oboe::Config[:nethttp][:log_args] = false
+  #   Oboe::Config[:excon][:log_args] = false
+  #   Oboe::Config[:typhoeus][:log_args] = true
+  #
+  Oboe::Config[:include_url_query_params] = true
+
+  # Logging of incoming HTTP query args
+  #
+  # This optionally disables the logging of incoming URL request
+  # query args.
+  #
+  # This flag is global and currently only affects the Rack
+  # instrumentation which reports incoming request URLs and
+  # query args by default.
+  Oboe::Config[:include_remote_url_params] = true
+
   # The oboe Ruby client has the ability to sanitize query literals
   # from SQL statements.  By default this is disabled.  Enable to
   # avoid collecting and reporting query literals to TraceView.
@@ -77,8 +98,10 @@ if defined?(Oboe::Config)
   # Oboe::Config[:action_view][:enabled] = true
   # Oboe::Config[:cassandra][:enabled] = true
   # Oboe::Config[:dalli][:enabled] = true
+  # Oboe::Config[:excon][:enabled] = true
   # Oboe::Config[:em_http_request][:enabled] = true
   # Oboe::Config[:faraday][:enabled] = true
+  # Oboe::Config[:httpclient][:enabled] = true
   # Oboe::Config[:memcache][:enabled] = true
   # Oboe::Config[:memcached][:enabled] = true
   # Oboe::Config[:mongo][:enabled] = true
@@ -86,6 +109,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:enabled] = true
   # Oboe::Config[:redis][:enabled] = true
   # Oboe::Config[:resque][:enabled] = true
+  # Oboe::Config[:rest_client][:enabled] = true
   # Oboe::Config[:sequel][:enabled] = true
   # Oboe::Config[:typhoeus][:enabled] = true
   #
@@ -103,8 +127,10 @@ if defined?(Oboe::Config)
   # Oboe::Config[:action_view][:collect_backtraces] = true
   # Oboe::Config[:cassandra][:collect_backtraces] = true
   # Oboe::Config[:dalli][:collect_backtraces] = false
+  # Oboe::Config[:excon][:collect_backtraces] = false
   # Oboe::Config[:em_http_request][:collect_backtraces] = true
   # Oboe::Config[:faraday][:collect_backtraces] = false
+  # Oboe::Config[:httpclient][:collect_backtraces] = false
   # Oboe::Config[:memcache][:collect_backtraces] = false
   # Oboe::Config[:memcached][:collect_backtraces] = false
   # Oboe::Config[:mongo][:collect_backtraces] = true
@@ -112,19 +138,11 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:collect_backtraces] = true
   # Oboe::Config[:redis][:collect_backtraces] = false
   # Oboe::Config[:resque][:collect_backtraces] = true
+  # Oboe::Config[:rest_client][:collect_backtraces] = true
   # Oboe::Config[:sequel][:collect_backtraces] = true
   # Oboe::Config[:typhoeus][:collect_backtraces] = false
   #
 
-  #
-  # Blacklist actions
-  #
-  # e.g. if your load balancer requests 'index#ok'
-  #
-  #   Oboe::Config[:action_blacklist] = {
-  #     'index#ok' => true
-  # }
-
   #
   # Resque Options
   #

data/test/instrumentation/excon_test.rb

@@ -51,23 +51,24 @@ class ExconTest < Minitest::Test
     clear_all_traces
 
     Oboe::API.start_trace('excon_tests') do
-      response = Excon.get('http://www.gameface.in/gamers')
+      response = Excon.get('http://127.0.0.1:8101/?blah=1')
       xtrace = response.headers['X-Trace']
       assert xtrace
       assert Oboe::XTrace.valid?(xtrace)
     end
 
     traces = get_all_traces
-    assert_equal traces.count, 4
+    assert_equal traces.count, 7
     validate_outer_layers(traces, "excon_tests")
+    valid_edges?(traces)
 
     assert_equal traces[1]['IsService'], 1
-    assert_equal traces[1]['RemoteHost'], 'www.gameface.in'
+    assert_equal traces[1]['RemoteHost'], '127.0.0.1'
     assert_equal traces[1]['RemoteProtocol'], 'HTTP'
-    assert_equal traces[1]['ServiceArg'], '/gamers'
+    assert_equal traces[1]['ServiceArg'], '/?blah=1'
     assert_equal traces[1]['HTTPMethod'], 'GET'
     assert traces[1].key?('Backtrace')
-    assert_equal traces[2]['HTTPStatus'], 200
+    assert_equal traces[5]['HTTPStatus'], 200
   end
 
   def test_persistent_requests
@@ -77,39 +78,40 @@ class ExconTest < Minitest::Test
     clear_all_traces
 
     Oboe::API.start_trace('excon_tests') do
-      connection = Excon.new('http://www.gameface.in/') # non-persistent by default
+      connection = Excon.new('http://127.0.0.1:8101/') # non-persistent by default
       connection.get # socket established, then closed
       connection.get(:persistent => true) # socket established, left open
       connection.get # socket reused, then closed
     end
 
     traces = get_all_traces
-    assert_equal traces.count, 8
+    assert_equal traces.count, 17
     validate_outer_layers(traces, "excon_tests")
+    valid_edges?(traces)
 
     assert_equal traces[1]['IsService'], 1
-    assert_equal traces[1]['RemoteHost'], 'www.gameface.in'
+    assert_equal traces[1]['RemoteHost'], '127.0.0.1'
     assert_equal traces[1]['RemoteProtocol'], 'HTTP'
     assert_equal traces[1]['ServiceArg'], '/'
     assert_equal traces[1]['HTTPMethod'], 'GET'
     assert traces[1].key?('Backtrace')
-    assert_equal traces[2]['HTTPStatus'], 200
-
-    assert_equal traces[3]['IsService'], 1
-    assert_equal traces[3]['RemoteHost'], 'www.gameface.in'
-    assert_equal traces[3]['RemoteProtocol'], 'HTTP'
-    assert_equal traces[3]['ServiceArg'], '/'
-    assert_equal traces[3]['HTTPMethod'], 'GET'
-    assert traces[3].key?('Backtrace')
-    assert_equal traces[4]['HTTPStatus'], 200
-
-    assert_equal traces[5]['IsService'], 1
-    assert_equal traces[5]['RemoteHost'], 'www.gameface.in'
-    assert_equal traces[5]['RemoteProtocol'], 'HTTP'
-    assert_equal traces[5]['ServiceArg'], '/'
-    assert_equal traces[5]['HTTPMethod'], 'GET'
-    assert traces[5].key?('Backtrace')
-    assert_equal traces[6]['HTTPStatus'], 200
+    assert_equal traces[5]['HTTPStatus'], 200
+
+    assert_equal traces[6]['IsService'], 1
+    assert_equal traces[6]['RemoteHost'], '127.0.0.1'
+    assert_equal traces[6]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[6]['ServiceArg'], '/'
+    assert_equal traces[6]['HTTPMethod'], 'GET'
+    assert traces[6].key?('Backtrace')
+    assert_equal traces[10]['HTTPStatus'], 200
+
+    assert_equal traces[11]['IsService'], 1
+    assert_equal traces[11]['RemoteHost'], '127.0.0.1'
+    assert_equal traces[11]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[11]['ServiceArg'], '/'
+    assert_equal traces[11]['HTTPMethod'], 'GET'
+    assert traces[11].key?('Backtrace')
+    assert_equal traces[15]['HTTPStatus'], 200
   end
 
   def test_pipelined_requests
@@ -118,17 +120,17 @@ class ExconTest < Minitest::Test
     clear_all_traces
 
     Oboe::API.start_trace('excon_tests') do
-      connection = Excon.new('http://www.gameface.in/')
+      connection = Excon.new('http://127.0.0.1:8101/')
       connection.requests([{:method => :get}, {:method => :put}])
     end
 
     traces = get_all_traces
-    assert_equal traces.count, 4
+    assert_equal traces.count, 10
     validate_outer_layers(traces, "excon_tests")
     valid_edges?(traces)
 
     assert_equal traces[1]['IsService'], 1
-    assert_equal traces[1]['RemoteHost'], 'www.gameface.in'
+    assert_equal traces[1]['RemoteHost'], '127.0.0.1'
     assert_equal traces[1]['RemoteProtocol'], 'HTTP'
     assert_equal traces[1]['ServiceArg'], '/'
     assert_equal traces[1]['Pipeline'], 'true'
@@ -141,7 +143,7 @@ class ExconTest < Minitest::Test
 
     begin
       Oboe::API.start_trace('excon_tests') do
-        connection = Excon.get('http://asfjalkfjlajfljkaljf/')
+        Excon.get('http://asfjalkfjlajfljkaljf/')
       end
     rescue
     end
@@ -149,6 +151,7 @@ class ExconTest < Minitest::Test
     traces = get_all_traces
     assert_equal traces.count, 5
     validate_outer_layers(traces, "excon_tests")
+    valid_edges?(traces)
 
     assert_equal traces[1]['IsService'], 1
     assert_equal traces[1]['RemoteHost'], 'asfjalkfjlajfljkaljf'
@@ -166,5 +169,39 @@ class ExconTest < Minitest::Test
     assert_equal traces[3]['Layer'], 'excon'
     assert_equal traces[3]['Label'], 'exit'
   end
+
+  def test_obey_log_args_when_false
+    @log_args = Oboe::Config[:excon][:log_args]
+    clear_all_traces
+
+    Oboe::Config[:excon][:log_args] = false
+
+    Oboe::API.start_trace('excon_tests') do
+      Excon.get('http://127.0.0.1:8101/?blah=1')
+    end
+
+    traces = get_all_traces
+    assert_equal traces.count, 7
+    assert_equal traces[1]['ServiceArg'], '/'
+
+    Oboe::Config[:excon][:log_args] = @log_args
+  end
+
+  def test_obey_log_args_when_true
+    @log_args = Oboe::Config[:excon][:log_args]
+    clear_all_traces
+
+    Oboe::Config[:excon][:log_args] = true
+
+    Oboe::API.start_trace('excon_tests') do
+      Excon.get('http://127.0.0.1:8101/?blah=1')
+    end
+
+    traces = get_all_traces
+    assert_equal traces.count, 7
+    assert_equal traces[1]['ServiceArg'], '/?blah=1'
+
+    Oboe::Config[:excon][:log_args] = @log_args
+  end
 end
 

data/test/instrumentation/faraday_test.rb

@@ -20,9 +20,9 @@ describe Oboe::Inst::FaradayConnection do
     end
   end
 
-  it "should trace a Faraday request to an instr'd app" do
+  it "should trace cross-app request" do
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.gameface.in') do |faraday|
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
       end
       response = conn.get '/games?q=1'
@@ -30,38 +30,38 @@ describe Oboe::Inst::FaradayConnection do
     end
 
     traces = get_all_traces
-    traces.count.must_equal 8
+    traces.count.must_equal 11
 
     validate_outer_layers(traces, 'faraday_test')
 
     traces[1]['Layer'].must_equal 'faraday'
     traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
 
-    traces[3]['Layer'].must_equal 'net-http'
-    traces[3]['IsService'].must_equal 1
-    traces[3]['RemoteProtocol'].must_equal 'HTTP'
-    traces[3]['RemoteHost'].must_equal 'www.gameface.in'
-    traces[3]['ServiceArg'].must_equal '/games?q=1'
-    traces[3]['HTTPMethod'].must_equal 'GET'
-    traces[3]['HTTPStatus'].must_equal '200'
+    traces[6]['Layer'].must_equal 'net-http'
+    traces[6]['IsService'].must_equal 1
+    traces[6]['RemoteProtocol'].must_equal 'HTTP'
+    traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+    traces[6]['ServiceArg'].must_equal '/games?q=1'
+    traces[6]['HTTPMethod'].must_equal 'GET'
+    traces[6]['HTTPStatus'].must_equal '200'
 
-    traces[4]['Layer'].must_equal 'net-http'
-    traces[4]['Label'].must_equal 'exit'
+    traces[7]['Layer'].must_equal 'net-http'
+    traces[7]['Label'].must_equal 'exit'
 
-    traces[6]['Layer'].must_equal 'faraday'
-    traces[6]['Label'].must_equal 'exit'
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[9]['Label'].must_equal 'exit'
   end
 
   it 'should trace a Faraday request' do
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.curlmyip.de') do |faraday|
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
       end
-      response = conn.get '/?q=ruby_test_suite'
+      conn.get '/?q=ruby_test_suite'
     end
 
     traces = get_all_traces
-    traces.count.must_equal 8
+    traces.count.must_equal 11
 
     valid_edges?(traces)
     validate_outer_layers(traces, 'faraday_test')
@@ -69,31 +69,32 @@ describe Oboe::Inst::FaradayConnection do
     traces[1]['Layer'].must_equal 'faraday'
     traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
 
-    traces[3]['Layer'].must_equal 'net-http'
-    traces[3]['IsService'].must_equal 1
-    traces[3]['RemoteProtocol'].must_equal 'HTTP'
-    traces[3]['RemoteHost'].must_equal 'www.curlmyip.de'
-    traces[3]['ServiceArg'].must_equal '/?q=ruby_test_suite'
-    traces[3]['HTTPMethod'].must_equal 'GET'
-    traces[3]['HTTPStatus'].must_equal '200'
+    traces[6]['Layer'].must_equal 'net-http'
+    traces[6]['Label'].must_equal 'info'
+    traces[6]['IsService'].must_equal 1
+    traces[6]['RemoteProtocol'].must_equal 'HTTP'
+    traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+    traces[6]['ServiceArg'].must_equal '/?q=ruby_test_suite'
+    traces[6]['HTTPMethod'].must_equal 'GET'
+    traces[6]['HTTPStatus'].must_equal '200'
 
-    traces[4]['Layer'].must_equal 'net-http'
-    traces[4]['Label'].must_equal 'exit'
+    traces[7]['Layer'].must_equal 'net-http'
+    traces[7]['Label'].must_equal 'exit'
 
-    traces[5]['Layer'].must_equal 'faraday'
-    traces[5]['Label'].must_equal 'info'
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[8]['Label'].must_equal 'info'
 
-    traces[6]['Layer'].must_equal 'faraday'
-    traces[6]['Label'].must_equal 'exit'
+    traces[9]['Layer'].must_equal 'faraday'
+    traces[9]['Label'].must_equal 'exit'
   end
 
-  it 'should trace a Faraday alternate request method' do
+  it 'should trace a Faraday class style request' do
     Oboe::API.start_trace('faraday_test') do
-      Faraday.get('http://www.curlmyip.de', {:a => 1})
+      Faraday.get('http://127.0.0.1:8101/', {:a => 1})
     end
 
     traces = get_all_traces
-    traces.count.must_equal 8
+    traces.count.must_equal 11
 
     valid_edges?(traces)
     validate_outer_layers(traces, 'faraday_test')
@@ -101,34 +102,35 @@ describe Oboe::Inst::FaradayConnection do
     traces[1]['Layer'].must_equal 'faraday'
     traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
 
-    traces[3]['Layer'].must_equal 'net-http'
-    traces[3]['IsService'].must_equal 1
-    traces[3]['RemoteProtocol'].must_equal 'HTTP'
-    traces[3]['RemoteHost'].must_equal 'www.curlmyip.de'
-    traces[3]['ServiceArg'].must_equal '/?a=1'
-    traces[3]['HTTPMethod'].must_equal 'GET'
-    traces[3]['HTTPStatus'].must_equal '200'
+    traces[6]['Layer'].must_equal 'net-http'
+    traces[6]['Label'].must_equal 'info'
+    traces[6]['IsService'].must_equal 1
+    traces[6]['RemoteProtocol'].must_equal 'HTTP'
+    traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+    traces[6]['ServiceArg'].must_equal '/?a=1'
+    traces[6]['HTTPMethod'].must_equal 'GET'
+    traces[6]['HTTPStatus'].must_equal '200'
 
-    traces[4]['Layer'].must_equal 'net-http'
-    traces[4]['Label'].must_equal 'exit'
+    traces[7]['Layer'].must_equal 'net-http'
+    traces[7]['Label'].must_equal 'exit'
 
-    traces[5]['Layer'].must_equal 'faraday'
-    traces[5]['Label'].must_equal 'info'
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[8]['Label'].must_equal 'info'
 
-    traces[6]['Layer'].must_equal 'faraday'
-    traces[6]['Label'].must_equal 'exit'
+    traces[9]['Layer'].must_equal 'faraday'
+    traces[9]['Label'].must_equal 'exit'
   end
 
-  it 'should trace a Faraday with an alternate adapter' do
+  it 'should trace a Faraday with the excon adapter' do
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.curlmyip.de') do |faraday|
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
         faraday.adapter :excon
       end
-      response = conn.get '/?q=1'
+      conn.get '/?q=1'
     end
 
     traces = get_all_traces
-    traces.count.must_equal 7
+    traces.count.must_equal 10
 
     valid_edges?(traces)
     validate_outer_layers(traces, 'faraday_test')
@@ -140,34 +142,77 @@ describe Oboe::Inst::FaradayConnection do
     traces[2]['Label'].must_equal 'entry'
     traces[2]['IsService'].must_equal 1
     traces[2]['RemoteProtocol'].must_equal 'HTTP'
-    traces[2]['RemoteHost'].must_equal 'www.curlmyip.de'
+    traces[2]['RemoteHost'].must_equal '127.0.0.1'
     traces[2]['ServiceArg'].must_equal '/?q=1'
     traces[2]['HTTPMethod'].must_equal 'GET'
 
-    traces[3]['Layer'].must_equal 'excon'
-    traces[3]['Label'].must_equal 'exit'
-    traces[3]['HTTPStatus'].must_equal 200
+    traces[6]['Layer'].must_equal 'excon'
+    traces[6]['Label'].must_equal 'exit'
+    traces[6]['HTTPStatus'].must_equal 200
+
+    traces[7]['Layer'].must_equal 'faraday'
+    traces[7]['Label'].must_equal 'info'
+    unless RUBY_VERSION < '1.9.3'
+      # FIXME: Ruby 1.8 is reporting an object instance instead of
+      # an array
+      traces[7]['Middleware'].must_equal '[Faraday::Adapter::Excon]'
+    end
+
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[8]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a Faraday with the httpclient adapter' do
+    skip "FIXME: once HTTPClient instrumentation is done"
+
+    Oboe::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
+        faraday.adapter :httpclient
+      end
+      conn.get '/?q=1'
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 10
+
+    valid_edges?(traces)
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
+
+    traces[2]['Layer'].must_equal 'excon'
+    traces[2]['Label'].must_equal 'entry'
+    traces[2]['IsService'].must_equal 1
+    traces[2]['RemoteProtocol'].must_equal 'HTTP'
+    traces[2]['RemoteHost'].must_equal '127.0.0.1'
+    traces[2]['ServiceArg'].must_equal '/?q=1'
+    traces[2]['HTTPMethod'].must_equal 'GET'
+
+    traces[6]['Layer'].must_equal 'excon'
+    traces[6]['Label'].must_equal 'exit'
+    traces[6]['HTTPStatus'].must_equal 200
 
-    traces[4]['Layer'].must_equal 'faraday'
-    traces[4]['Label'].must_equal 'info'
+    traces[7]['Layer'].must_equal 'faraday'
+    traces[7]['Label'].must_equal 'info'
     unless RUBY_VERSION < '1.9.3'
       # FIXME: Ruby 1.8 is reporting an object instance instead of
       # an array
-      traces[4]['Middleware'].must_equal '[Faraday::Adapter::Excon]'
+      traces[7]['Middleware'].must_equal '[Faraday::Adapter::Excon]'
     end
 
-    traces[5]['Layer'].must_equal 'faraday'
-    traces[5]['Label'].must_equal 'exit'
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[8]['Label'].must_equal 'exit'
   end
 
   it 'should obey :collect_backtraces setting when true' do
     Oboe::Config[:faraday][:collect_backtraces] = true
 
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
       end
-      response = conn.get '/?q=ruby_test_suite'
+      conn.get '/?q=ruby_test_suite'
     end
 
     traces = get_all_traces
@@ -178,10 +223,10 @@ describe Oboe::Inst::FaradayConnection do
     Oboe::Config[:faraday][:collect_backtraces] = false
 
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
       end
-      response = conn.get '/?q=ruby_test_suite'
+      conn.get '/?q=ruby_test_suite'
     end
 
     traces = get_all_traces