traceview 3.0.0-java

data/test/instrumentation/httpclient_test.rb

@@ -0,0 +1,296 @@
+require 'minitest_helper'
+require 'traceview/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 = ::TraceView::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
+
+    TraceView::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 TraceView::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
+
+    TraceView::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 TraceView::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
+
+    TraceView::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 TraceView::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
+
+    TraceView::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 TraceView::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
+
+    TraceView::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
+
+    TraceView::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 TraceView::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
+      TraceView::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 = TraceView::Config[:httpclient][:log_args]
+    TraceView::Config[:httpclient][:log_args] = true
+
+    response = nil
+
+    TraceView::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 TraceView::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'
+
+    TraceView::Config[:httpclient][:log_args] = @log_args
+  end
+
+  def test_log_args_when_false
+    clear_all_traces
+
+    @log_args = TraceView::Config[:httpclient][:log_args]
+    TraceView::Config[:httpclient][:log_args] = false
+
+    response = nil
+
+    TraceView::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 TraceView::XTrace.valid?(xtrace)
+
+    assert_equal traces.count, 7
+    valid_edges?(traces)
+
+    assert_equal traces[1]['RemoteURL'], 'http://127.0.0.1:8101/'
+
+    TraceView::Config[:httpclient][:log_args] = @log_args
+  end
+end
+

data/test/instrumentation/memcache_test.rb

@@ -0,0 +1,251 @@
+require 'minitest_helper'
+require 'memcache'
+
+describe "Memcache" do
+  before do
+    clear_all_traces
+    @mc = ::MemCache.new('127.0.0.1')
+
+    # These are standard entry/exit KVs that are passed up with all mongo operations
+    @entry_kvs = {
+      'Layer' => 'memcache',
+      'Label' => 'entry' }
+
+    @info_kvs = {
+      'Layer' => 'memcache',
+      'Label' => 'info' }
+
+    @exit_kvs = { 'Layer' => 'memcache', 'Label' => 'exit' }
+    @collect_backtraces = TraceView::Config[:memcache][:collect_backtraces]
+  end
+
+  after do
+    TraceView::Config[:memcache][:collect_backtraces] = @collect_backtraces
+  end
+
+  it 'Stock MemCache should be loaded, defined and ready' do
+    defined?(::MemCache).wont_match nil
+  end
+
+  it 'MemCache should have traceview methods defined' do
+    TraceView::API::Memcache::MEMCACHE_OPS.each do |m|
+      if ::MemCache.method_defined?(m)
+        ::MemCache.method_defined?("#{m}_with_traceview").must_equal true
+      end
+      ::MemCache.method_defined?(:request_setup_with_traceview).must_equal true
+      ::MemCache.method_defined?(:cache_get_with_traceview).must_equal true
+      ::MemCache.method_defined?(:get_multi_with_traceview).must_equal true
+    end
+  end
+
+  it "should trace set" do
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.set('msg', 'blah')
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "set"
+    traces[1].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "msg"
+    traces[2].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace get" do
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.get('msg')
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 6
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "get"
+    traces[1].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "msg"
+    traces[2]['RemoteHost'].must_equal "127.0.0.1"
+    traces[2].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    traces[3].has_key?('KVHit').must_equal true
+    traces[3].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[4], @exit_kvs)
+  end
+
+  it "should trace get_multi" do
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.get_multi(['one', 'two', 'three', 'four', 'five', 'six'])
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "get_multi"
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKeyCount'].must_equal 6
+    traces[2].has_key?('KVHitCount').must_equal true
+    traces[2].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace add for existing key" do
+    @mc.set('testKey', 'x', 1200)
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.add('testKey', 'x', 1200)
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "add"
+    traces[1].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "testKey"
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace append" do
+    @mc.set('rawKey', "Peanut Butter ", 600, :raw => true)
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.append('rawKey', "Jelly")
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "append"
+    traces[1].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+
+    traces[2]['KVKey'].must_equal "rawKey"
+    traces[2].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace decrement" do
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.decr('memcache_key_counter', 1)
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "decr"
+    traces[1].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    traces[2]['KVKey'].must_equal "memcache_key_counter"
+    traces[2].has_key?('Backtrace').must_equal TraceView::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace increment" do
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.incr("memcache_key_counter", 1)
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    traces[1]['KVOp'].must_equal "incr"
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "memcache_key_counter"
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace replace" do
+    @mc.set("some_key", "blah")
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.replace("some_key", "woop")
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    traces[1]['KVOp'].must_equal "replace"
+    traces[2]['KVKey'].must_equal "some_key"
+    validate_event_keys(traces[2], @info_kvs)
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace delete" do
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.delete("some_key")
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    traces[1]['KVOp'].must_equal "delete"
+    traces[2]['KVKey'].must_equal "some_key"
+    validate_event_keys(traces[2], @info_kvs)
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should obey :collect_backtraces setting when true" do
+    TraceView::Config[:memcache][:collect_backtraces] = true
+
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.set('some_key', 1)
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'memcache', 'Backtrace')
+  end
+
+  it "should obey :collect_backtraces setting when false" do
+    TraceView::Config[:memcache][:collect_backtraces] = false
+
+    TraceView::API.start_trace('memcache_test', '', {}) do
+      @mc.set('some_key', 1)
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'memcache', 'Backtrace')
+  end
+end