oboe 2.7.16.1 → 2.7.17.1

data/test/instrumentation/http_test.rb

@@ -5,10 +5,12 @@ describe Oboe::Inst do
   before do
     clear_all_traces
     @collect_backtraces = Oboe::Config[:nethttp][:collect_backtraces]
+    @log_args = Oboe::Config[:nethttp][:log_args]
   end
 
   after do
     Oboe::Config[:nethttp][:collect_backtraces] = @collect_backtraces
+    Oboe::Config[:nethttp][:log_args] = @log_args
   end
 
   it 'Net::HTTP should be defined and ready' do
@@ -23,7 +25,7 @@ describe Oboe::Inst do
 
   it "should trace a Net::HTTP request to an instr'd app" do
     Oboe::API.start_trace('net-http_test', '', {}) do
-      uri = URI('http://www.gameface.in/games?q=1')
+      uri = URI('http://127.0.0.1:8101/?q=1')
       http = Net::HTTP.new(uri.host, uri.port)
       request = Net::HTTP::Get.new(uri.request_uri)
       response = http.request(request)
@@ -32,52 +34,87 @@ describe Oboe::Inst do
     end
 
     traces = get_all_traces
-    traces.count.must_equal 5
-
-    # FIXME: We need to switch from making external calls to an internal test
-    # stack instead so we can validate cross-app traces.
-    # valid_edges?(traces).must_equal true
-
+    traces.count.must_equal 8
+    valid_edges?(traces).must_equal true
     validate_outer_layers(traces, 'net-http_test')
 
     traces[1]['Layer'].must_equal 'net-http'
-    traces[2]['IsService'].must_equal 1
-    traces[2]['RemoteProtocol'].must_equal "HTTP"
-    traces[2]['RemoteHost'].must_equal "www.gameface.in"
-    traces[2]['ServiceArg'].must_equal "/games?q=1"
-    traces[2]['HTTPMethod'].must_equal "GET"
-    traces[2]['HTTPStatus'].must_equal "200"
-    traces[2].has_key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+    traces[1]['Label'].must_equal 'entry'
+
+    traces[2]['Layer'].must_equal 'rack'
+    traces[2]['Label'].must_equal 'entry'
+
+    traces[3]['Layer'].must_equal 'rack'
+    traces[3]['Label'].must_equal 'info'
+
+    traces[4]['Layer'].must_equal 'rack'
+    traces[4]['Label'].must_equal 'exit'
+
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteProtocol'].must_equal "HTTP"
+    traces[5]['RemoteHost'].must_equal "127.0.0.1:8101"
+    traces[5]['ServiceArg'].must_equal "/?q=1"
+    traces[5]['HTTPMethod'].must_equal "GET"
+    traces[5]['HTTPStatus'].must_equal "200"
+    traces[5].has_key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
   end
 
-  it "should trace a Net::HTTP request" do
+  it "should trace a GET request" do
     Oboe::API.start_trace('net-http_test', '', {}) do
-      uri = URI('http://www.curlmyip.de')
+      uri = URI('http://127.0.0.1:8101/')
       http = Net::HTTP.new(uri.host, uri.port)
       http.get('/?q=1').read_body
     end
 
     traces = get_all_traces
-    traces.count.must_equal 5
+    traces.count.must_equal 8
     valid_edges?(traces).must_equal true
 
     validate_outer_layers(traces, 'net-http_test')
 
     traces[1]['Layer'].must_equal 'net-http'
-    traces[2]['IsService'].must_equal 1
-    traces[2]['RemoteProtocol'].must_equal "HTTP"
-    traces[2]['RemoteHost'].must_equal "www.curlmyip.de"
-    traces[2]['ServiceArg'].must_equal "/?q=1"
-    traces[2]['HTTPMethod'].must_equal "GET"
-    traces[2]['HTTPStatus'].must_equal "200"
-    traces[2].has_key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteProtocol'].must_equal "HTTP"
+    traces[5]['RemoteHost'].must_equal "127.0.0.1:8101"
+    traces[5]['ServiceArg'].must_equal "/?q=1"
+    traces[5]['HTTPMethod'].must_equal "GET"
+    traces[5]['HTTPStatus'].must_equal "200"
+    traces[5].has_key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+  end
+
+  it "should obey :log_args setting when true" do
+    Oboe::Config[:nethttp][:log_args] = true
+
+    Oboe::API.start_trace('nethttp_test', '', {}) do
+      uri = URI('http://127.0.0.1:8101/')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = false
+      http.get('/?q=ruby_test_suite').read_body
+    end
+
+    traces = get_all_traces
+    traces[5]['ServiceArg'].must_equal '/?q=ruby_test_suite'
+  end
+
+  it "should obey :log_args setting when false" do
+    Oboe::Config[:nethttp][:log_args] = false
+
+    Oboe::API.start_trace('nethttp_test', '', {}) do
+      uri = URI('http://127.0.0.1:8101/')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = false
+      http.get('/?q=ruby_test_suite').read_body
+    end
+
+    traces = get_all_traces
+    traces[5]['ServiceArg'].must_equal '/'
   end
 
   it "should obey :collect_backtraces setting when true" do
     Oboe::Config[:nethttp][:collect_backtraces] = true
 
     Oboe::API.start_trace('nethttp_test', '', {}) do
-      uri = URI('http://www.appneta.com')
+      uri = URI('http://127.0.0.1:8101/')
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = false
       http.get('/?q=ruby_test_suite').read_body
@@ -91,7 +128,7 @@ describe Oboe::Inst do
     Oboe::Config[:nethttp][:collect_backtraces] = false
 
     Oboe::API.start_trace('nethttp_test', '', {}) do
-      uri = URI('http://www.appneta.com')
+      uri = URI('http://127.0.0.1:8101/')
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = false
       http.get('/?q=ruby_test_suite').read_body

data/test/instrumentation/httpclient_test.rb

@@ -0,0 +1,296 @@
+require 'minitest_helper'
+require 'oboe/inst/rack'
+require File.expand_path(File.dirname(__FILE__) + '../../frameworks/apps/sinatra_simple')
+
+class HTTPClientTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    SinatraSimple
+  end
+
+  def test_reports_version_init
+    init_kvs = ::Oboe::Util.build_init_report
+    assert init_kvs.key?('Ruby.HTTPClient.Version')
+    assert_equal init_kvs['Ruby.HTTPClient.Version'], "HTTPClient-#{::HTTPClient::VERSION}"
+  end
+
+  def test_get_request
+    clear_all_traces
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.get('http://127.0.0.1:8101/', :query => { :keyword => 'ruby', :lang => 'en' })
+    end
+
+    traces = get_all_traces
+
+    # Validate returned xtrace
+    assert response.headers.key?("X-Trace")
+    assert Oboe::XTrace.valid?(response.headers["X-Trace"])
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+    validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/?keyword=ruby&lang=en'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+
+    assert_equal traces[5]['Layer'], 'httpclient'
+    assert_equal traces[5]['Label'], 'exit'
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_get_with_header_hash
+    clear_all_traces
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.get('http://127.0.0.1:8101/', nil, { "SOAPAction" => "HelloWorld" })
+    end
+
+    traces = get_all_traces
+
+    xtrace = response.headers['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+    validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+
+    assert_equal traces[5]['Layer'], 'httpclient'
+    assert_equal traces[5]['Label'], 'exit'
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_get_with_header_array
+    clear_all_traces
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.get('http://127.0.0.1:8101/', nil, [["Accept", "text/plain"], ["Accept", "text/html"]])
+    end
+
+    traces = get_all_traces
+
+    xtrace = response.headers['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+    validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+
+    assert_equal traces[5]['Layer'], 'httpclient'
+    assert_equal traces[5]['Label'], 'exit'
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_post_request
+    clear_all_traces
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.post('http://127.0.0.1:8101/')
+    end
+
+    traces = get_all_traces
+
+    xtrace = response.headers['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+    validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/'
+    assert_equal traces[1]['HTTPMethod'], 'POST'
+    assert traces[1].key?('Backtrace')
+
+    assert_equal traces[5]['Layer'], 'httpclient'
+    assert_equal traces[5]['Label'], 'exit'
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_async_get
+    skip if RUBY_VERSION < '1.9.2'
+
+    clear_all_traces
+
+    conn = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      conn = clnt.get_async('http://127.0.0.1:8101/?blah=1')
+    end
+
+    # Allow async request to finish
+    Thread.pass until conn.finished?
+
+    traces = get_all_traces
+    #require 'byebug'; debugger
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+
+    # FIXME: validate_outer_layers assumes that the traces
+    # are ordered which in the case of async, they aren't
+    # validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[2]['Async'], 1
+    assert_equal traces[2]['IsService'], 1
+    assert_equal traces[2]['RemoteURL'], 'http://127.0.0.1:8101/?blah=1'
+    assert_equal traces[2]['HTTPMethod'], 'GET'
+    assert traces[2].key?('Backtrace')
+
+    assert_equal traces[6]['Layer'], 'httpclient'
+    assert_equal traces[6]['Label'], 'exit'
+    assert_equal traces[6]['HTTPStatus'], 200
+  end
+
+  def test_cross_app_tracing
+    clear_all_traces
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.get('http://127.0.0.1:8101/', :query => { :keyword => 'ruby', :lang => 'en' })
+    end
+
+    xtrace = response.headers['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    traces = get_all_traces
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+    validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/?keyword=ruby&lang=en'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+
+    assert_equal traces[2]['Layer'], 'rack'
+    assert_equal traces[2]['Label'], 'entry'
+    assert_equal traces[3]['Layer'], 'rack'
+    assert_equal traces[3]['Label'], 'info'
+    assert_equal traces[4]['Layer'], 'rack'
+    assert_equal traces[4]['Label'], 'exit'
+
+    assert_equal traces[5]['Layer'], 'httpclient'
+    assert_equal traces[5]['Label'], 'exit'
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_requests_with_errors
+    clear_all_traces
+
+    result = nil
+    begin
+      Oboe::API.start_trace('httpclient_tests') do
+        clnt = HTTPClient.new
+        result = clnt.get('http://asfjalkfjlajfljkaljf/')
+      end
+    rescue
+    end
+
+    traces = get_all_traces
+    assert_equal traces.count, 5
+    valid_edges?(traces)
+    validate_outer_layers(traces, "httpclient_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteURL'], 'http://asfjalkfjlajfljkaljf/'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+
+    assert_equal traces[2]['Layer'], 'httpclient'
+    assert_equal traces[2]['Label'], 'error'
+    assert_equal traces[2]['ErrorClass'], "SocketError"
+    assert traces[2].key?('ErrorMsg')
+    assert traces[2].key?('Backtrace')
+
+    assert_equal traces[3]['Layer'], 'httpclient'
+    assert_equal traces[3]['Label'], 'exit'
+  end
+
+  def test_log_args_when_true
+    clear_all_traces
+
+    @log_args = Oboe::Config[:httpclient][:log_args]
+    Oboe::Config[:httpclient][:log_args] = true
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.get('http://127.0.0.1:8101/', :query => { :keyword => 'ruby', :lang => 'en' })
+    end
+
+    traces = get_all_traces
+
+    xtrace = response.headers['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/?keyword=ruby&lang=en'
+
+    Oboe::Config[:httpclient][:log_args] = @log_args
+  end
+
+  def test_log_args_when_false
+    clear_all_traces
+
+    @log_args = Oboe::Config[:httpclient][:log_args]
+    Oboe::Config[:httpclient][:log_args] = false
+
+    response = nil
+
+    Oboe::API.start_trace('httpclient_tests') do
+      clnt = HTTPClient.new
+      response = clnt.get('http://127.0.0.1:8101/', :query => { :keyword => 'ruby', :lang => 'en' })
+    end
+
+    traces = get_all_traces
+
+    xtrace = response.headers['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/'
+
+    Oboe::Config[:httpclient][:log_args] = @log_args
+  end
+end
+

data/test/instrumentation/rack_test.rb

@@ -30,14 +30,15 @@ class RackTestApp < Minitest::Test
 
     kvs = {}
     kvs["Label"] = "entry"
+    kvs["URL"] = "/lobster"
     validate_event_keys(traces[0], kvs)
 
     kvs.clear
+    kvs["Layer"] = "rack"
     kvs["Label"] = "info"
     kvs["HTTP-Host"] = "example.org"
     kvs["Port"] = 80
     kvs["Proto"] = "http"
-    kvs["URL"] = "/lobster"
     kvs["Method"] = "GET"
     kvs["ClientIP"] = "127.0.0.1"
     validate_event_keys(traces[1], kvs)
@@ -73,5 +74,43 @@ class RackTestApp < Minitest::Test
     assert xtrace
     assert Oboe::XTrace.valid?(xtrace)
   end
+
+  def test_log_args_when_false
+    clear_all_traces
+
+    @log_args = Oboe::Config[:rack][:log_args]
+    Oboe::Config[:rack][:log_args] = false
+
+    get "/lobster?blah=1"
+
+    traces = get_all_traces
+
+    xtrace = last_response['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    traces[0]['URL'].must_equal "/lobster"
+
+    Oboe::Config[:rack][:log_args] = @log_args
+  end
+
+  def test_log_args_when_true
+    clear_all_traces
+
+    @log_args = Oboe::Config[:rack][:log_args]
+    Oboe::Config[:rack][:log_args] = true
+
+    get "/lobster?blah=1"
+
+    traces = get_all_traces
+
+    xtrace = last_response['X-Trace']
+    assert xtrace
+    assert Oboe::XTrace.valid?(xtrace)
+
+    traces[0]['URL'].must_equal "/lobster?blah=1"
+
+    Oboe::Config[:rack][:log_args] = @log_args
+  end
 end