traceview 3.0.0

data/test/instrumentation/dalli_test.rb

@@ -0,0 +1,171 @@
+require 'minitest_helper'
+
+describe "Dalli" do
+  before do
+    clear_all_traces
+    @dc = Dalli::Client.new
+    @collect_backtraces = TraceView::Config[:dalli][:collect_backtraces]
+  end
+
+  after do
+    TraceView::Config[:dalli][:collect_backtraces] = @collect_backtraces
+  end
+
+  it 'Stock Dalli should be loaded, defined and ready' do
+    defined?(::Dalli).wont_match nil
+    defined?(::Dalli::Client).wont_match nil
+  end
+
+  it 'should have traceview methods defined' do
+    [ :perform_with_traceview, :get_multi_with_traceview].each do |m|
+      ::Dalli::Client.method_defined?(m).must_equal true
+    end
+  end
+
+  it 'should trace set' do
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.set('some_key', 1234)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1].has_key?("KVOp").must_equal true
+    traces[1].has_key?("KVKey").must_equal true
+    traces[1]['Layer'].must_equal "memcache"
+    traces[1]['KVKey'].must_equal "some_key"
+    traces[1]['RemoteHost'].must_equal "127.0.0.1:11211"
+  end
+
+  it 'should trace get' do
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.get('some_key')
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 5
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1]['KVOp'].must_equal "get"
+    traces[1]['KVKey'].must_equal "some_key"
+    traces[1]['RemoteHost'].must_equal "127.0.0.1:11211"
+    traces[2]['Label'].must_equal "info"
+    traces[2].has_key?('KVHit').must_equal true
+    traces[3]['Label'].must_equal "exit"
+  end
+
+  it 'should trace get_multi' do
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.get_multi([:one, :two, :three, :four, :five, :six])
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 5
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1]['KVOp'].must_equal "get_multi"
+    traces[2]['Label'].must_equal "info"
+    traces[2]['RemoteHost'].must_equal "127.0.0.1:11211"
+    traces[2].has_key?('KVKeyCount').must_equal true
+    traces[2].has_key?('KVHitCount').must_equal true
+    traces[3]['Label'].must_equal "exit"
+  end
+
+  it "should trace increment" do
+    @dc.incr("dalli_key_counter", 1, nil, 0)
+
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.incr("dalli_key_counter")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1]['KVOp'].must_equal "incr"
+    traces[1]['KVKey'].must_equal "dalli_key_counter"
+    traces[1]['RemoteHost'].must_equal "127.0.0.1:11211"
+    traces[2]['Label'].must_equal "exit"
+  end
+
+  it "should trace decrement" do
+    @dc.incr("dalli_key_counter", 1, nil, 0)
+
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.decr("dalli_key_counter")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1]['KVOp'].must_equal "decr"
+    traces[1]['KVKey'].must_equal "dalli_key_counter"
+    traces[1]['RemoteHost'].must_equal "127.0.0.1:11211"
+    traces[2]['Label'].must_equal "exit"
+  end
+
+  it "should trace replace" do
+    @dc.set('some_key', 1)
+
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.replace("some_key", "woop")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1]['KVOp'].must_equal "replace"
+    traces[1]['KVKey'].must_equal "some_key"
+    traces[1]['RemoteHost'].must_equal "127.0.0.1:11211"
+    traces[2]['Label'].must_equal "exit"
+  end
+
+  it "should trace delete" do
+    @dc.set('some_key', 1)
+
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.delete("some_key")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1]['KVOp'].must_equal "delete"
+    traces[1]['KVKey'].must_equal "some_key"
+    traces[1]['RemoteHost'].must_equal "127.0.0.1:11211"
+  end
+
+  it "should obey :collect_backtraces setting when true" do
+    @dc.set('some_key', 1)
+    TraceView::Config[:dalli][:collect_backtraces] = true
+
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.get('some_key')
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'memcache', 'Backtrace')
+  end
+
+  it "should obey :collect_backtraces setting when false" do
+    TraceView::Config[:dalli][:collect_backtraces] = false
+
+    TraceView::API.start_trace('dalli_test', '', {}) do
+      @dc.get('some_key')
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'memcache', 'Backtrace')
+  end
+end

data/test/instrumentation/em_http_request_test.rb

@@ -0,0 +1,86 @@
+require 'minitest_helper'
+
+# Disable this test on JRuby until we can investigate
+# "SOCKET: SET COMM INACTIVITY UNIMPLEMENTED 10"
+# https://travis-ci.org/appneta/traceview-ruby/jobs/33745752
+if RUBY_VERSION >= '1.9' and TraceView::Config[:em_http_request][:enabled] and not defined?(JRUBY_VERSION)
+
+  describe "EventMachine" do
+    before do
+      clear_all_traces
+      @collect_backtraces = TraceView::Config[:em_http_request][:collect_backtraces]
+    end
+
+    after do
+      TraceView::Config[:em_http_request][:collect_backtraces] = @collect_backtraces
+    end
+
+    it 'EventMachine::HttpConnection should be loaded, defined and ready' do
+      defined?(::EventMachine::HttpConnection).wont_match nil
+    end
+
+    it 'should have traceview methods defined' do
+      ::EventMachine::HttpConnection.method_defined?("setup_request_with_traceview").must_equal true
+    end
+
+    it 'should trace request' do
+      TraceView::API.start_trace('em-http-request_test', '', {}) do
+        EventMachine.run do
+          http = EventMachine::HttpRequest.new('http://appneta.com/').get
+          http.callback do
+            EventMachine.stop
+          end
+        end
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'em-http-request_test')
+
+      traces[1]["Layer"].must_equal "em-http-request"
+      traces[1]["Label"].must_equal "entry"
+      traces[1]["IsService"].must_equal "1"
+      traces[1]["RemoteURL"].must_equal "http://appneta.com/"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:em_http_request][:collect_backtraces]
+
+      traces[2]["Layer"].must_equal "em-http-request"
+      traces[2]["Label"].must_equal "exit"
+      traces[2]["Async"].must_equal "1"
+      traces[2].has_key?('Backtrace').must_equal TraceView::Config[:em_http_request][:collect_backtraces]
+    end
+
+    it "should obey :collect_backtraces setting when true" do
+      TraceView::Config[:em_http_request][:collect_backtraces] = true
+
+      TraceView::API.start_trace('em-http-request_test', '', {}) do
+        EventMachine.run do
+          http = EventMachine::HttpRequest.new('http://appneta.com/').get
+          http.callback do
+            EventMachine.stop
+          end
+        end
+      end
+
+      traces = get_all_traces
+      layer_has_key(traces, 'em-http-request', 'Backtrace')
+    end
+
+    it "should obey :collect_backtraces setting when false" do
+      TraceView::Config[:em_http_request][:collect_backtraces] = false
+
+      TraceView::API.start_trace('em-http-request_test', '', {}) do
+        EventMachine.run do
+          http = EventMachine::HttpRequest.new('http://appneta.com/').get
+          http.callback do
+            EventMachine.stop
+          end
+        end
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'em-http-request', 'Backtrace')
+    end
+  end
+
+end # unless defined?(JRUBY_VERSION)

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
+