oboe 2.7.15.1-java → 2.7.16.1-java

data/lib/oboe/xtrace.rb

@@ -43,6 +43,48 @@ module Oboe
         Oboe.logger.debug e.backtrace
         return nil
       end
+
+      ##
+      # Oboe::XTrace.edge_id
+      #
+      # Extract and return the edge_id portion of an X-Trace ID
+      #
+      def edge_id(xtrace)
+        return nil unless Oboe::XTrace.valid?(xtrace)
+
+        xtrace[42..57]
+      rescue StandardError => e
+        Oboe.logger.debug e.message
+        Oboe.logger.debug e.backtrace
+        return nil
+      end
+
+      ##
+      # continue_service_context
+      #
+      # In the case of service calls such as external HTTP requests, we
+      # pass along X-Trace headers so that request context can be maintained
+      # across servers and applications.
+      #
+      # Remote requests can return a X-Trace header in which case we want
+      # to pickup on and continue the context in most cases.
+      #
+      # @start is the context just before the outgoing request
+      #
+      # @finish is the context returned to us (as an HTTP response header
+      # if that be the case)
+      #
+      def continue_service_context(start, finish)
+        if Oboe::XTrace.valid?(finish) && Oboe.tracing?
+
+          # Assure that we received back a valid X-Trace with the same task_id
+          if Oboe::XTrace.task_id(start) == Oboe::XTrace.task_id(finish)
+            Oboe::Context.fromString(finish)
+          else
+            Oboe.logger.debug "Mismatched returned X-Trace ID: #{finish}"
+          end
+        end
+      end
     end
   end
 end

data/test/instrumentation/excon_test.rb

@@ -0,0 +1,170 @@
+require 'minitest_helper'
+require 'oboe/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 Oboe::XTrace.valid?(xtrace)
+  end
+
+  def test_reports_version_init
+    init_kvs = ::Oboe::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
+
+    Oboe::API.start_trace('excon_tests') do
+      response = 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
+
+    Oboe::API.start_trace('excon_tests') do
+      response = Excon.get('http://www.gameface.in/gamers')
+      xtrace = response.headers['X-Trace']
+      assert xtrace
+      assert Oboe::XTrace.valid?(xtrace)
+    end
+
+    traces = get_all_traces
+    assert_equal traces.count, 4
+    validate_outer_layers(traces, "excon_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteHost'], 'www.gameface.in'
+    assert_equal traces[1]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[1]['ServiceArg'], '/gamers'
+    assert_equal traces[1]['HTTPMethod'], 'GET'
+    assert traces[1].key?('Backtrace')
+    assert_equal traces[2]['HTTPStatus'], 200
+  end
+
+  def test_persistent_requests
+    # Persistence was adding in 0.31.0
+    skip if Excon::VERSION < '0.31.0'
+
+    clear_all_traces
+
+    Oboe::API.start_trace('excon_tests') do
+      connection = Excon.new('http://www.gameface.in/') # 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, 8
+    validate_outer_layers(traces, "excon_tests")
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteHost'], 'www.gameface.in'
+    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]['HTTPStatus'], 200
+
+    assert_equal traces[3]['IsService'], 1
+    assert_equal traces[3]['RemoteHost'], 'www.gameface.in'
+    assert_equal traces[3]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[3]['ServiceArg'], '/'
+    assert_equal traces[3]['HTTPMethod'], 'GET'
+    assert traces[3].key?('Backtrace')
+    assert_equal traces[4]['HTTPStatus'], 200
+
+    assert_equal traces[5]['IsService'], 1
+    assert_equal traces[5]['RemoteHost'], 'www.gameface.in'
+    assert_equal traces[5]['RemoteProtocol'], 'HTTP'
+    assert_equal traces[5]['ServiceArg'], '/'
+    assert_equal traces[5]['HTTPMethod'], 'GET'
+    assert traces[5].key?('Backtrace')
+    assert_equal traces[6]['HTTPStatus'], 200
+  end
+
+  def test_pipelined_requests
+    skip if Excon::VERSION <= '0.17.0'
+
+    clear_all_traces
+
+    Oboe::API.start_trace('excon_tests') do
+      connection = Excon.new('http://www.gameface.in/')
+      connection.requests([{:method => :get}, {:method => :put}])
+    end
+
+    traces = get_all_traces
+    assert_equal traces.count, 4
+    validate_outer_layers(traces, "excon_tests")
+    valid_edges?(traces)
+
+    assert_equal traces[1]['IsService'], 1
+    assert_equal traces[1]['RemoteHost'], 'www.gameface.in'
+    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
+      Oboe::API.start_trace('excon_tests') do
+        connection = Excon.get('http://asfjalkfjlajfljkaljf/')
+      end
+    rescue
+    end
+
+    traces = get_all_traces
+    assert_equal traces.count, 5
+    validate_outer_layers(traces, "excon_tests")
+
+    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
+end
+

data/test/instrumentation/faraday_test.rb

@@ -63,6 +63,7 @@ describe Oboe::Inst::FaradayConnection do
     traces = get_all_traces
     traces.count.must_equal 8
 
+    valid_edges?(traces)
     validate_outer_layers(traces, 'faraday_test')
 
     traces[1]['Layer'].must_equal 'faraday'
@@ -94,6 +95,7 @@ describe Oboe::Inst::FaradayConnection do
     traces = get_all_traces
     traces.count.must_equal 8
 
+    valid_edges?(traces)
     validate_outer_layers(traces, 'faraday_test')
 
     traces[1]['Layer'].must_equal 'faraday'
@@ -126,25 +128,36 @@ describe Oboe::Inst::FaradayConnection do
     end
 
     traces = get_all_traces
-    traces.count.must_equal 5
+    traces.count.must_equal 7
 
+    valid_edges?(traces)
     validate_outer_layers(traces, 'faraday_test')
 
     traces[1]['Layer'].must_equal 'faraday'
     traces[1].key?('Backtrace').must_equal Oboe::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 'www.curlmyip.de'
     traces[2]['ServiceArg'].must_equal '/?q=1'
-    traces[2]['HTTPMethod'].downcase.must_equal 'get'
+    traces[2]['HTTPMethod'].must_equal 'GET'
 
-    traces[2]['Layer'].must_equal 'faraday'
-    traces[2]['Label'].must_equal 'info'
-    traces[2]['HTTPStatus'].must_equal 200
-
-    traces[3]['Layer'].must_equal 'faraday'
+    traces[3]['Layer'].must_equal 'excon'
     traces[3]['Label'].must_equal 'exit'
+    traces[3]['HTTPStatus'].must_equal 200
+
+    traces[4]['Layer'].must_equal 'faraday'
+    traces[4]['Label'].must_equal 'info'
+    unless RUBY_VERSION < '1.9.3'
+      # FIXME: Ruby 1.8 is reporting an object instance instead of
+      # an array
+      traces[4]['Middleware'].must_equal '[Faraday::Adapter::Excon]'
+    end
+
+    traces[5]['Layer'].must_equal 'faraday'
+    traces[5]['Label'].must_equal 'exit'
   end
 
   it 'should obey :collect_backtraces setting when true' do

data/test/instrumentation/http_test.rb

@@ -34,6 +34,10 @@ describe Oboe::Inst do
     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
+
     validate_outer_layers(traces, 'net-http_test')
 
     traces[1]['Layer'].must_equal 'net-http'
@@ -55,6 +59,7 @@ describe Oboe::Inst do
 
     traces = get_all_traces
     traces.count.must_equal 5
+    valid_edges?(traces).must_equal true
 
     validate_outer_layers(traces, 'net-http_test')
 

data/test/instrumentation/rest-client_test.rb

@@ -0,0 +1,302 @@
+require 'minitest_helper'
+
+if RUBY_VERSION >= '1.9.3'
+  describe Oboe::Inst::RestClientRequest do
+    before do
+      clear_all_traces
+      @collect_backtraces = Oboe::Config[:rest_client][:collect_backtraces]
+    end
+
+    after do
+      Oboe::Config[:rest_client][:collect_backtraces] = @collect_backtraces
+    end
+
+    it 'RestClient should be defined and ready' do
+      defined?(::RestClient).wont_match nil
+    end
+
+    it 'RestClient should have oboe methods defined' do
+      [ :execute_with_oboe ].each do |m|
+        ::RestClient::Request.method_defined?(m).must_equal true
+      end
+    end
+
+    it "should report rest-client version in __Init" do
+      init_kvs = ::Oboe::Util.build_init_report
+
+      init_kvs.key?('Ruby.RestClient.Version').must_equal true
+      init_kvs['Ruby.RestClient.Version'].must_equal "RestClient-#{::RestClient::VERSION}"
+    end
+
+    it "should trace a request to an instr'd app" do
+      response = nil
+
+      Oboe::API.start_trace('rest_client_test') do
+        response = RestClient.get 'http://gameface.in/gamers'
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 7
+
+      # 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
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[3]['Layer'].must_equal 'net-http'
+      traces[3]['Label'].must_equal 'info'
+      traces[3]['IsService'].must_equal 1
+      traces[3]['RemoteProtocol'].must_equal 'HTTP'
+      traces[3]['RemoteHost'].must_equal 'gameface.in'
+      traces[3]['ServiceArg'].must_equal '/gamers'
+      traces[3]['HTTPMethod'].must_equal 'GET'
+      traces[3]['HTTPStatus'].must_equal "200"
+      traces[3].key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+
+      traces[4]['Layer'].must_equal 'net-http'
+      traces[4]['Label'].must_equal 'exit'
+
+      traces[5]['Layer'].must_equal 'rest-client'
+      traces[5]['Label'].must_equal 'exit'
+
+      response.headers.key?(:x_trace).wont_equal nil
+      xtrace = response.headers[:x_trace]
+      Oboe::XTrace.valid?(xtrace).must_equal true
+    end
+
+    it 'should trace a raw GET request' do
+      response = nil
+
+      Oboe::API.start_trace('rest_client_test') do
+        response = RestClient.get 'http://www.appneta.com/products/traceview/?a=1'
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 7
+
+      # 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
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[3]['Layer'].must_equal 'net-http'
+      traces[3]['Label'].must_equal 'info'
+      traces[3]['IsService'].must_equal 1
+      traces[3]['RemoteProtocol'].must_equal 'HTTP'
+      traces[3]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[3]['ServiceArg'].must_equal '/products/traceview/?a=1'
+      traces[3]['HTTPMethod'].must_equal 'GET'
+      traces[3]['HTTPStatus'].must_equal "200"
+      traces[3].key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+
+      traces[4]['Layer'].must_equal 'net-http'
+      traces[4]['Label'].must_equal 'exit'
+
+      traces[5]['Layer'].must_equal 'rest-client'
+      traces[5]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace a raw POST request' do
+      response = nil
+
+      Oboe::API.start_trace('rest_client_test') do
+        response = RestClient.post 'http://www.appneta.com/', :param1 => 'one', :nested => { :param2 => 'two' }
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 7
+
+      # 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
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[3]['Layer'].must_equal 'net-http'
+      traces[3]['Label'].must_equal 'info'
+      traces[3]['IsService'].must_equal 1
+      traces[3]['RemoteProtocol'].must_equal 'HTTP'
+      traces[3]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[3]['ServiceArg'].must_equal '/'
+      traces[3]['HTTPMethod'].must_equal 'POST'
+      traces[3]['HTTPStatus'].must_equal "200"
+      traces[3].key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+
+      traces[4]['Layer'].must_equal 'net-http'
+      traces[4]['Label'].must_equal 'exit'
+
+      traces[5]['Layer'].must_equal 'rest-client'
+      traces[5]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace a ActiveResource style GET request' do
+      response = nil
+
+      Oboe::API.start_trace('rest_client_test') do
+        resource = RestClient::Resource.new 'http://www.appneta.com/products/traceview/?a=1'
+        response = resource.get
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 7
+
+      # 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
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[3]['Layer'].must_equal 'net-http'
+      traces[3]['Label'].must_equal 'info'
+      traces[3]['IsService'].must_equal 1
+      traces[3]['RemoteProtocol'].must_equal 'HTTP'
+      traces[3]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[3]['ServiceArg'].must_equal '/products/traceview/?a=1'
+      traces[3]['HTTPMethod'].must_equal 'GET'
+      traces[3]['HTTPStatus'].must_equal "200"
+      traces[3].key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+
+      traces[4]['Layer'].must_equal 'net-http'
+      traces[4]['Label'].must_equal 'exit'
+
+      traces[5]['Layer'].must_equal 'rest-client'
+      traces[5]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace requests with redirects' do
+      response = nil
+
+      Oboe::API.start_trace('rest_client_test') do
+        resource = RestClient::Resource.new 'http://www.appneta.com/products/traceview?a=1'
+        response = resource.get
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 12
+
+      # 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
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[3]['Layer'].must_equal 'net-http'
+      traces[3]['Label'].must_equal 'info'
+      traces[3]['IsService'].must_equal 1
+      traces[3]['RemoteProtocol'].must_equal 'HTTP'
+      traces[3]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[3]['ServiceArg'].must_equal '/products/traceview?a=1'
+      traces[3]['HTTPMethod'].must_equal 'GET'
+      traces[3]['HTTPStatus'].must_equal "301"
+      traces[3].key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+
+      traces[4]['Layer'].must_equal 'net-http'
+      traces[4]['Label'].must_equal 'exit'
+
+      traces[5]['Layer'].must_equal 'rest-client'
+      traces[5]['Label'].must_equal 'entry'
+
+      traces[6]['Layer'].must_equal 'net-http'
+      traces[6]['Label'].must_equal 'entry'
+
+      traces[7]['Layer'].must_equal 'net-http'
+      traces[7]['Label'].must_equal 'info'
+      traces[7]['IsService'].must_equal 1
+      traces[7]['RemoteProtocol'].must_equal 'HTTP'
+      traces[7]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[7]['ServiceArg'].must_equal '/products/traceview/?a=1'
+      traces[7]['HTTPMethod'].must_equal 'GET'
+      traces[7]['HTTPStatus'].must_equal "200"
+      traces[7].key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
+
+      traces[8]['Layer'].must_equal 'net-http'
+      traces[8]['Label'].must_equal 'exit'
+
+      traces[9]['Layer'].must_equal 'rest-client'
+      traces[9]['Label'].must_equal 'exit'
+
+      traces[10]['Layer'].must_equal 'rest-client'
+      traces[10]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace and capture raised exceptions' do
+      response = nil
+
+      Oboe::API.start_trace('rest_client_test') do
+        begin
+          RestClient.get 'http://s6KTgaz7636z/resource'
+        rescue
+          # We want an exception to be raised.  Just don't raise
+          # it beyond this point.
+        end
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 5
+
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'rest-client'
+      traces[2]['Label'].must_equal 'error'
+      traces[2]['ErrorClass'].must_equal 'SocketError'
+      traces[2].key?('ErrorMsg').must_equal true
+      traces[2].key?('Backtrace').must_equal true
+
+      traces[3]['Layer'].must_equal 'rest-client'
+      traces[3]['Label'].must_equal 'exit'
+    end
+
+    it 'should obey :collect_backtraces setting when true' do
+      Oboe::Config[:rest_client][:collect_backtraces] = true
+
+      Oboe::API.start_trace('rest_client_test') do
+        RestClient.get('http://www.appneta.com', {:a => 1})
+      end
+
+      traces = get_all_traces
+      layer_has_key(traces, 'rest-client', 'Backtrace')
+    end
+
+    it 'should obey :collect_backtraces setting when false' do
+      Oboe::Config[:rest_client][:collect_backtraces] = false
+
+      Oboe::API.start_trace('rest_client_test') do
+        RestClient.get('http://www.appneta.com', {:a => 1})
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'rest-client', 'Backtrace')
+    end
+  end
+end