traceview 3.0.0-java

data/test/instrumentation/excon_test.rb

@@ -0,0 +1,207 @@
+require 'minitest_helper'
+require 'traceview/inst/rack'
+require File.expand_path(File.dirname(__FILE__) + '../../frameworks/apps/sinatra_simple')
+
+class ExconTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    SinatraSimple
+  end
+
+  def test_must_return_xtrace_header
+    clear_all_traces
+    get "/"
+    xtrace = last_response['X-Trace']
+    assert xtrace
+    assert TraceView::XTrace.valid?(xtrace)
+  end
+
+  def test_reports_version_init
+    init_kvs = ::TraceView::Util.build_init_report
+    assert init_kvs.key?('Ruby.Excon.Version')
+    assert_equal init_kvs['Ruby.Excon.Version'], "Excon-#{::Excon::VERSION}"
+  end
+
+  def test_class_get_request
+    clear_all_traces
+
+    TraceView::API.start_trace('excon_tests') do
+      Excon.get('http://127.0.0.1:8101/')
+    end
+
+    traces = get_all_traces
+    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'], '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[5]['Layer'], 'excon'
+    assert_equal traces[5]['Label'], 'exit'
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_cross_app_tracing
+    clear_all_traces
+
+    TraceView::API.start_trace('excon_tests') do
+      response = Excon.get('http://127.0.0.1:8101/?blah=1')
+      xtrace = response.headers['X-Trace']
+      assert xtrace
+      assert TraceView::XTrace.valid?(xtrace)
+    end
+
+    traces = get_all_traces
+    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'], '127.0.0.1'
+    assert_equal traces[1]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[1]['ServiceArg'], '/?blah=1'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+    assert_equal traces[5]['HTTPStatus'], 200
+  end
+
+  def test_persistent_requests
+    # Persistence was adding in 0.31.0
+    skip if Excon::VERSION < '0.31.0'
+
+    clear_all_traces
+
+    TraceView::API.start_trace('excon_tests') do
+      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, 17
+    validate_outer_layers(traces, "excon_tests")
+    valid_edges?(traces)
+
+    assert_equal traces[1]['IsService'], 1
+    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[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
+    skip if Excon::VERSION <= '0.17.0'
+
+    clear_all_traces
+
+    TraceView::API.start_trace('excon_tests') do
+      connection = Excon.new('http://127.0.0.1:8101/')
+      connection.requests([{:method => :get}, {:method => :put}])
+    end
+
+    traces = get_all_traces
+    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'], '127.0.0.1'
+    assert_equal traces[1]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[1]['ServiceArg'], '/'
+    assert_equal traces[1]['Pipeline'], 'true'
+    assert_equal traces[1]['HTTPMethods'], 'GET, PUT'
+    assert traces[1].key?('Backtrace')
+  end
+
+  def test_requests_with_errors
+    clear_all_traces
+
+    begin
+      TraceView::API.start_trace('excon_tests') do
+        Excon.get('http://asfjalkfjlajfljkaljf/')
+      end
+    rescue
+    end
+
+    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'
+    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]['Layer'], 'excon'
+    assert_equal traces[2]['Label'], 'error'
+    assert_equal traces[2]['ErrorClass'], "Excon::Errors::SocketError"
+    assert traces[2].key?('ErrorMsg')
+    assert traces[2].key?('Backtrace')
+
+    assert_equal traces[3]['Layer'], 'excon'
+    assert_equal traces[3]['Label'], 'exit'
+  end
+
+  def test_obey_log_args_when_false
+    @log_args = TraceView::Config[:excon][:log_args]
+    clear_all_traces
+
+    TraceView::Config[:excon][:log_args] = false
+
+    TraceView::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'], '/'
+
+    TraceView::Config[:excon][:log_args] = @log_args
+  end
+
+  def test_obey_log_args_when_true
+    @log_args = TraceView::Config[:excon][:log_args]
+    clear_all_traces
+
+    TraceView::Config[:excon][:log_args] = true
+
+    TraceView::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'
+
+    TraceView::Config[:excon][:log_args] = @log_args
+  end
+end
+

data/test/instrumentation/faraday_test.rb

@@ -0,0 +1,235 @@
+require 'minitest_helper'
+
+describe "Faraday" do
+  before do
+    clear_all_traces
+    @collect_backtraces = TraceView::Config[:faraday][:collect_backtraces]
+  end
+
+  after do
+    TraceView::Config[:faraday][:collect_backtraces] = @collect_backtraces
+  end
+
+  it 'Faraday should be defined and ready' do
+    defined?(::Faraday).wont_match nil
+  end
+
+  it 'Faraday should have traceview methods defined' do
+    [ :run_request_with_traceview ].each do |m|
+      ::Faraday::Connection.method_defined?(m).must_equal true
+    end
+  end
+
+  it "should trace cross-app request" do
+    TraceView::API.start_trace('faraday_test') do
+      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'
+      response.headers["x-trace"].wont_match nil
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 11
+
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:faraday][:collect_backtraces]
+
+    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[7]['Layer'].must_equal 'net-http'
+    traces[7]['Label'].must_equal 'exit'
+
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[9]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a Faraday request' do
+    TraceView::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 11
+
+    valid_edges?(traces)
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:faraday][:collect_backtraces]
+
+    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[7]['Layer'].must_equal 'net-http'
+    traces[7]['Label'].must_equal 'exit'
+
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[8]['Label'].must_equal 'info'
+
+    traces[9]['Layer'].must_equal 'faraday'
+    traces[9]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a Faraday class style request' do
+    TraceView::API.start_trace('faraday_test') do
+      Faraday.get('http://127.0.0.1:8101/', {:a => 1})
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 11
+
+    valid_edges?(traces)
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:faraday][:collect_backtraces]
+
+    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[7]['Layer'].must_equal 'net-http'
+    traces[7]['Label'].must_equal 'exit'
+
+    traces[8]['Layer'].must_equal 'faraday'
+    traces[8]['Label'].must_equal 'info'
+
+    traces[9]['Layer'].must_equal 'faraday'
+    traces[9]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a Faraday with the excon adapter' do
+    TraceView::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
+        faraday.adapter :excon
+      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 TraceView::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[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"
+
+    TraceView::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 TraceView::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[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 obey :collect_backtraces setting when true' do
+    TraceView::Config[:faraday][:collect_backtraces] = true
+
+    TraceView::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'faraday', 'Backtrace')
+  end
+
+  it 'should obey :collect_backtraces setting when false' do
+    TraceView::Config[:faraday][:collect_backtraces] = false
+
+    TraceView::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://127.0.0.1:8101') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'faraday', 'Backtrace')
+  end
+end

data/test/instrumentation/http_test.rb

@@ -0,0 +1,140 @@
+require 'minitest_helper'
+require 'net/http'
+
+describe "Net::HTTP"  do
+  before do
+    clear_all_traces
+    @collect_backtraces = TraceView::Config[:nethttp][:collect_backtraces]
+    @log_args = TraceView::Config[:nethttp][:log_args]
+  end
+
+  after do
+    TraceView::Config[:nethttp][:collect_backtraces] = @collect_backtraces
+    TraceView::Config[:nethttp][:log_args] = @log_args
+  end
+
+  it 'Net::HTTP should be defined and ready' do
+    defined?(::Net::HTTP).wont_match nil
+  end
+
+  it 'Net::HTTP should have traceview methods defined' do
+    [ :request_with_traceview ].each do |m|
+      ::Net::HTTP.method_defined?(m).must_equal true
+    end
+  end
+
+  it "should trace a Net::HTTP request to an instr'd app" do
+    TraceView::API.start_trace('net-http_test', '', {}) do
+      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)
+      # The HTTP response should have an X-Trace header inside of it
+      response["x-trace"].wont_match nil
+    end
+
+    traces = get_all_traces
+    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[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 TraceView::Config[:nethttp][:collect_backtraces]
+  end
+
+  it "should trace a GET request" do
+    TraceView::API.start_trace('net-http_test', '', {}) do
+      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 8
+    valid_edges?(traces).must_equal true
+
+    validate_outer_layers(traces, 'net-http_test')
+
+    traces[1]['Layer'].must_equal 'net-http'
+    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 TraceView::Config[:nethttp][:collect_backtraces]
+  end
+
+  it "should obey :log_args setting when true" do
+    TraceView::Config[:nethttp][:log_args] = true
+
+    TraceView::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
+    TraceView::Config[:nethttp][:log_args] = false
+
+    TraceView::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
+    TraceView::Config[:nethttp][:collect_backtraces] = true
+
+    TraceView::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
+    layer_has_key(traces, 'net-http', 'Backtrace')
+  end
+
+  it "should obey :collect_backtraces setting when false" do
+    TraceView::Config[:nethttp][:collect_backtraces] = false
+
+    TraceView::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
+    layer_doesnt_have_key(traces, 'net-http', 'Backtrace')
+  end
+end