oboe 2.7.1.7-java → 2.7.2.2-java

data/lib/oboe/inst/rack.rb

@@ -24,17 +24,17 @@ module Oboe
         report_kvs['AJAX']             = true if req.xhr?
         report_kvs['ClientIP']         = req.ip
 
-        report_kvs['X-TV-Meta']         = env['HTTP_X_TV_META']          if env.has_key?('HTTP_X_TV_META')
+        report_kvs['X-TV-Meta']         = env['HTTP_X_TV_META']          if env.key?('HTTP_X_TV_META')
 
         # Report any request queue'ing headers.  Report as 'Request-Start' or the summed Queue-Time
-        report_kvs['Request-Start']     = env['HTTP_X_REQUEST_START']    if env.has_key?('HTTP_X_REQUEST_START')
-        report_kvs['Request-Start']     = env['HTTP_X_QUEUE_START']      if env.has_key?('HTTP_X_QUEUE_START')
-        report_kvs['Queue-Time']        = env['HTTP_X_QUEUE_TIME']       if env.has_key?('HTTP_X_QUEUE_TIME')
+        report_kvs['Request-Start']     = env['HTTP_X_REQUEST_START']    if env.key?('HTTP_X_REQUEST_START')
+        report_kvs['Request-Start']     = env['HTTP_X_QUEUE_START']      if env.key?('HTTP_X_QUEUE_START')
+        report_kvs['Queue-Time']        = env['HTTP_X_QUEUE_TIME']       if env.key?('HTTP_X_QUEUE_TIME')
 
-        report_kvs['Forwarded-For']     = env['HTTP_X_FORWARDED_FOR']    if env.has_key?('HTTP_X_FORWARDED_FOR')
-        report_kvs['Forwarded-Host']    = env['HTTP_X_FORWARDED_HOST']   if env.has_key?('HTTP_X_FORWARDED_HOST')
-        report_kvs['Forwarded-Proto']   = env['HTTP_X_FORWARDED_PROTO']  if env.has_key?('HTTP_X_FORWARDED_PROTO')
-        report_kvs['Forwarded-Port']    = env['HTTP_X_FORWARDED_PORT']   if env.has_key?('HTTP_X_FORWARDED_PORT')
+        report_kvs['Forwarded-For']     = env['HTTP_X_FORWARDED_FOR']    if env.key?('HTTP_X_FORWARDED_FOR')
+        report_kvs['Forwarded-Host']    = env['HTTP_X_FORWARDED_HOST']   if env.key?('HTTP_X_FORWARDED_HOST')
+        report_kvs['Forwarded-Proto']   = env['HTTP_X_FORWARDED_PROTO']  if env.key?('HTTP_X_FORWARDED_PROTO')
+        report_kvs['Forwarded-Port']    = env['HTTP_X_FORWARDED_PORT']   if env.key?('HTTP_X_FORWARDED_PORT')
 
         report_kvs['Ruby.Oboe.Version'] = ::Oboe::Version::STRING
       rescue StandardError => e
@@ -64,7 +64,7 @@ module Oboe
 
         if Oboe.tracing?
           report_kvs = collect(req, env)
-          Oboe::API.log(nil, 'info', report_kvs.merge!({ :Status => status }))
+          Oboe::API.log(nil, 'info', report_kvs.merge!(:Status => status))
         end
 
         [status, headers, response]
@@ -73,9 +73,8 @@ module Oboe
       xtrace = e.instance_variable_get(:@xtrace)
       raise
     ensure
-      result[1]['X-Trace'] = xtrace if result and Oboe::XTrace.valid?(xtrace)
+      result[1]['X-Trace'] = xtrace if result && Oboe::XTrace.valid?(xtrace)
       return result
     end
   end
 end
-

data/lib/oboe/inst/redis.rb

@@ -6,9 +6,9 @@ module Oboe
     module Redis
       module Client
         # The operations listed in this constant skip collecting KVKey
-        NO_KEY_OPS = [ :keys, :randomkey, :scan, :sdiff, :sdiffstore, :sinter,
-                       :sinterstore, :smove, :sunion, :sunionstore, :zinterstore,
-                       :zunionstore, :publish, :select, :eval, :evalsha, :script ]
+        NO_KEY_OPS = [:keys, :randomkey, :scan, :sdiff, :sdiffstore, :sinter,
+                      :sinterstore, :smove, :sunion, :sunionstore, :zinterstore,
+                      :zunionstore, :publish, :select, :eval, :evalsha, :script]
 
         # Instead of a giant switch statement, we use a hash constant to map out what
         # KVs need to be collected for each of the many many Redis operations
@@ -38,7 +38,7 @@ module Oboe
           :smove           => { :source    => 1, :destination => 2 },
           :bitop           => { :operation => 1, :destkey     => 2 },
           :hincrbyfloat    => { :field     => 2, :increment   => 3 },
-          :zremrangebyrank => { :start     => 2, :stop        => 3 },
+          :zremrangebyrank => { :start     => 2, :stop        => 3 }
         }
 
         # The following operations don't require any special handling. For these,
@@ -78,7 +78,7 @@ module Oboe
             kvs[:KVOp] = command[0]
             kvs[:RemoteHost] = @options[:host]
 
-            unless NO_KEY_OPS.include? op or (command[1].is_a?(Array) and command[1].count > 1)
+            unless NO_KEY_OPS.include?(op) || (command[1].is_a?(Array) && command[1].count > 1)
               if command[1].is_a?(Array)
                 kvs[:KVKey] = command[1].first
               else
@@ -98,10 +98,10 @@ module Oboe
               when :set
                 if command.count > 3
                   options = command[3]
-                  kvs[:ex] = options[:ex] if options.has_key?(:ex)
-                  kvs[:px] = options[:px] if options.has_key?(:px)
-                  kvs[:nx] = options[:nx] if options.has_key?(:nx)
-                  kvs[:xx] = options[:xx] if options.has_key?(:xx)
+                  kvs[:ex] = options[:ex] if options.key?(:ex)
+                  kvs[:px] = options[:px] if options.key?(:px)
+                  kvs[:nx] = options[:nx] if options.key?(:nx)
+                  kvs[:xx] = options[:xx] if options.key?(:xx)
                 end
 
               when :get
@@ -115,7 +115,7 @@ module Oboe
 
               when :eval
                 if command[1].length > 1024
-                  kvs[:Script] = command[1][0..1023] + "(...snip...)"
+                  kvs[:Script] = command[1][0..1023] + '(...snip...)'
                 else
                   kvs[:Script] = command[1]
                 end
@@ -123,9 +123,9 @@ module Oboe
               when :script
                 kvs[:subcommand] = command[1]
                 kvs[:Backtrace] = Oboe::API.backtrace if Oboe::Config[:redis][:collect_backtraces]
-                if command[1] == "load"
+                if command[1] == 'load'
                   if command[1].length > 1024
-                    kvs[:Script] = command[2][0..1023] + "(...snip...)"
+                    kvs[:Script] = command[2][0..1023] + '(...snip...)'
                   else
                     kvs[:Script] = command[2]
                   end
@@ -143,12 +143,12 @@ module Oboe
                 else
                   kvs[:KVKeyCount] = command.count - 1
                 end
-                values = r.select{ |i| i }
+                values = r.select { |i| i }
                 kvs[:KVHitCount] = values.count
 
               when :hmget
                 kvs[:KVKeyCount] = command.count - 2
-                values = r.select{ |i| i }
+                values = r.select { |i| i }
                 kvs[:KVHitCount] = values.count
 
               when :mset, :msetnx
@@ -162,7 +162,7 @@ module Oboe
 
           rescue StandardError => e
             Oboe.logger.debug "Error collecting redis KVs: #{e.message}"
-            Oboe.logger.debug e.backtrace.join("\n")
+            Oboe.logger.debug e.backtrace.join('\n')
           end
 
           kvs
@@ -196,7 +196,7 @@ module Oboe
               pipeline.commands.each do |c|
                 ops << c.first
               end
-              kvs[:KVOps] = ops.join(", ")
+              kvs[:KVOps] = ops.join(', ')
             end
           rescue StandardError => e
             Oboe.logger.debug "[oboe/debug] Error extracting pipelined commands: #{e.message}"
@@ -236,8 +236,6 @@ module Oboe
         #
         def call_pipeline_with_oboe(pipeline)
           if Oboe.tracing?
-            report_kvs = {}
-
             # Fall back to the raw tracing API so we can pass KVs
             # back on exit (a limitation of the Oboe::API.trace
             # block method)  This removes the need for an info
@@ -265,8 +263,8 @@ module Oboe
 end
 
 if Oboe::Config[:redis][:enabled]
-  if defined?(::Redis) and Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('3.0.0')
-    Oboe.logger.info "[oboe/loading] Instrumenting redis" if Oboe::Config[:verbose]
+  if defined?(::Redis) && Gem::Version.new(::Redis::VERSION) >= Gem::Version.new('3.0.0')
+    Oboe.logger.info '[oboe/loading] Instrumenting redis' if Oboe::Config[:verbose]
     ::Oboe::Util.send_include(::Redis::Client, ::Oboe::Inst::Redis::Client)
   end
 end

data/lib/oboe/inst/resque.rb

@@ -7,7 +7,6 @@ require 'json'
 module Oboe
   module Inst
     module Resque
-
       def self.included(base)
         base.send :extend, ::Resque
       end
@@ -42,7 +41,7 @@ module Oboe
           report_kvs = extract_trace_details(:enqueue, klass, args)
 
           Oboe::API.trace('resque-client', report_kvs, :enqueue) do
-            args.push({:parent_trace_id => Oboe::Context.toString}) if Oboe::Config[:resque][:link_workers]
+            args.push(:parent_trace_id => Oboe::Context.toString) if Oboe::Config[:resque][:link_workers]
             enqueue_without_oboe(klass, *args)
           end
         else
@@ -51,12 +50,12 @@ module Oboe
       end
 
       def enqueue_to_with_oboe(queue, klass, *args)
-        if Oboe.tracing? and not Oboe.tracing_layer_op?(:enqueue)
+        if Oboe.tracing? && !Oboe.tracing_layer_op?(:enqueue)
           report_kvs = extract_trace_details(:enqueue_to, klass, args)
           report_kvs[:Queue] = queue.to_s if queue
 
           Oboe::API.trace('resque-client', report_kvs) do
-            args.push({:parent_trace_id => Oboe::Context.toString}) if Oboe::Config[:resque][:link_workers]
+            args.push(:parent_trace_id => Oboe::Context.toString) if Oboe::Config[:resque][:link_workers]
             enqueue_to_without_oboe(queue, klass, *args)
           end
         else
@@ -112,7 +111,7 @@ module Oboe
         rescue
         end
 
-        if last_arg.is_a?(Hash) and last_arg.has_key?('parent_trace_id')
+        if last_arg.is_a?(Hash) && last_arg.key?('parent_trace_id')
           begin
             # Since the enqueue was traced, we force trace the actual job execution and reference
             # the enqueue trace with ParentTraceID
@@ -148,12 +147,12 @@ module Oboe
 end
 
 if defined?(::Resque)
-  Oboe.logger.info "[oboe/loading] Instrumenting resque" if Oboe::Config[:verbose]
+  Oboe.logger.info '[oboe/loading] Instrumenting resque' if Oboe::Config[:verbose]
 
   ::Resque.module_eval do
     include Oboe::Inst::Resque
 
-    [ :enqueue, :enqueue_to, :dequeue ].each do |m|
+    [:enqueue, :enqueue_to, :dequeue].each do |m|
       if method_defined?(m)
         module_eval "alias #{m}_without_oboe #{m}"
         module_eval "alias #{m} #{m}_with_oboe"
@@ -171,7 +170,7 @@ if defined?(::Resque)
         alias perform_without_oboe perform
         alias perform perform_with_oboe
       elsif Oboe::Config[:verbose]
-        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument ResqueWorker (perform).  Partial traces may occur."
+        Oboe.logger.warn '[oboe/loading] Couldn\'t properly instrument ResqueWorker (perform).  Partial traces may occur.'
       end
     end
   end
@@ -184,7 +183,7 @@ if defined?(::Resque)
         alias fail_without_oboe fail
         alias fail fail_with_oboe
       elsif Oboe::Config[:verbose]
-        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument ResqueWorker (fail).  Partial traces may occur."
+        Oboe.logger.warn '[oboe/loading] Couldn\'t properly instrument ResqueWorker (fail).  Partial traces may occur.'
       end
     end
   end

data/lib/oboe/instrumentation.rb

@@ -2,6 +2,9 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # The Inst module holds all of the instrumentation extensions for various
+  # libraries suchs as Redis, Dalli and Resque.
   module Inst
     def self.load_instrumentation
       # Load the general instrumentation

data/lib/oboe/loading.rb

@@ -42,30 +42,28 @@ module Oboe
     # or environment variable) and calculate internal RUM ID
     #
     def self.load_access_key
-      begin
-        if ENV.has_key?('TRACEVIEW_CUUID')
-          # Preferably get access key from environment (e.g. Heroku)
-          Oboe::Config[:access_key] = ENV['TRACEVIEW_CUUID']
-          Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest("RUM" + Oboe::Config[:access_key]))
-        else
-          # ..else read from system-wide configuration file
-          if Oboe::Config.access_key.empty?
-            config_file = '/etc/tracelytics.conf'
-            return unless File.exists?(config_file)
+      if ENV.key?('TRACEVIEW_CUUID')
+        # Preferably get access key from environment (e.g. Heroku)
+        Oboe::Config[:access_key] = ENV['TRACEVIEW_CUUID']
+        Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest('RUM' + Oboe::Config[:access_key]))
+      else
+        # ..else read from system-wide configuration file
+        if Oboe::Config.access_key.empty?
+          config_file = '/etc/tracelytics.conf'
+          return unless File.exist?(config_file)
 
-            File.open(config_file).each do |line|
-              if line =~ /^tracelyzer.access_key=/ or line =~ /^access_key/
-                bits = line.split(/=/)
-                Oboe::Config[:access_key] = bits[1].strip
-                Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest("RUM" + Oboe::Config[:access_key]))
-                break
-              end
+          File.open(config_file).each do |line|
+            if line =~ /^tracelyzer.access_key=/ || line =~ /^access_key/
+              bits = line.split(/=/)
+              Oboe::Config[:access_key] = bits[1].strip
+              Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest('RUM' + Oboe::Config[:access_key]))
+              break
             end
           end
         end
-      rescue StandardError => e
-        Oboe.logger.error "Trouble obtaining access_key and rum_id: #{e.inspect}"
       end
+    rescue StandardError => e
+      Oboe.logger.error "Trouble obtaining access_key and rum_id: #{e.inspect}"
     end
 
     ##
@@ -81,7 +79,7 @@ module Oboe
       begin
         Oboe::API.extend_with_tracing
       rescue LoadError => e
-        Oboe.logger.fatal "[oboe/error] Couldn't load oboe api."
+        Oboe.logger.fatal "[oboe/error] Couldn't load oboe api: #{e.message}"
       end
     end
   end
@@ -91,8 +89,6 @@ Oboe::Loading.require_api
 
 # Auto-start the Reporter unless we running Unicorn on Heroku
 # In that case, we start the reporters after fork
-unless Oboe.heroku? and Oboe.forking_webserver?
-  Oboe.logger.debug "[oboe/debug] starting Reporter from oboe gem"
+unless Oboe.heroku? && Oboe.forking_webserver?
   Oboe::Reporter.start
 end
-

data/lib/{method_profiling.rb → oboe/method_profiling.rb}

@@ -1,23 +1,37 @@
 # Copyright (c) 2013 AppNeta, Inc.
 # All rights reserved.
 
+##
+# Provides the methods necessary for method profiling.  Profiling
+# results are sent to the TraceView dashboard.
+#
+# Example usage:
+# class MyApp
+#   include OboeMethodProfiling
+#
+#   def process_request()
+#     # The hard work
+#   end
+#
+#   # call syntax: profile_method <method>, <profile_name>
+#   profile_method :process_request, 'request_processor'
+# end
 module OboeMethodProfiling
-  def self.included klass
+  def self.included(klass)
     klass.extend ClassMethods
   end
 
   module ClassMethods
-    def profile_method(method_name, profile_name, store_args=false, store_return=false, profile=false)
+    def profile_method(method_name, profile_name, store_args = false, store_return = false, *_)
       begin
         # this only gets file and line where profiling is turned on, presumably
         # right after the function definition. ruby 1.9 and 2.0 has nice introspection (Method.source_location)
         # but its appears no such luck for ruby 1.8
-        version = RbConfig::CONFIG['ruby_version']
         file = ''
         line = ''
-        if version and (version.match(/^1.9/) or version.match(/^2.0/))
-          info = self.instance_method(method_name).source_location
-          if !info.nil?
+        if RUBY_VERSION >= '1.9'
+          info = instance_method(method_name).source_location
+          unless info.nil?
             file = info[0].to_s
             line = info[1].to_s
           end
@@ -54,7 +68,7 @@ module OboeMethodProfiling
                   Oboe::API.log(nil, 'profile_exit', exit_kvs)
                   ret
                 end"
-      rescue Exception => e
+      rescue => e
         Oboe.logger.warn "[oboe/warn] profile_method: #{e.inspect}"
       end
 
@@ -62,7 +76,7 @@ module OboeMethodProfiling
         class_eval code, __FILE__, __LINE__
         alias_method "_oboe_orig_#{method_name}", method_name
         alias_method method_name, "_oboe_profiled_#{method_name}"
-      rescue Exception => e
+      rescue => e
         Oboe.logger.warn "[oboe/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if Oboe::Config[:verbose]
       end
     end

data/lib/oboe/ruby.rb

@@ -2,10 +2,30 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # This module provides a method to manually initialize the
+  # Ruby instrumentation.  Normally this is done by detecting
+  # frameworks at load time and inserting initialization hooks.
   module Ruby
-    def self.initialize
-      Oboe::Loading.load_access_key
-      Oboe::Inst.load_instrumentation
+    class << self
+      def initialize
+        load
+      end
+
+      ##
+      # The core method to load Ruby instrumentation.  Call this
+      # from raw Ruby scripts or in Ruby applications where a
+      # supported framework isn't being used.  Supported frameworks
+      # will instead be detected at load time and initialization is
+      # automatic.
+      def load
+        Oboe::Loading.load_access_key
+        Oboe::Inst.load_instrumentation
+      end
     end
   end
 end
+
+if Oboe.loaded and !Oboe.framework?
+  ::Oboe::Ruby.load
+end

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)
@@ -122,8 +120,6 @@ module Oboe
           x.to_s
         end
       end
-
     end
   end
 end
-