traceview 3.8.1 → 3.8.2

data/examples/tracing_forked_processes.rb

@@ -6,16 +6,14 @@
 require 'math'
 require 'oboe'
 
-Oboe::Config[:tracing_mode] = :always
-Oboe::Config[:verbose] = true
+TraceView::Config[:tracing_mode] = :always
+TraceView::Config[:verbose] = true
 
 # The parent process/loop which collects data
-while true do
-
+Kernel.loop do
   # For each loop, we instrument the work retrieval.  These traces
   # will show up as layer 'get_the_work'.
-  Oboe::API.start_trace('get_the_work') do
-
+  TraceView::API.start_trace('get_the_work') do
     work = get_the_work
 
     # Loop through work and pass to `do_the_work` method
@@ -23,11 +21,11 @@ while true do
     work.each do |job|
       fork do
         # Since the context is copied from the parent process, we clear it
-        # and start a new trace via `Oboe::API.start_trace`.
-        Oboe::Context.clear
+        # and start a new trace via `TraceView::API.start_trace`.
+        TraceView::Context.clear
         result = nil
 
-        Oboe::API.start_trace('do_the_work', nil, :job_id => job.id) do
+        TraceView::API.start_trace('do_the_work', nil, :job_id => job.id) do
           result = do_the_work(job)
         end
 
@@ -75,11 +73,11 @@ end
 #
 # To do this:
 #   1. Don't clear the context in the child process
-#   2. Use `Oboe::API.trace` instead
+#   2. Use `TraceView::API.trace` instead
 #   3. Pass the `Async` flag to mark this child as asynchronous
 #
-while true do
-  Oboe::API.start_trace('get_the_work') do
+Kernel.loop do
+  TraceView::API.start_trace('get_the_work') do
 
     work = get_the_work
 
@@ -87,9 +85,9 @@ while true do
       fork do
         result = nil
         # 1 Don't clear context
-        # 2 Use `Oboe::API.trace` instead
+        # 2 Use `TraceView::API.trace` instead
         # 3 Pass the Async flag
-        Oboe::API.trace('do_the_work', { :job_id => job.id, 'Async' => 1 }) do
+        TraceView::API.trace('do_the_work', { :job_id => job.id, :Async => 1 }) do
           result = do_the_work(job)
         end
 
@@ -97,4 +95,5 @@ while true do
       end
     end
   end
+  sleep 5
 end

data/examples/unicorn_on_heroku_config.rb

@@ -11,8 +11,8 @@ before_fork do |server, worker|
   defined?(ActiveRecord::Base) and
     ActiveRecord::Base.connection.disconnect!
 
-  defined?(::Oboe) and
-    ::Oboe.disconnect!
+  defined?(::TraceView) and
+    ::TraceView.disconnect!
 end
 
 after_fork do |server, worker|
@@ -23,6 +23,6 @@ after_fork do |server, worker|
   defined?(ActiveRecord::Base) and
     ActiveRecord::Base.establish_connection
 
-  defined?(::Oboe) and
-    ::Oboe.reconnect!
+  defined?(::TraceView) and
+    ::TraceView.reconnect!
 end

data/gemfiles/rails50.gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem 'rails', '>= 5.0.0.beta3', '< 5.1'
+gem 'rails', '>= 5.0.0.rc1', '< 5.1'
 gem 'sass-rails', '~> 5.0'
 gem 'uglifier', '>= 1.3.0'
 gem 'coffee-rails', '~> 4.1.0'

data/lib/joboe_metal.rb

@@ -146,10 +146,7 @@ module TraceView
     def sample?(opts = {})
       begin
         # Return false if no-op mode
-        return false if !TraceView.loaded
-
-        # Return false if never or through mode without AVW flag
-        return false if TraceView.never? || (TraceView.through? && !opts.key?('X-TV-Meta'))
+        return false unless TraceView.loaded
 
         return true if ENV.key?('TRACEVIEW_GEM_TEST') && !opts.key?('X-TV-Meta')
 
@@ -163,7 +160,7 @@ module TraceView
         opts[:xtrace]     ||= nil
         opts['X-TV-Meta'] ||= nil
 
-        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest( opts[:layer], { 'X-Trace' => opts[:xtrace], 'X-TV-Meta' => opts['X-TV-Meta'] })
+        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest(opts[:layer], { 'X-Trace' => opts[:xtrace], 'X-TV-Meta' => opts['X-TV-Meta'] })
 
         # Store the returned SampleRateConfig into TraceView::Config
         if sr_cfg

data/lib/oboe/backward_compatibility.rb

@@ -18,7 +18,7 @@ module Oboe
       # Notify of deprecation only once
       unless @deprecated_notified
         TraceView.logger.warn "[traceview/warn] Note that Oboe::API has been renamed to TraceView::API. (#{sym}:#{args})"
-        TraceView.logger.warn "[traceview/warn] Oboe::API will be deprecated in a future version."
+        TraceView.logger.warn '[traceview/warn] Oboe::API will be deprecated in a future version.'
         TraceView.logger.warn "[traceview/warn] Caller: #{Kernel.caller[0]}"
         @deprecated_notified = true
       end
@@ -38,7 +38,7 @@ module Oboe
       # Notify of deprecation only once
       unless @deprecated_notified
         TraceView.logger.warn "[traceview/warn] Note that Oboe::Config has been renamed to TraceView::Config. (#{sym}:#{args})"
-        TraceView.logger.warn "[traceview/warn] Oboe::Config will be deprecated in a future version."
+        TraceView.logger.warn '[traceview/warn] Oboe::Config will be deprecated in a future version.'
         TraceView.logger.warn "[traceview/warn] Caller: #{Kernel.caller[0]}"
         @deprecated_notified = true
       end
@@ -57,7 +57,7 @@ module Oboe
       # Notify of deprecation only once
       unless @deprecated_notified
         TraceView.logger.warn "[traceview/warn] Note that Oboe::Ruby has been renamed to TraceView::Ruby. (#{sym}:#{args})"
-        TraceView.logger.warn "[traceview/warn] Oboe::Ruby will be deprecated in a future version."
+        TraceView.logger.warn '[traceview/warn] Oboe::Ruby will be deprecated in a future version.'
         TraceView.logger.warn "[traceview/warn] Caller: #{Kernel.caller[0]}"
         @deprecated_notified = true
       end
@@ -66,7 +66,6 @@ module Oboe
   end
 end
 
-
 #
 # Support for OboeMethodProfiling
 #
@@ -79,4 +78,3 @@ module OboeMethodProfiling
     include TraceViewMethodProfiling::ClassMethods
   end
 end
-

data/lib/oboe_metal.rb

@@ -12,7 +12,6 @@ module TraceView
 
   class Reporter
     class << self
-
       ##
       # start
       #
@@ -25,7 +24,7 @@ module TraceView
           Oboe_metal::Context.init
 
           if ENV.key?('TRACEVIEW_GEM_TEST')
-            TraceView.reporter = TraceView::FileReporter.new('/tmp/trace_output.bson')
+            TraceView.reporter = TraceView::FileReporter.new(TRACE_FILE)
           else
             TraceView.reporter = TraceView::UdpReporter.new(TraceView::Config[:reporter_host], TraceView::Config[:reporter_port])
           end
@@ -58,7 +57,7 @@ module TraceView
       # Truncates the trace output file to zero
       #
       def clear_all_traces
-        File.truncate($trace_file, 0)
+        File.truncate(TRACE_FILE, 0)
       end
 
       ##
@@ -67,7 +66,7 @@ module TraceView
       # Retrieves all traces written to the trace file
       #
       def get_all_traces
-        io = File.open($trace_file, 'r')
+        io = File.open(TRACE_FILE, 'r')
         contents = io.readlines(nil)
 
         return contents if contents.empty?
@@ -84,11 +83,11 @@ module TraceView
           s = StringIO.new(contents[0])
 
           until s.eof?
-            if ::BSON.respond_to? :read_bson_document
-              traces << BSON.read_bson_document(s)
-            else
-              traces << BSON::Document.from_bson(s)
-            end
+            traces << if ::BSON.respond_to? :read_bson_document
+                        BSON.read_bson_document(s)
+                      else
+                        BSON::Document.from_bson(s)
+                      end
           end
         else
           bbb = BSON::ByteBuffer.new(contents[0])
@@ -110,43 +109,38 @@ module TraceView
 
   class << self
     def sample?(opts = {})
-      begin
-        # Return false if no-op mode
-        return false if !TraceView.loaded
-
-        # Return false if never or through mode without AVW flag
-        return false if TraceView.never? || (TraceView.through? && !opts.key?('X-TV-Meta'))
-
-        # Assure defaults since SWIG enforces Strings
-        layer   = opts[:layer]      ? opts[:layer].to_s.strip.freeze : TV_STR_BLANK
-        xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : TV_STR_BLANK
-        tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].to_s.strip   : TV_STR_BLANK
-
-        rv = TraceView::Context.sampleRequest(layer, xtrace, tv_meta)
-
-        if rv == 0
-          if ENV.key?('TRACEVIEW_GEM_TEST')
-            # When in test, always trace and don't clear
-            # the stored sample rate/source
-            TraceView.sample_rate ||= -1
-            TraceView.sample_source ||= -1
-            true
-          else
-            TraceView.sample_rate = -1
-            TraceView.sample_source = -1
-            false
-          end
-        else
-          # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
-          # source embedded
-          TraceView.sample_rate = (rv & SAMPLE_RATE_MASK)
-          TraceView.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
+      # Return false if no-op mode
+      return false unless TraceView.loaded
+
+      # Assure defaults since SWIG enforces Strings
+      layer   = opts[:layer]      ? opts[:layer].to_s.strip.freeze : TV_STR_BLANK
+      xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : TV_STR_BLANK
+      tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].to_s.strip   : TV_STR_BLANK
+
+      rv = TraceView::Context.sampleRequest(layer, xtrace, tv_meta)
+
+      if rv == 0
+        if ENV.key?('TRACEVIEW_GEM_TEST')
+          # When in test, always trace and don't clear
+          # the stored sample rate/source
+          TraceView.sample_rate ||= -1
+          TraceView.sample_source ||= -1
           true
+        else
+          TraceView.sample_rate = -1
+          TraceView.sample_source = -1
+          false
         end
-      rescue StandardError => e
-        TraceView.logger.debug "[oboe/error] sample? error: #{e.inspect}"
-        false
+      else
+        # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
+        # source embedded
+        TraceView.sample_rate = (rv & SAMPLE_RATE_MASK)
+        TraceView.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
+        true
       end
+    rescue StandardError => e
+      TraceView.logger.debug "[oboe/error] sample? error: #{e.inspect}"
+      false
     end
 
     def set_tracing_mode(mode)

data/lib/traceview/api/logging.rb

@@ -86,8 +86,7 @@ module TraceView
       #   TraceView::API.log_start(:layer_name, nil, { :id => @user.id })
       #
       def log_start(layer, xtrace = nil, opts = {})
-        return if !TraceView.loaded || TraceView.never? ||
-                  (opts.key?(:URL) && ::TraceView::Util.static_asset?(opts[:URL]))
+        return if !TraceView.loaded || (opts.key?(:URL) && ::TraceView::Util.static_asset?(opts[:URL]))
 
         # For entry only layers (DelayedJob workers, Sidekiq workers), auto-set the tracing mode
         # Don't do this if tracing mode is already :always or :never

data/lib/traceview/base.rb

@@ -26,6 +26,9 @@ TV_STR_BLANK = ''.freeze
 TV_STR_LAYER = 'Layer'.freeze
 TV_STR_LABEL = 'Label'.freeze
 
+# Used in tests to store local trace data
+TRACE_FILE = '/tmp/traceview_traces.bson'.freeze
+
 ##
 # This module is the base module for the various implementations of TraceView reporting.
 # Current variations as of 2014-09-10 are a c-extension, JRuby (using TraceView Java

data/lib/traceview/config.rb

@@ -30,6 +30,13 @@ module TraceView
       @@config
     end
 
+    ##
+    # initialize
+    #
+    # Initializer method to set everything up with a
+    # default configuration.
+    #
+    # rubocop:disable Metrics/AbcSize
     def self.initialize(_data = {})
       # Setup default instrumentation values
       @@instrumentation.each do |k|
@@ -144,7 +151,7 @@ module TraceView
       # Requests with positive matches (non nil) will not be traced.
       # See lib/traceview/util.rb: TraceView::Util.static_asset?
       #
-      @@config[:dnt_regexp] = "\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$"
+      @@config[:dnt_regexp] = '\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$'
       @@config[:dnt_opts]   = Regexp::IGNORECASE
 
       # In Rails, raised exceptions with rescue handlers via
@@ -202,6 +209,7 @@ module TraceView
 
       @@config[:verbose] = ENV.key?('TRACEVIEW_GEM_VERBOSE') ? true : false
     end
+    # rubocop:enable Metrics/AbcSize
 
     def self.update!(data)
       data.each do |key, value|
@@ -210,18 +218,25 @@ module TraceView
     end
 
     def self.merge!(data)
-      self.update!(data)
+      update!(data)
     end
 
     def self.[](key)
       if key == :resque
-        TraceView.logger.warn "[traceview/warn] :resque config is deprecated.  It is now split into :resqueclient and :resqueworker."
+        TraceView.logger.warn '[traceview/warn] :resque config is deprecated.  It is now split into :resqueclient and :resqueworker.'
         TraceView.logger.warn "[traceview/warn] Called from #{Kernel.caller[0]}"
       end
 
       @@config[key.to_sym]
     end
 
+    ##
+    # []=
+    #
+    # Config variable assignment method.  Here we validate and store the
+    # assigned value(s) and trigger any secondary action needed.
+    #
+    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def self.[]=(key, value)
       @@config[key.to_sym] = value
 
@@ -271,6 +286,7 @@ module TraceView
         @@config[key.to_sym] = value.to_sym
       end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def self.method_missing(sym, *args)
       class_var_name = "@@#{sym}"

data/lib/traceview/frameworks/rails/inst/action_controller.rb

@@ -83,10 +83,10 @@ if defined?(ActionController::Base) && TraceView::Config[:action_controller][:en
   end
 end
 
-# ActionController::API (Rails 5+)
+# ActionController::API - Rails 5+ or via the rails-api gem
 if defined?(ActionController::API) && TraceView::Config[:action_controller_api][:enabled]
   TraceView.logger.info '[traceview/loading] Instrumenting actioncontroller api' if TraceView::Config[:verbose]
-  require "traceview/frameworks/rails/inst/action_controller#{Rails::VERSION::MAJOR}_api"
+  require "traceview/frameworks/rails/inst/action_controller_api"
   ::ActionController::API.send(:prepend, ::TraceView::Inst::ActionControllerAPI)
 end
 

data/lib/traceview/frameworks/rails/inst/connection_adapters/utils.rb

@@ -50,7 +50,7 @@ module TraceView
         def ignore_payload?(name)
           %w(SCHEMA EXPLAIN CACHE).include?(name.to_s) ||
             (name && name.to_sym == :skip_logging) ||
-              name == 'ActiveRecord::SchemaMigration Load'
+            name == 'ActiveRecord::SchemaMigration Load'
         end
 
         # def cfg
@@ -107,7 +107,7 @@ module TraceView
 
         def begin_db_transaction_with_traceview
           if TraceView.tracing?
-            TraceView::API.trace('activerecord', { :Query => 'BEGIN' }) do
+            TraceView::API.trace('activerecord', :Query => 'BEGIN') do
               begin_db_transaction_without_traceview
             end
           else

data/lib/traceview/frameworks/rails/inst/connection_adapters/utils5x.rb

@@ -17,7 +17,7 @@ module TraceView
               # Report raw SQL and any binds if they exist
               opts[:Query] = sql.to_s
               if binds && !binds.empty?
-                opts[:QueryArgs] = binds.map { |i| i.value  }
+                opts[:QueryArgs] = binds.map(&:value)
               end
             end
 
@@ -47,7 +47,7 @@ module TraceView
             TraceView.logger.debug e.backtrace.join('\n')
           end
 
-          return opts || {}
+          opts || {}
         end
 
         # We don't want to trace framework caches.  Only instrument SQL that
@@ -55,11 +55,10 @@ module TraceView
         def ignore_payload?(name)
           %w(SCHEMA EXPLAIN CACHE).include?(name.to_s) ||
             (name && name.to_sym == :skip_logging) ||
-              name == 'ActiveRecord::SchemaMigration Load'
+            name == 'ActiveRecord::SchemaMigration Load'
         end
 
         def exec_query_with_traceview(sql, name = nil, binds = [], prepare: false)
-
           if TraceView.tracing? && !ignore_payload?(name)
 
             opts = extract_trace_details(sql, name, binds)

data/lib/traceview/inst/httpclient.rb

@@ -39,7 +39,7 @@ module TraceView
 
       def do_request_with_traceview(method, uri, query, body, header, &block)
         # If we're not tracing, just do a fast return.
-        if !TraceView.tracing?
+        unless TraceView.tracing?
           return do_request_without_traceview(method, uri, query, body, header, &block)
         end
 
@@ -55,11 +55,11 @@ module TraceView
           TraceView::API.log_entry(:httpclient, kvs)
           kvs.clear
 
-          req_context = TraceView::Context.toString()
+          req_context = TraceView::Context.toString
 
           # Be aware of various ways to call/use httpclient
           if header.is_a?(Array)
-            header.push ["X-Trace", req_context]
+            header.push ['X-Trace', req_context]
           elsif header.is_a?(Hash)
             header['X-Trace'] = req_context unless blacklisted
           end
@@ -71,8 +71,8 @@ module TraceView
           kvs[:HTTPStatus] = response.status_code
 
           # 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"]
+          if ((300..308).to_a.include? response.status.to_i) && response.headers.key?('Location')
+            kvs[:Location] = response.headers['Location']
           end
 
           if response_context && !blacklisted
@@ -95,7 +95,7 @@ module TraceView
           # we stowaway the context in the request headers to be picked up
           # (and removed from req headers) in do_get_stream.
           if header.is_a?(Array)
-            header.push ["traceview.context", TraceView::Context.toString]
+            header.push ['traceview.context', TraceView::Context.toString]
           elsif header.is_a?(Hash)
             header['traceview.context'] = TraceView::Context.toString
           end
@@ -105,13 +105,13 @@ module TraceView
       end
 
       def do_get_stream_with_traceview(req, proxy, conn)
-        unless req.headers.key?("traceview.context")
+        unless req.headers.key?('traceview.context')
           return do_get_stream_without_traceview(req, proxy, conn)
         end
 
         # Pickup context and delete the headers stowaway
-        TraceView::Context.fromString req.headers["traceview.context"]
-        req.header.delete "traceview.context"
+        TraceView::Context.fromString req.headers['traceview.context']
+        req.header.delete 'traceview.context'
 
         begin
           response = nil
@@ -129,7 +129,7 @@ module TraceView
           TraceView::API.log_entry(:httpclient, kvs)
           kvs.clear
 
-          req_context = TraceView::Context.toString()
+          req_context = TraceView::Context.toString
           req.header.add('X-Trace', req_context)
 
           # The core httpclient call
@@ -146,8 +146,8 @@ module TraceView
           kvs[:HTTPStatus] = response.status_code
 
           # 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"]
+          if ((300..308).to_a.include? response.status.to_i) && response.headers.key?('Location')
+            kvs[:Location] = response.headers['Location']
           end
 
           if response_context && !blacklisted