oboe 2.7.1.7 → 2.7.2.fuchs1

data/lib/oboe/thread_local.rb

@@ -2,6 +2,14 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # Provides thread local storage for Oboe.
+  #
+  # Example usage:
+  # module OboeBase
+  #   extend ::Oboe::ThreadLocal
+  #   thread_local :layer_op
+  # end
   module ThreadLocal
     def thread_local(name)
       key = "__#{self}_#{name}__".intern
@@ -10,7 +18,7 @@ module Oboe
         Thread.current[key]
       end
 
-      define_method(name.to_s + "=") do |value|
+      define_method(name.to_s + '=') do |value|
         Thread.current[key] = value
       end
     end

data/lib/oboe/util.rb

@@ -2,6 +2,9 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # Provides utility methods for use while in the business
+  # of instrumenting code
   module Util
     class << self
       def contextual_name(cls)
@@ -11,10 +14,9 @@ module Oboe
         # ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.to_s.split(/::/).last
         # => "AbstractMysqlAdapter"
         #
-        begin
-          cls.to_s.split(/::/).last
-        rescue
-        end
+        cls.to_s.split(/::/).last
+      rescue
+        cls
       end
 
       ##
@@ -23,10 +25,10 @@ module Oboe
       # Centralized utility method to alias a method on an arbitrary
       # class or module.
       #
-      def method_alias(cls, method, name=nil)
+      def method_alias(cls, method, name = nil)
         name ||= contextual_name(cls)
 
-        if cls.method_defined? method.to_sym or cls.private_method_defined? method.to_sym
+        if cls.method_defined?(method.to_sym) || cls.private_method_defined?(method.to_sym)
 
           # Strip '!' or '?' from method if present
           safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
@@ -36,8 +38,8 @@ module Oboe
           with_oboe    = "#{safe_method_name}_with_oboe"
 
           # Only alias if we haven't done so already
-          unless cls.method_defined? without_oboe.to_sym or
-            cls.private_method_defined? without_oboe.to_sym
+          unless cls.method_defined?(without_oboe.to_sym) ||
+            cls.private_method_defined?(without_oboe.to_sym)
 
             cls.class_eval do
               alias_method without_oboe, "#{method}"
@@ -54,7 +56,7 @@ module Oboe
       # Centralized utility method to alias a class method on an arbitrary
       # class or module
       #
-      def class_method_alias(cls, method, name=nil)
+      def class_method_alias(cls, method, name = nil)
         name ||= contextual_name(cls)
 
         if cls.singleton_methods.include? method.to_sym
@@ -81,9 +83,7 @@ module Oboe
       # Centralized utility method to send an extend call for an
       # arbitrary class
       def send_extend(target_cls, cls)
-        if defined?(target_cls)
-          target_cls.send(:extend, cls)
-        end
+        target_cls.send(:extend, cls) if defined?(target_cls)
       end
 
       ##
@@ -92,9 +92,7 @@ module Oboe
       # Centralized utility method to send a include call for an
       # arbitrary class
       def send_include(target_cls, cls)
-        if defined?(target_cls)
-          target_cls.send(:include, cls)
-        end
+        target_cls.send(:include, cls) if defined?(target_cls)
       end
 
       ##
@@ -104,7 +102,7 @@ module Oboe
       # solely on filename)
       #
       def static_asset?(path)
-        return (path =~ /\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$/i)
+        (path =~ /\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$/i)
       end
 
       ##
@@ -112,7 +110,7 @@ module Oboe
       #
       # Even to my surprise, 'prettify' is a real word:
       # transitive v. To make pretty or prettier, especially in a superficial or insubstantial way.
-      #   from The American Heritage® Dictionary of the English Language, 4th Edition
+      #   from The American Heritage Dictionary of the English Language, 4th Edition
       #
       # This method makes things 'purty' for reporting.
       def prettify(x)
@@ -123,7 +121,81 @@ module Oboe
         end
       end
 
+      ##
+      #  build_report
+      #
+      # Internal: Build a hash of KVs that reports on the status of the
+      # running environment.
+      def build_report
+        platform_info = { '__Init' => 1 }
+
+        begin
+          platform_info['Force']                   = true
+          platform_info['Ruby.Platform.Version']   = RUBY_PLATFORM
+          platform_info['Ruby.Version']            = RUBY_VERSION
+          platform_info['Ruby.Oboe.Version']       = ::Oboe::Version::STRING
+          platform_info['RubyHeroku.Oboe.Version'] = ::OboeHeroku::Version::STRING if defined?(::OboeHeroku)
+
+          # Report the framework in use
+          if defined?(::RailsLts)
+            platform_info['Ruby.RailsLts.Version'] = "RailsLts-#{::RailsLts::VERSION}"
+          elsif defined?(::Rails)
+            platform_info['Ruby.Rails.Version']    = "Rails-#{::Rails.version}"
+          end
+          platform_info['Ruby.Grape.Version']    = "Grape-#{::Grape::VERSION}" if defined?(::Grape)
+          platform_info['Ruby.Cramp.Version']    = "Cramp-#{::Cramp::VERSION}" if defined?(::Cramp)
+
+          if defined?(::Padrino)
+            platform_info['Ruby.Padrino.Version'] = "Padrino-#{::Padrino::VERSION}"
+          elsif defined?(::Sinatra)
+            platform_info['Ruby.Sinatra.Version'] = "Sinatra-#{::Sinatra::VERSION}"
+          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.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)
+
+          # Special case since the Mongo 1.x driver doesn't embed the version number in the gem directly
+          if ::Gem.loaded_specs.key?('mongo')
+            platform_info['Ruby.Mongo.Version']     = "Mongo-#{::Gem.loaded_specs['mongo'].version}"
+          end
+
+          # Report the server in use (if possible)
+          if defined?(::Unicorn)
+            platform_info['Ruby.AppContainer.Version'] = "Unicorn-#{::Unicorn::Const::UNICORN_VERSION}"
+          elsif defined?(::Puma)
+            platform_info['Ruby.AppContainer.Version'] = "Puma-#{::Puma::Const::PUMA_VERSION} (#{::Puma::Const::CODE_NAME})"
+          elsif defined?(::PhusionPassenger)
+            platform_info['Ruby.AppContainer.Version'] = "#{::PhusionPassenger::PACKAGE_NAME}-#{::PhusionPassenger::VERSION_STRING}"
+          elsif defined?(::Thin)
+            platform_info['Ruby.AppContainer.Version'] = "Thin-#{::Thin::VERSION::STRING} (#{::Thin::VERSION::CODENAME})"
+          elsif defined?(::Mongrel)
+            platform_info['Ruby.AppContainer.Version'] = "Mongrel-#{::Mongrel::Const::MONGREL_VERSION}"
+          elsif defined?(::Mongrel2)
+            platform_info['Ruby.AppContainer.Version'] = "Mongrel2-#{::Mongrel2::VERSION}"
+          elsif defined?(::Trinidad)
+            platform_info['Ruby.AppContainer.Version'] = "Trinidad-#{::Trinidad::VERSION}"
+          elsif defined?(::WEBrick)
+            platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"
+          else
+            platform_info['Ruby.AppContainer.Version'] = File.basename($PROGRAM_NAME)
+          end
+
+        rescue StandardError, ScriptError => e
+          # Also rescue ScriptError (aka SyntaxError) in case one of the expected
+          # version defines don't exist
+
+          platform_info['Error'] = "Error in build_report: #{e.message}"
+
+          Oboe.logger.debug "Error in build_report: #{e.message}"
+          Oboe.logger.debug e.backtrace
+        end
+        platform_info
+      end
     end
   end
 end
-

data/lib/oboe/version.rb

@@ -2,11 +2,14 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # The current version of the gem.  Used mainly by
+  # oboe.gemspec during gem build process
   module Version
     MAJOR = 2
     MINOR = 7
-    PATCH = 1
-    BUILD = 7
+    PATCH = 2
+    BUILD = "fuchs1"
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end

data/lib/oboe/xtrace.rb

@@ -2,31 +2,31 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # Methods to act on, manipulate or investigate an X-Trace
+  # value
   module XTrace
     class << self
-
       ##
       #  Oboe::XTrace.valid?
       #
       #  Perform basic validation on a potential X-Trace ID
       #
       def valid?(xtrace)
-        begin
-          # Shouldn't be nil
-          return false unless xtrace
+        # Shouldn't be nil
+        return false unless xtrace
 
-          # The X-Trace ID shouldn't be an initialized empty ID
-          return false if (xtrace =~ /^1b0000000/i) == 0
+        # The X-Trace ID shouldn't be an initialized empty ID
+        return false if (xtrace =~ /^1b0000000/i) == 0
 
-          # Valid X-Trace IDs have a length of 58 bytes and start with '1b'
-          return false unless xtrace.length == 58 and (xtrace =~ /^1b/i) == 0
+        # Valid X-Trace IDs have a length of 58 bytes and start with '1b'
+        return false unless xtrace.length == 58 && (xtrace =~ /^1b/i) == 0
 
-          true
-        rescue StandardError => e
-          Oboe.logger.debug e.message
-          Oboe.logger.debug e.backtrace
-          false
-        end
+        true
+      rescue StandardError => e
+        Oboe.logger.debug e.message
+        Oboe.logger.debug e.backtrace
+        false
       end
 
       ##
@@ -35,18 +35,14 @@ module Oboe
       # Extract and return the task_id portion of an X-Trace ID
       #
       def task_id(xtrace)
-        begin
-          return nil unless Oboe::XTrace.valid?(xtrace)
+        return nil unless Oboe::XTrace.valid?(xtrace)
 
-          xtrace[2..41]
-        rescue StandardError => e
-          Oboe.logger.debug e.message
-          Oboe.logger.debug e.backtrace
-          return nil
-        end
+        xtrace[2..41]
+      rescue StandardError => e
+        Oboe.logger.debug e.message
+        Oboe.logger.debug e.backtrace
+        return nil
       end
-
     end
   end
 end
-

data/lib/oboe_metal.rb

@@ -1,6 +1,9 @@
 # Copyright (c) 2013 AppNeta, Inc.
 # All rights reserved.
 
+# Disable docs and Camelcase warns since we're implementing
+# an interface here.  See OboeBase for details.
+# rubocop:disable Style/Documentation, Style/MethodName
 module Oboe
   extend OboeBase
   include Oboe_metal
@@ -13,21 +16,21 @@ module Oboe
       return unless Oboe.loaded
 
       begin
-        Oboe_metal::Context.init()
+        Oboe_metal::Context.init
 
-        if ENV.has_key?("OBOE_GEM_TEST")
-          Oboe.reporter = Oboe::FileReporter.new("/tmp/trace_output.bson")
+        if ENV.key?('OBOE_GEM_TEST')
+          Oboe.reporter = Oboe::FileReporter.new('/tmp/trace_output.bson')
         else
           Oboe.reporter = Oboe::UdpReporter.new(Oboe::Config[:reporter_host], Oboe::Config[:reporter_port])
         end
 
         # Only report __Init from here if we are not instrumenting a framework.
         # Otherwise, frameworks will handle reporting __Init after full initialization
-        unless defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino) or defined?(::Grape)
+        unless defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
           Oboe::API.report_init
         end
 
-      rescue Exception => e
+      rescue => e
         $stderr.puts e.message
         raise
       end
@@ -52,7 +55,7 @@ module Oboe
     # Retrieves all traces written to the trace file
     #
     def self.get_all_traces
-      io = File.open($trace_file, "r")
+      io = File.open($trace_file, 'r')
       contents = io.readlines(nil)
 
       return contents if contents.empty?
@@ -75,7 +78,7 @@ module Oboe
 
   class Event
     def self.metadataString(evt)
-      evt.metadataString()
+      evt.metadataString
     end
   end
 
@@ -92,7 +95,7 @@ module Oboe
         rv = Oboe::Context.sampleRequest(layer, xtrace, tv_meta)
 
         # For older liboboe that returns true/false, just return that.
-        return rv if [TrueClass, FalseClass].include?(rv.class) or (rv == 0)
+        return rv if [TrueClass, FalseClass].include?(rv.class) || (rv == 0)
 
         # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
         # source embedded
@@ -126,13 +129,13 @@ module Oboe
     end
 
     def set_sample_rate(rate)
-      if Oboe.loaded
-        # Update liboboe with the new SampleRate value
-        Oboe::Context.setDefaultSampleRate(rate.to_i)
-      end
+      return unless Oboe.loaded
+
+      # Update liboboe with the new SampleRate value
+      Oboe::Context.setDefaultSampleRate(rate.to_i)
     end
   end
 end
+# rubocop:enable Style/Documentation
 
 Oboe.loaded = true
-

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -52,6 +52,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:action_view][:enabled] = true
   # Oboe::Config[:cassandra][:enabled] = true
   # Oboe::Config[:dalli][:enabled] = true
+  # Oboe::Config[:faraday][:enabled] = true
   # Oboe::Config[:memcache][:enabled] = true
   # Oboe::Config[:memcached][:enabled] = true
   # Oboe::Config[:mongo][:enabled] = true
@@ -74,6 +75,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:action_view][:collect_backtraces] = true
   # Oboe::Config[:cassandra][:collect_backtraces] = true
   # Oboe::Config[:dalli][:collect_backtraces] = false
+  # Oboe::Config[:faraday][:collect_backtraces] = false
   # Oboe::Config[:memcache][:collect_backtraces] = false
   # Oboe::Config[:memcached][:collect_backtraces] = false
   # Oboe::Config[:mongo][:collect_backtraces] = true

data/test/instrumentation/faraday_test.rb

@@ -0,0 +1,142 @@
+require 'minitest_helper'
+
+describe Oboe::Inst::FaradayConnection do
+  before do
+    clear_all_traces
+    @collect_backtraces = Oboe::Config[:faraday][:collect_backtraces]
+  end
+
+  after do
+    Oboe::Config[:faraday][:collect_backtraces] = @collect_backtraces
+  end
+
+  it 'Faraday should be defined and ready' do
+    defined?(::Faraday).wont_match nil
+  end
+
+  it 'Faraday should have oboe methods defined' do
+    [ :run_request_with_oboe ].each do |m|
+      ::Faraday::Connection.method_defined?(m).must_equal true
+    end
+  end
+
+  it "should trace a Faraday request to an instr'd app" do
+    Oboe::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://www.appneta.com') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      response = conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 7
+
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
+
+    traces[3]['Layer'].must_equal 'net-http'
+    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 '/?q=ruby_test_suite'
+    traces[3]['HTTPMethod'].must_equal 'GET'
+    traces[3]['HTTPStatus'].must_equal '200'
+
+    traces[4]['Layer'].must_equal 'net-http'
+    traces[4]['Label'].must_equal 'exit'
+
+    traces[5]['Layer'].must_equal 'faraday'
+    traces[5]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a Faraday request' do
+    Oboe::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      response = conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 7
+
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
+
+    traces[3]['Layer'].must_equal 'net-http'
+    traces[3]['IsService'].must_equal '1'
+    traces[3]['RemoteProtocol'].must_equal 'HTTP'
+    traces[3]['RemoteHost'].must_equal 'www.google.com'
+    traces[3]['ServiceArg'].must_equal '/?q=ruby_test_suite'
+    traces[3]['HTTPMethod'].must_equal 'GET'
+    traces[3]['HTTPStatus'].must_equal '200'
+
+    traces[4]['Layer'].must_equal 'net-http'
+    traces[4]['Label'].must_equal 'exit'
+
+    traces[5]['Layer'].must_equal 'faraday'
+    traces[5]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a Faraday with an alternate adapter' do
+    Oboe::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+        faraday.adapter :excon
+      end
+      response = conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 5
+
+    validate_outer_layers(traces, 'faraday_test')
+
+    traces[1]['Layer'].must_equal 'faraday'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:faraday][:collect_backtraces]
+
+    traces[1]['IsService'].must_equal '1'
+    traces[1]['RemoteProtocol'].must_equal 'HTTP'
+    traces[1]['RemoteHost'].must_equal 'www.google.com'
+    traces[1]['ServiceArg'].must_equal '/?q=ruby_test_suite'
+    traces[1]['HTTPMethod'].downcase.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]['Label'].must_equal 'exit'
+  end
+
+  it 'should obey :collect_backtraces setting when true' do
+    Oboe::Config[:faraday][:collect_backtraces] = true
+
+    Oboe::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      response = conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'faraday', 'Backtrace')
+  end
+
+  it 'should obey :collect_backtraces setting when false' do
+    Oboe::Config[:faraday][:collect_backtraces] = false
+
+    Oboe::API.start_trace('faraday_test') do
+      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      response = conn.get '/?q=ruby_test_suite'
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'faraday', 'Backtrace')
+  end
+end