oboe 2.7.15.1-java → 2.7.16.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3afed3934fb8e52bc451c74b37953f4298626e0
-  data.tar.gz: baf521941261128f4c8981ed13cb1f23e11c759e
+  metadata.gz: 11e535361d6ddf6ec6a8dca58b742b50f42ba114
+  data.tar.gz: ef8bc3bc820153012eba2de3fdbd3eb66c36f90c
 SHA512:
-  metadata.gz: 5a848fd2ad12631d0fe146557c17c96a79bb1bb9ef362a328cf68adfd74ffe7cada93ad02e70c347666c774c47ebd6df72db8a7469f4ea6ce6c713a50d322688
-  data.tar.gz: d6befaa4cbcd6804109bf02192a3c148be4d8bc3d5786b457b4b26372a2e3834c5d25dc9f7de24920193baf88336ef0728ede0440954bcb75d2ef9f22e42ecb2
+  metadata.gz: 0c7b74535912fea2bb7e7a431b1c8e6800fb042f46b43201ee39e8abd202944783cb4a8cd0edf70bb17d578959a4f6e51b214528071306946def97ef771e0d8e
+  data.tar.gz: dde645f8bdc7320d53cfabe2b2fda1deb2dacd5d107f4e81017e688a2402b4f065b1a63823c555ef29d1e8114a10b1744f040087bc301b595d05c2eda127282c

data/.travis.yml

@@ -52,4 +52,7 @@ services:
 
 matrix:
   allow_failures:
+    # FIXME: Until the joboe test reporter supports cross thread
+    # event collection.
+    - rvm: jruby-19mode
 

data/CHANGELOG.md

@@ -4,6 +4,19 @@ https://github.com/appneta/oboe-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# oboe 2.7.16.1
+
+This patch release includes:
+
+* New rest-client instrumentation: #109
+* New excon instrumentation: #114
+* Fix `uninitialized constant` on unsupported platforms: #113
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.16.1
+https://rubygems.org/gems/oboe/versions/2.7.16.1-java
+
 # oboe 2.7.15.1
 
 This patch release includes:

data/Gemfile

@@ -1,10 +1,18 @@
 source 'https://rubygems.org'
 
 group :development, :test do
-  gem 'minitest'
+  gem 'minitest', "5.5.1"
   gem 'minitest-reporters'
   gem 'rack-test'
-  if RUBY_VERSION > '1.8.7'
+  gem 'puma'
+  if RUBY_VERSION < '1.9.3'
+    # i18n 0.7.0 dropped support for Ruby 1.9.2 and older.  ActiveSupport
+    # depends on i18n 0.7.0 since v 4.0.5.  For < 1.9.2 Ruby support, lock
+    # down to these versions to maintain functionality.
+    gem 'i18n', '< 0.7.0'
+    gem 'activesupport', '< 4.0.5'
+    gem 'appraisal'
+  else
     gem 'appraisal'
   end
 end
@@ -33,6 +41,11 @@ gem 'faraday'
 gem 'excon'
 gem 'typhoeus'
 gem 'sequel'
+if RUBY_VERSION >= '1.9.3'
+  # rest-client depends on mime-types gem which only supports
+  # ruby 1.9.3 and up
+  gem 'rest-client'
+end
 
 # Database adapter gems needed by sequel
 if defined?(JRUBY_VERSION)

data/Rakefile

@@ -3,10 +3,7 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'rake/testtask'
-
-if RUBY_VERSION > '1.8.7'
-  require 'appraisal'
-end
+require 'appraisal'
 
 Rake::TestTask.new do |t|
   t.libs << "test"

data/lib/oboe/config.rb

@@ -12,9 +12,10 @@ module Oboe
     @@config = {}
 
     @@instrumentation = [:action_controller, :action_view, :active_record,
-                         :cassandra, :dalli, :em_http_request, :faraday, :grape, :nethttp,
-                         :memcached, :memcache, :mongo, :moped, :rack, :redis, :resque,
-                         :sequel, :typhoeus]
+                         :cassandra, :dalli, :em_http_request, :excon, :faraday,
+                         :grape, :nethttp, :memcached, :memcache, :mongo,
+                         :moped, :rack, :redis, :resque, :rest_client, :sequel,
+                         :typhoeus]
     ##
     # Return the raw nested hash.
     #
@@ -43,6 +44,7 @@ module Oboe
       Oboe::Config[:faraday][:collect_backtraces] = false
       Oboe::Config[:grape][:collect_backtraces] = true
       Oboe::Config[:em_http_request][:collect_backtraces] = false
+      Oboe::Config[:excon][:collect_backtraces] = true
       Oboe::Config[:memcache][:collect_backtraces] = false
       Oboe::Config[:memcached][:collect_backtraces] = false
       Oboe::Config[:mongo][:collect_backtraces] = true
@@ -50,6 +52,7 @@ module Oboe
       Oboe::Config[:nethttp][:collect_backtraces] = true
       Oboe::Config[:redis][:collect_backtraces] = false
       Oboe::Config[:resque][:collect_backtraces] = true
+      Oboe::Config[:rest_client][:collect_backtraces] = false
       Oboe::Config[:sequel][:collect_backtraces] = true
       Oboe::Config[:typhoeus][:collect_backtraces] = false
 

data/lib/oboe/inst/excon.rb

@@ -0,0 +1,110 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module ExconConnection
+      def self.included(klass)
+        ::Oboe::Util.method_alias(klass, :request, ::Excon::Connection)
+        ::Oboe::Util.method_alias(klass, :requests, ::Excon::Connection)
+      end
+
+      def oboe_collect(params)
+        kvs = {}
+        kvs['IsService'] = 1
+        kvs['RemoteProtocol'] = ::Oboe::Util.upcase(@data[:scheme])
+        kvs['RemoteHost'] = @data[:host]
+
+        if @data[:query] && @data[:query].length
+          kvs['ServiceArg'] = @data[:path] + '?' + @data[:query]
+        else
+          kvs['ServiceArg'] = @data[:path]
+        end
+
+        # In the case of HTTP pipelining, params could be an array of
+        # request hashes.
+        if params.is_a?(Array)
+          methods = []
+          params.each do |p|
+            methods << ::Oboe::Util.upcase(p[:method])
+          end
+          kvs['HTTPMethods'] = methods.join(', ')[0..1024]
+          kvs['Pipeline'] = true
+        else
+          kvs['HTTPMethod'] = ::Oboe::Util.upcase(params[:method])
+        end
+        kvs['Backtrace'] = Oboe::API.backtrace if Oboe::Config[:excon][:collect_backtraces]
+        kvs
+      rescue => e
+        Oboe.logger.debug "[oboe/debug] Error capturing excon KVs: #{e.message}"
+        Oboe.logger.debug e.backtrace.join('\n') if ::Oboe::Config[:verbose]
+      end
+
+      def requests_with_oboe(pipeline_params)
+        responses = nil
+        Oboe::API.trace('excon', oboe_collect(pipeline_params)) do
+          responses = requests_without_oboe(pipeline_params)
+        end
+        responses
+      end
+
+      def request_with_oboe(params={}, &block)
+        # If we're not tracing, just do a fast return.
+        # If making HTTP pipeline requests (ordered batched)
+        # then just return as we're tracing from parent
+        # <tt>requests</tt>
+        if !Oboe.tracing? || params[:pipeline]
+          return request_without_oboe(params, &block)
+        end
+
+        begin
+          response_context = nil
+
+          # Avoid cross host tracing for blacklisted domains
+          blacklisted = Oboe::API.blacklisted?(@data[:hostname])
+
+          req_context = Oboe::Context.toString()
+          @data[:headers]['X-Trace'] = req_context unless blacklisted
+
+          kvs = oboe_collect(params)
+          kvs['Blacklisted'] = true if blacklisted
+
+          Oboe::API.log_entry('excon', kvs)
+          kvs.clear
+
+          # The core excon call
+          response = request_without_oboe(params, &block)
+
+          # excon only passes back a hash (datum) for HTTP pipelining...
+          # In that case, we should never arrive here but for the OCD, double check
+          # the datatype before trying to extract pertinent info
+          if response.is_a?(Excon::Response)
+            response_context = response.headers['X-Trace']
+            kvs['HTTPStatus'] = response.status
+
+            # If we get a redirect, report the location header
+            if ((300..308).to_a.include? response.status.to_i) && response.headers.key?("Location")
+              kvs["Location"] = response.headers["Location"]
+            end
+
+            if response_context && !blacklisted
+              Oboe::XTrace.continue_service_context(req_context, response_context)
+            end
+          end
+
+          response
+        rescue => e
+          Oboe::API.log_exception('excon', e)
+          raise e
+        ensure
+          Oboe::API.log_exit('excon', kvs) unless params[:pipeline]
+        end
+      end
+    end
+  end
+end
+
+if Oboe::Config[:excon][:enabled] && defined?(::Excon)
+  ::Oboe.logger.info '[oboe/loading] Instrumenting excon' if Oboe::Config[:verbose]
+  ::Oboe::Util.send_include(::Excon::Connection, ::Oboe::Inst::ExconConnection)
+end

data/lib/oboe/inst/faraday.rb

@@ -8,13 +8,13 @@ module Oboe
       def run_request_with_oboe(method, url, body, headers, &block)
         # Only send service KVs if we're not using the Net::HTTP adapter
         # Otherwise, the Net::HTTP instrumentation will send the service KVs
-        handle_service = !@builder.handlers.include?(Faraday::Adapter::NetHttp)
+        handle_service = !@builder.handlers.include?(Faraday::Adapter::NetHttp) &&
+                          !@builder.handlers.include?(Faraday::Adapter::Excon)
         Oboe::API.log_entry('faraday')
 
         result = run_request_without_oboe(method, url, body, headers, &block)
 
         kvs = {}
-        kvs[:HTTPStatus] = result.status
         kvs['Middleware'] = @builder.handlers
         kvs['Backtrace'] = Oboe::API.backtrace if Oboe::Config[:faraday][:collect_backtraces]
 
@@ -33,6 +33,7 @@ module Oboe
           kvs['RemotePort'] = @url_prefix.port
           kvs['ServiceArg'] = url
           kvs['HTTPMethod'] = method
+          kvs[:HTTPStatus] = result.status
           kvs['Blacklisted'] = true if blacklisted
 
           # Re-attach net::http edge unless it's blacklisted or if we don't have a

data/lib/oboe/inst/http.rb

@@ -7,13 +7,13 @@ if Oboe::Config[:nethttp][:enabled]
 
   Net::HTTP.class_eval do
     def request_with_oboe(*args, &block)
-      unless started?
+      # If we're not tracing, just do a fast return. Since
+      # net/http.request calls itself, only trace
+      # once the http session has been started.
+      if !Oboe.tracing? || !started?
         return request_without_oboe(*args, &block)
       end
 
-      # If we're not tracing, just do a fast return
-      return request_without_oboe(*args, &block) unless Oboe.tracing?
-
       # Avoid cross host tracing for blacklisted domains
       blacklisted = Oboe::API.blacklisted?(addr_port)
 
@@ -46,7 +46,7 @@ if Oboe::Config[:nethttp][:enabled]
             xtrace = resp.get_fields('X-Trace')
             xtrace = xtrace[0] if xtrace && xtrace.is_a?(Array)
 
-            if Oboe::XTrace.valid?(xtrace) && Oboe.tracing?
+            if Oboe::XTrace.valid?(xtrace)
 
               # Assure that we received back a valid X-Trace with the same task_id
               if task_id == Oboe::XTrace.task_id(xtrace)
@@ -59,6 +59,11 @@ if Oboe::Config[:nethttp][:enabled]
 
           opts['HTTPStatus'] = resp.code
 
+          # If we get a redirect, report the location header
+          if ((300..308).to_a.include? resp.code.to_i) && resp.header["Location"]
+            opts["Location"] = resp.header["Location"]
+          end
+
           next resp
         ensure
           # Log the info event with the KVs in opts

data/lib/oboe/inst/rest-client.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module RestClientRequest
+      def self.included(klass)
+        ::Oboe::Util.method_alias(klass, :execute, ::RestClient::Request)
+      end
+
+      ##
+      # execute_with_oboe
+      #
+      # The wrapper method for RestClient::Request.execute
+      #
+      def execute_with_oboe & block
+        kvs = {}
+        kvs['Backtrace'] = Oboe::API.backtrace if Oboe::Config[:rest_client][:collect_backtraces]
+        Oboe::API.log_entry("rest-client", kvs)
+
+        # The core rest-client call
+        execute_without_oboe(&block)
+      rescue => e
+        Oboe::API.log_exception('rest-client', e)
+        raise e
+      ensure
+        Oboe::API.log_exit("rest-client")
+      end
+    end
+  end
+end
+
+if Oboe::Config[:rest_client][:enabled]
+  if defined?(::RestClient)
+    Oboe.logger.info '[oboe/loading] Instrumenting rest-client' if Oboe::Config[:verbose]
+    ::Oboe::Util.send_include(::RestClient::Request, ::Oboe::Inst::RestClientRequest)
+  end
+end

data/lib/oboe/inst/sequel.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
 module Oboe
   module Inst
     module Sequel

data/lib/oboe/inst/typhoeus.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
 module Oboe
   module Inst
     module TyphoeusRequestOps
@@ -30,11 +33,11 @@ module Oboe
 
         uri = URI(response.effective_url)
         kvs['IsService'] = 1
-        kvs['RemoteProtocol'] = uri.scheme
+        kvs['RemoteProtocol'] = ::Oboe::Util.upcase(uri.scheme)
         kvs['RemoteHost'] = uri.host
         kvs['RemotePort'] = uri.port ? uri.port : 80
         kvs['ServiceArg'] = uri.path
-        kvs['HTTPMethod'] = options[:method]
+        kvs['HTTPMethod'] = ::Oboe::Util.upcase(options[:method])
         kvs['Blacklisted'] = true if blacklisted
 
         # Re-attach net::http edge unless it's blacklisted or if we don't have a

data/lib/oboe/ruby.rb

@@ -19,8 +19,13 @@ module Oboe
       # will instead be detected at load time and initialization is
       # automatic.
       def load
-        Oboe::Loading.load_access_key
-        Oboe::Inst.load_instrumentation
+        # In case some apps call this manually, make sure
+        # that the gem is fully loaded and not in no-op
+        # mode (e.g. on unsupported platforms etc.)
+        if Oboe.loaded
+          Oboe::Loading.load_access_key
+          Oboe::Inst.load_instrumentation
+        end
       end
     end
   end

data/lib/oboe/util.rb

@@ -122,6 +122,22 @@ module Oboe
         end
       end
 
+      ##
+      # upcase
+      #
+      # Occasionally, we want to send some values in all caps.  This is true
+      # for things like HTTP scheme or method.  This takes anything and does
+      # it's best to safely convert it to a string (if needed) and convert it
+      # to all uppercase.
+      def upcase(o)
+        if o.is_a?(String) || o.respond_to?(:to_s)
+          o.to_s.upcase
+        else
+          Oboe.logger.debug "[oboe/debug] Oboe::Util.upcase: could not convert #{o.class}"
+          "UNKNOWN"
+        end
+      end
+
       ##
       #  build_report
       #
@@ -154,14 +170,16 @@ module Oboe
           end
 
           # Report the instrumented libraries
-          platform_info['Ruby.Cassandra.Version'] = "Cassandra-#{::Cassandra.VERSION}" if defined?(::Cassandra)
-          platform_info['Ruby.Dalli.Version']     = "Dalli-#{::Dalli::VERSION}"        if defined?(::Dalli)
-          platform_info['Ruby.Faraday.Version']   = "Faraday-#{::Faraday::VERSION}"    if defined?(::Faraday)
-          platform_info['Ruby.MemCache.Version']  = "MemCache-#{::MemCache::VERSION}"  if defined?(::MemCache)
-          platform_info['Ruby.Moped.Version']     = "Moped-#{::Moped::VERSION}"        if defined?(::Moped)
-          platform_info['Ruby.Redis.Version']     = "Redis-#{::Redis::VERSION}"        if defined?(::Redis)
-          platform_info['Ruby.Resque.Version']    = "Resque-#{::Resque::VERSION}"      if defined?(::Resque)
-          platform_info['Ruby.Typhoeus.Version']  = "Typhoeus-#{::Typhoeus::VERSION}"  if defined?(::Typhoeus::VERSION)
+          platform_info['Ruby.Cassandra.Version']  = "Cassandra-#{::Cassandra.VERSION}"    if defined?(::Cassandra)
+          platform_info['Ruby.Dalli.Version']      = "Dalli-#{::Dalli::VERSION}"           if defined?(::Dalli)
+          platform_info['Ruby.Excon.Version']      = "Excon-#{::Excon::VERSION}"           if defined?(::Excon::VERSION)
+          platform_info['Ruby.Faraday.Version']    = "Faraday-#{::Faraday::VERSION}"       if defined?(::Faraday)
+          platform_info['Ruby.MemCache.Version']   = "MemCache-#{::MemCache::VERSION}"     if defined?(::MemCache)
+          platform_info['Ruby.Moped.Version']      = "Moped-#{::Moped::VERSION}"           if defined?(::Moped)
+          platform_info['Ruby.Redis.Version']      = "Redis-#{::Redis::VERSION}"           if defined?(::Redis)
+          platform_info['Ruby.Resque.Version']     = "Resque-#{::Resque::VERSION}"         if defined?(::Resque)
+          platform_info['Ruby.RestClient.Version'] = "RestClient-#{::RestClient::VERSION}" if defined?(::RestClient::VERSION)
+          platform_info['Ruby.Typhoeus.Version']   = "Typhoeus-#{::Typhoeus::VERSION}"     if defined?(::Typhoeus::VERSION)
 
           # Special case since the Mongo 1.x driver doesn't embed the version number in the gem directly
           if ::Gem.loaded_specs.key?('mongo')
@@ -189,7 +207,7 @@ module Oboe
             platform_info['Ruby.AppContainer.Version'] = "Mongrel2-#{::Mongrel2::VERSION}"
           elsif defined?(::Trinidad)
             platform_info['Ruby.AppContainer.Version'] = "Trinidad-#{::Trinidad::VERSION}"
-          elsif defined?(::WEBrick)
+          elsif defined?(::WEBrick::VERSION)
             platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"
           else
             platform_info['Ruby.AppContainer.Version'] = File.basename($PROGRAM_NAME)

data/lib/oboe/version.rb

@@ -8,7 +8,7 @@ module Oboe
   module Version
     MAJOR = 2
     MINOR = 7
-    PATCH = 15
+    PATCH = 16
     BUILD = 1
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')