appoptics_apm 4.0.2

data/test/instrumentation/dalli_test.rb

@@ -0,0 +1,177 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+if RUBY_VERSION > '1.8.7'
+
+  require 'minitest_helper'
+
+  describe "Dalli" do
+    before do
+      clear_all_traces
+      @dc = Dalli::Client.new
+      @collect_backtraces = AppOpticsAPM::Config[:dalli][:collect_backtraces]
+    end
+
+    after do
+      AppOpticsAPM::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 appoptics_apm methods defined' do
+      [ :perform_with_appoptics, :get_multi_with_appoptics].each do |m|
+        ::Dalli::Client.method_defined?(m).must_equal true
+      end
+    end
+
+    it 'should trace set' do
+      AppOpticsAPM::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
+      AppOpticsAPM::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
+      AppOpticsAPM::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)
+
+      AppOpticsAPM::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)
+
+      AppOpticsAPM::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)
+
+      AppOpticsAPM::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)
+
+      AppOpticsAPM::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)
+      AppOpticsAPM::Config[:dalli][:collect_backtraces] = true
+
+      AppOpticsAPM::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
+      AppOpticsAPM::Config[:dalli][:collect_backtraces] = false
+
+      AppOpticsAPM::API.start_trace('dalli_test', '', {}) do
+        @dc.get('some_key')
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'memcache', 'Backtrace')
+    end
+  end
+end

data/test/instrumentation/em_http_request_test.rb

@@ -0,0 +1,89 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+# Disable this test on JRuby until we can investigate
+# "SOCKET: SET COMM INACTIVITY UNIMPLEMENTED 10"
+# https://travis-ci.org/tracelytics/ruby-appoptics_apm/jobs/33745752
+if RUBY_VERSION >= '1.9' and AppOpticsAPM::Config[:em_http_request][:enabled] and not defined?(JRUBY_VERSION)
+
+  describe "EventMachine" do
+    before do
+      clear_all_traces
+      @collect_backtraces = AppOpticsAPM::Config[:em_http_request][:collect_backtraces]
+    end
+
+    after do
+      AppOpticsAPM::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 appoptics_apm methods defined' do
+      ::EventMachine::HttpConnection.method_defined?("setup_request_with_appoptics").must_equal true
+    end
+
+    it 'should trace request' do
+      AppOpticsAPM::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 AppOpticsAPM::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 AppOpticsAPM::Config[:em_http_request][:collect_backtraces]
+    end
+
+    it "should obey :collect_backtraces setting when true" do
+      AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = true
+
+      AppOpticsAPM::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
+      AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = false
+
+      AppOpticsAPM::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,231 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+require 'appoptics_apm/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
+    skip if defined?(JRUBY_VERSION)
+
+    clear_all_traces
+    get "/"
+    xtrace = last_response['X-Trace']
+
+    # Rack response header management under JRUBY.
+    assert xtrace
+    assert AppOpticsAPM::XTrace.valid?(xtrace)
+  end
+
+  def test_reports_version_init
+    init_kvs = ::AppOpticsAPM::Util.build_init_report
+    assert_equal ::Excon::VERSION, init_kvs['Ruby.excon.Version']
+  end
+
+  def test_class_get_request
+    clear_all_traces
+
+    AppOpticsAPM::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")
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 1,           traces[1]['IsService']
+    assert_equal '127.0.0.1', traces[1]['RemoteHost']
+    assert_equal 'HTTP',      traces[1]['RemoteProtocol']
+    assert_equal '/',         traces[1]['ServiceArg']
+    assert_equal 'GET',       traces[1]['HTTPMethod']
+    assert traces[1].key?('Backtrace')
+
+    assert_equal 'excon',     traces[5]['Layer']
+    assert_equal 'exit',      traces[5]['Label']
+    assert_equal 200,         traces[5]['HTTPStatus']
+  end
+
+  def test_cross_app_tracing
+    clear_all_traces
+
+    AppOpticsAPM::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 AppOpticsAPM::XTrace.valid?(xtrace)
+    end
+
+    traces = get_all_traces
+    assert_equal 7, traces.count
+    validate_outer_layers(traces, "excon_tests")
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 1,            traces[1]['IsService']
+    assert_equal '127.0.0.1',  traces[1]['RemoteHost']
+    assert_equal 'HTTP',       traces[1]['RemoteProtocol']
+    assert_equal '/?blah=1',   traces[1]['ServiceArg']
+    assert_equal 'GET',        traces[1]['HTTPMethod']
+    assert_equal 200,          traces[5]['HTTPStatus']
+    assert traces[1].key?('Backtrace')
+  end
+
+  def test_persistent_requests
+    # Persistence was adding in 0.31.0
+    skip if Excon::VERSION < '0.31.0'
+
+    clear_all_traces
+
+    AppOpticsAPM::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")
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 1,             traces[1]['IsService']
+    assert_equal '127.0.0.1',   traces[1]['RemoteHost']
+    assert_equal 'HTTP',        traces[1]['RemoteProtocol']
+    assert_equal '/',           traces[1]['ServiceArg']
+    assert_equal 'GET',         traces[1]['HTTPMethod']
+    assert_equal 200,           traces[5]['HTTPStatus']
+    assert traces[1].key?('Backtrace')
+
+    assert_equal 1,             traces[6]['IsService']
+    assert_equal '127.0.0.1',   traces[6]['RemoteHost']
+    assert_equal 'HTTP',        traces[6]['RemoteProtocol']
+    assert_equal '/',           traces[6]['ServiceArg']
+    assert_equal 'GET',         traces[6]['HTTPMethod']
+    assert_equal 200,           traces[10]['HTTPStatus']
+    assert traces[6].key?('Backtrace')
+
+    assert_equal 1,             traces[11]['IsService']
+    assert_equal '127.0.0.1',   traces[11]['RemoteHost']
+    assert_equal 'HTTP',        traces[11]['RemoteProtocol']
+    assert_equal '/',           traces[11]['ServiceArg']
+    assert_equal 'GET',         traces[11]['HTTPMethod']
+    assert_equal 200,           traces[15]['HTTPStatus']
+    assert traces[11].key?('Backtrace')
+  end
+
+  def test_pipelined_requests
+    skip if Excon::VERSION <= '0.17.0'
+
+    clear_all_traces
+
+    AppOpticsAPM::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 10, traces.count
+    validate_outer_layers(traces, "excon_tests")
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 1,             traces[1]['IsService']
+    assert_equal '127.0.0.1',   traces[1]['RemoteHost']
+    assert_equal 'HTTP',        traces[1]['RemoteProtocol']
+    assert_equal '/',           traces[1]['ServiceArg']
+    assert_equal 'true',        traces[1]['Pipeline']
+    assert_equal 'GET, PUT',    traces[1]['HTTPMethods']
+    assert traces[1].key?('Backtrace')
+  end
+
+  def test_requests_with_errors
+    clear_all_traces
+
+    begin
+      AppOpticsAPM::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")
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 1,                          traces[1]['IsService']
+    assert_equal 'asfjalkfjlajfljkaljf',     traces[1]['RemoteHost']
+    assert_equal 'HTTP',                     traces[1]['RemoteProtocol']
+    assert_equal '/',                        traces[1]['ServiceArg']
+    assert_equal 'GET',                      traces[1]['HTTPMethod']
+    assert traces[1].key?('Backtrace')
+
+    assert_equal 'excon',                    traces[2]['Layer']
+    assert_equal 'error',                    traces[2]['Label']
+    assert_equal "Excon::Error::Socket",     traces[2]['ErrorClass']
+    assert traces[2].key?('ErrorMsg')
+    assert traces[2].key?('Backtrace')
+
+    assert_equal 'excon',                    traces[3]['Layer']
+    assert_equal 'exit',                     traces[3]['Label']
+  end
+
+  def test_obey_log_args_when_false
+    @log_args = AppOpticsAPM::Config[:excon][:log_args]
+    clear_all_traces
+
+    AppOpticsAPM::Config[:excon][:log_args] = false
+
+    AppOpticsAPM::API.start_trace('excon_tests') do
+      Excon.get('http://127.0.0.1:8101/?blah=1')
+    end
+
+    traces = get_all_traces
+    assert_equal 7, traces.count
+    assert_equal '/', traces[1]['ServiceArg']
+
+    AppOpticsAPM::Config[:excon][:log_args] = @log_args
+  end
+
+  def test_obey_log_args_when_true
+    @log_args = AppOpticsAPM::Config[:excon][:log_args]
+    clear_all_traces
+
+    AppOpticsAPM::Config[:excon][:log_args] = true
+
+    AppOpticsAPM::API.start_trace('excon_tests') do
+      Excon.get('http://127.0.0.1:8101/?blah=1')
+    end
+
+    traces = get_all_traces
+    assert_equal 7, traces.count
+    assert_equal '/?blah=1', traces[1]['ServiceArg']
+
+    AppOpticsAPM::Config[:excon][:log_args] = @log_args
+  end
+
+  def test_obey_log_args_when_true_and_using_hash
+    @log_args = AppOpticsAPM::Config[:excon][:log_args]
+    clear_all_traces
+
+    AppOpticsAPM::Config[:excon][:log_args] = true
+
+    AppOpticsAPM::API.start_trace('excon_tests') do
+      Excon.get('http://127.0.0.1:8101/?', :query => { :blah => 1 })
+    end
+
+    traces = get_all_traces
+    assert_equal 7, traces.count
+    assert_equal '/?blah=1', traces[1]['ServiceArg']
+
+    AppOpticsAPM::Config[:excon][:log_args] = @log_args
+  end
+end
+