traceview 3.2.1 → 3.3.0

data/.travis.yml

@@ -6,8 +6,8 @@ cache:
   - vendor/bundle
 
 rvm:
-  - 2.2.2
-  - 2.1.6
+  - 2.2.3
+  - 2.1.7
   - 2.0.0
   - 1.9.3
   - 1.8.7

data/CHANGELOG.md

@@ -4,6 +4,32 @@ https://github.com/appneta/oboe-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# traceview 3.3.0
+
+This patch release includes the following fixes:
+
+* New [Sidekiq](http://sidekiq.org/) instrumentation: #138, #139
+* Require `Set` before referencing it: #143
+* Add `:action_blacklist` deprecation warning: #137
+* Add a way to restart the reporter via `TraceView::Reporter.restart`: #140
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/traceview/versions/3.3.0
+https://rubygems.org/gems/traceview/versions/3.3.0-java
+
+# traceview 3.2.1
+
+This minor release adds the following:
+
+* New and improved method profiling: #135
+* Fix URL Query config: #136
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/traceview/versions/3.2.1
+https://rubygems.org/gems/traceview/versions/3.2.1-java
+
 # traceview 3.2.0
 
 This minor release adds the following:

data/README.md

@@ -9,9 +9,11 @@ It has the ability to report performance metrics on an array of libraries, datab
 It requires a [TraceView](http://www.appneta.com/products/traceview/) account to view metrics.  Get yours, [it's free](http://www.appneta.com/products/traceview-free-account/).
 
 [![Gem Version](https://badge.fury.io/rb/traceview.png)](http://badge.fury.io/rb/traceview)
-[![Build Status](https://travis-ci.org/appneta/oboe-ruby.png?branch=master)](https://travis-ci.org/appneta/oboe-ruby)
+[![Build Status](https://travis-ci.org/appneta/ruby-traceview.png?branch=master)](https://travis-ci.org/appneta/ruby-traceview)
 [![Code Climate](https://codeclimate.com/github/appneta/oboe-ruby.png)](https://codeclimate.com/github/appneta/oboe-ruby)
 
+_Note: The repository name has been changed to ruby-traceview.  Please update your github remotes with `git remote set-url origin git@github.com:appneta/ruby-traceview.git`._
+
 # Installation
 
 The traceview gem is [available on Rubygems](https://rubygems.org/gems/traceview) and can be installed with:
@@ -26,8 +28,6 @@ or added to _the end_ of your bundle Gemfile and running `bundle install`:
 gem 'traceview'
 ```
 
-On Heroku?  Use the `oboe-heroku` gem instead.  It wraps some additional functionality specialized for Heroku.
-
 # Running
 
 ## Rails
@@ -36,7 +36,7 @@ On Heroku?  Use the `oboe-heroku` gem instead.  It wraps some additional functio
 
 No special steps are needed to instrument Ruby on Rails.  Once part of the bundle, the traceview gem will automatically detect Rails and instrument on stack initialization.
 
-*Note: Unless you are Heroku, you will still need to decide on your `tracing_mode` depending on whether you are running with an instrumented Apache or nginx in front of your Rails stack.  See below for more details.*
+*Note: You will still need to decide on your `tracing_mode` depending on whether you are running with an instrumented Apache or nginx in front of your Rails stack.  See below for more details.*
 
 ### The Install Generator
 
@@ -71,8 +71,6 @@ TraceView::Config[:tracing_mode] = 'through'
 # TraceView.logger = Sinatra.logger
 ```
 
-Note: If you're on Heroku, you don't need to set `tracing_mode` - it will be automatically configured.
-
 Make sure that the traceview gem is loaded _after_ Sinatra either by listing `gem 'traceview'` after Sinatra in your Gemfile or calling the `require 'traceview'` directive after Sinatra is loaded.
 
 With this, the traceview gem will automatically detect Sinatra on boot and instrument key components.
@@ -96,8 +94,6 @@ Padrino.before_load do
 end
 ```
 
-Note: If you're on Heroku, you don't need to set `tracing_mode` - it will be automatically configured.
-
 ## Grape
 
 ![Grape](http://www.appneta.com/images/logos/frameworks/grape.png)
@@ -122,8 +118,6 @@ You can instrument your Grape application by adding the following code to your `
     end
 ```
 
-Note: If you're on Heroku, you don't need to set `tracing_mode` - it will be automatically configured.
-
 Make sure that the traceview gem is loaded _after_ Grape either by listing `gem 'traceview'` after Grape in your Gemfile or calling the `require 'traceview'` directive after Grape is loaded.
 
 You must explicitly tell your Grape application to use TraceView::Rack for tracing to occur.

data/Rakefile

@@ -5,6 +5,8 @@ require 'bundler/setup'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
+  t.verbose = true
+  t.ruby_opts = []
   t.libs << "test"
 
   # Since we support so many libraries and frameworks, tests
@@ -25,12 +27,11 @@ Rake::TestTask.new do |t|
     t.test_files = FileList['test/frameworks/sinatra*_test.rb']
   when /libraries/
     t.test_files = FileList['test/support/*_test.rb'] +
+                   FileList['test/reporter/*_test.rb'] +
                    FileList['test/instrumentation/*_test.rb'] +
                    FileList['test/profiling/*_test.rb']
   end
 
-  t.verbose = true
-  t.ruby_opts = []
   # t.ruby_opts << ['-w']
   if defined?(JRUBY_VERSION)
     t.ruby_opts << ["-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar"]
@@ -97,8 +98,8 @@ task :distclean do
     mkmf_log = File.expand_path('ext/oboe_metal/mkmf.log')
 
     if File.exists? mkmf_log
-      Dir.chdir ext_dir
       File.delete symlink if File.exist? symlink
+      Dir.chdir ext_dir
       sh '/usr/bin/env make distclean'
 
       Dir.chdir pwd
@@ -114,9 +115,11 @@ desc "Rebuild the gem's c extension"
 task :recompile => [ :distclean, :compile ]
 
 task :console do
+  require 'traceview/test'
   ENV['TRACEVIEW_GEM_VERBOSE'] = 'true'
   Bundler.require(:default, :development)
   TraceView::Config[:tracing_mode] = :always
+  TV::Test.load_extras
   ARGV.clear
   Pry.start
 end

data/gemfiles/libraries.gemfile

@@ -44,7 +44,7 @@ else
 end
 
 gem 'cassandra'
-gem 'curb'
+gem 'curb' unless defined?(JRUBY_VERSION)
 gem 'dalli'
 gem 'excon'
 gem 'faraday'
@@ -54,6 +54,7 @@ gem 'mongo'
 gem 'redis'
 gem 'resque'
 gem 'sequel'
+gem "sidekiq" if RUBY_VERSION >= '2.0'
 gem 'typhoeus'
 
 # Database adapter gems needed by sequel

data/gemfiles/rails23.gemfile

@@ -8,6 +8,11 @@ if RUBY_VERSION < '1.9.3'
   gem 'activesupport', '< 4.0'
 end
 
+if RUBY_VERSION < '2.0.0'
+  # rack-cache dropped support for Ruby 1.9
+  gem 'rack-cache', '1.2'
+end
+
 group :development, :test do
   gem 'rake'
   gem 'minitest'

data/gemfiles/rails30.gemfile

@@ -8,6 +8,11 @@ if RUBY_VERSION < '1.9.3'
   gem 'activesupport', '< 4.0'
 end
 
+if RUBY_VERSION < '2.0.0'
+  # rack-cache dropped support for Ruby 1.9
+  gem 'rack-cache', '1.2'
+end
+
 group :development, :test do
   gem 'rake'
   gem 'minitest'

data/gemfiles/rails31.gemfile

@@ -8,6 +8,11 @@ if RUBY_VERSION < '1.9.3'
   gem 'activesupport', '< 4.0'
 end
 
+if RUBY_VERSION < '2.0.0'
+  # rack-cache dropped support for Ruby 1.9
+  gem 'rack-cache', '1.2'
+end
+
 group :development, :test do
   gem 'rake'
   gem 'minitest'

data/gemfiles/rails32.gemfile

@@ -8,6 +8,11 @@ if RUBY_VERSION < '1.9.3'
   gem 'activesupport', '< 4.0'
 end
 
+if RUBY_VERSION < '2.0.0'
+  # rack-cache dropped support for Ruby 1.9
+  gem 'rack-cache', '1.2'
+end
+
 group :development, :test do
   gem 'rake'
   gem 'minitest'

data/lib/joboe_metal.rb

@@ -44,83 +44,96 @@ module Oboe_metal
   end
 
   module Reporter
-    ##
-    # Initialize the TraceView Context, reporter and report the initialization
-    #
-    def self.start
-      return unless TraceView.loaded
-
-      if ENV.key?('TRACEVIEW_GEM_TEST')
-        TraceView.reporter = Java::ComTracelyticsJoboe::TestReporter.new
-      else
-        TraceView.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance.buildUdpReporter
-      end
+    class << self
+      ##
+      # start
+      #
+      # Start the TraceView Reporter
+      #
+      def start
+        return unless TraceView.loaded
+
+        if ENV.key?('TRACEVIEW_GEM_TEST')
+          TraceView.reporter = Java::ComTracelyticsJoboe::TestReporter.new
+        else
+          TraceView.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance.buildUdpReporter
+        end
 
+        begin
+          # Import the tracing mode and sample rate settings
+          # from the Java agent (user configured in
+          # /usr/local/tracelytics/javaagent.json when under JRuby)
+          cfg = LayerUtil.getLocalSampleRate(nil, nil)
+
+          if cfg.hasSampleStartFlag
+            TraceView::Config.tracing_mode = 'always'
+          elsif cfg.hasSampleThroughFlag
+            TraceView::Config.tracing_mode = 'through'
+          else
+            TraceView::Config.tracing_mode = 'never'
+          end
 
-      begin
-        # Import the tracing mode and sample rate settings
-        # from the Java agent (user configured in
-        # /usr/local/tracelytics/javaagent.json when under JRuby)
-        cfg = LayerUtil.getLocalSampleRate(nil, nil)
-
-        if cfg.hasSampleStartFlag
-          TraceView::Config.tracing_mode = 'always'
-        elsif cfg.hasSampleThroughFlag
-          TraceView::Config.tracing_mode = 'through'
-        else
-          TraceView::Config.tracing_mode = 'never'
+          TraceView.sample_rate = cfg.getSampleRate
+          TraceView::Config.sample_rate = cfg.sampleRate
+          TraceView::Config.sample_source = cfg.sampleRateSourceValue
+        rescue => e
+          TraceView.logger.debug "[traceview/debug] Couldn't retrieve/acces joboe sampleRateCfg"
+          TraceView.logger.debug "[traceview/debug] #{e.message}"
         end
 
-        TraceView.sample_rate = cfg.getSampleRate
-        TraceView::Config.sample_rate = cfg.sampleRate
-        TraceView::Config.sample_source = cfg.sampleRateSourceValue
-      rescue => e
-        TraceView.logger.debug "[traceview/debug] Couldn't retrieve/acces joboe sampleRateCfg"
-        TraceView.logger.debug "[traceview/debug] #{e.message}"
+        # Only report __Init from here if we are not instrumenting a framework.
+        # Otherwise, frameworks will handle reporting __Init after full initialization
+        unless defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
+          TraceView::API.report_init unless ENV.key?('TRACEVIEW_GEM_TEST')
+        end
       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) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
-        TraceView::API.report_init unless ENV.key?('TRACEVIEW_GEM_TEST')
+      ##
+      # restart
+      #
+      # This is a nil method for TraceView under Java.  It is maintained only
+      # for compability across interfaces.
+      #
+      def restart
+        TraceView.logger.warn "[traceview/reporter] Reporter.restart isn't supported under JRuby"
       end
-    end
 
-    ##
-    # clear_all_traces
-    #
-    # Truncates the trace output file to zero
-    #
-    def self.clear_all_traces
-      TraceView.reporter.reset if TraceView.loaded
-    end
+      ##
+      # clear_all_traces
+      #
+      # Truncates the trace output file to zero
+      #
+      def clear_all_traces
+        TraceView.reporter.reset if TraceView.loaded
+      end
 
-    ##
-    # get_all_traces
-    #
-    # Retrieves all traces written to the trace file
-    #
-    def self.get_all_traces
-      return [] unless TraceView.loaded
-
-      # Joboe TestReporter returns a Java::ComTracelyticsExtEbson::DefaultDocument
-      # document for traces which doesn't correctly support things like has_key? which
-      # raises an unhandled exception on non-existent key (duh).  Here we convert
-      # the Java::ComTracelyticsExtEbson::DefaultDocument doc to a pure array of Ruby
-      # hashes
-      traces = []
-      TraceView.reporter.getSentEventsAsBsonDocument.to_a.each do |e|
-        t = {}
-        e.each_pair { |k, v|
-          t[k] = v
-        }
-        traces << t
+      ##
+      # get_all_traces
+      #
+      # Retrieves all traces written to the trace file
+      #
+      def get_all_traces
+        return [] unless TraceView.loaded
+
+        # Joboe TestReporter returns a Java::ComTracelyticsExtEbson::DefaultDocument
+        # document for traces which doesn't correctly support things like has_key? which
+        # raises an unhandled exception on non-existent key (duh).  Here we convert
+        # the Java::ComTracelyticsExtEbson::DefaultDocument doc to a pure array of Ruby
+        # hashes
+        traces = []
+        TraceView.reporter.getSentEventsAsBsonDocument.to_a.each do |e|
+          t = {}
+          e.each_pair { |k, v|
+            t[k] = v
+          }
+          traces << t
+        end
+        traces
       end
-      traces
-    end
 
-    def self.sendReport(evt)
-      evt.report(TraceView.reporter)
+      def sendReport(evt)
+        evt.report(TraceView.reporter)
+      end
     end
   end
 end

data/lib/oboe_metal.rb

@@ -11,70 +11,81 @@ module TraceView
   include Oboe_metal
 
   class Reporter
-    ##
-    # Initialize the TraceView Context, reporter and report the initialization
-    #
-    def self.start
-      return unless TraceView.loaded
+    class << self
 
-      begin
-        Oboe_metal::Context.init
+      ##
+      # start
+      #
+      # Start the TraceView Reporter
+      #
+      def start
+        return unless TraceView.loaded
 
-        if ENV.key?('TRACEVIEW_GEM_TEST')
-          TraceView.reporter = TraceView::FileReporter.new('/tmp/trace_output.bson')
-        else
-          TraceView.reporter = TraceView::UdpReporter.new(TraceView::Config[:reporter_host], TraceView::Config[:reporter_port])
-        end
+        begin
+          Oboe_metal::Context.init
 
-        # Only report __Init from here if we are not instrumenting a framework.
-        # Otherwise, frameworks will handle reporting __Init after full initialization
-        unless defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
-          TraceView::API.report_init unless ENV.key?('TRACEVIEW_GEM_TEST')
-        end
+          if ENV.key?('TRACEVIEW_GEM_TEST')
+            TraceView.reporter = TraceView::FileReporter.new('/tmp/trace_output.bson')
+          else
+            TraceView.reporter = TraceView::UdpReporter.new(TraceView::Config[:reporter_host], TraceView::Config[:reporter_port])
+          end
 
-      rescue => e
-        $stderr.puts e.message
-        raise
-      end
-    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) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
+            TraceView::API.report_init
+          end
 
-    def self.sendReport(evt)
-      TraceView.reporter.sendReport(evt)
-    end
+        rescue => e
+          $stderr.puts e.message
+          raise
+        end
+      end
+      alias :restart :start
+
+      ##
+      # sendReport
+      #
+      # Send the report for the given event
+      #
+      def sendReport(evt)
+        TraceView.reporter.sendReport(evt)
+      end
 
-    ##
-    # clear_all_traces
-    #
-    # Truncates the trace output file to zero
-    #
-    def self.clear_all_traces
-      File.truncate($trace_file, 0)
-    end
+      ##
+      # clear_all_traces
+      #
+      # Truncates the trace output file to zero
+      #
+      def clear_all_traces
+        File.truncate($trace_file, 0)
+      end
 
-    ##
-    # get_all_traces
-    #
-    # Retrieves all traces written to the trace file
-    #
-    def self.get_all_traces
-      io = File.open($trace_file, 'r')
-      contents = io.readlines(nil)
+      ##
+      # get_all_traces
+      #
+      # Retrieves all traces written to the trace file
+      #
+      def get_all_traces
+        io = File.open($trace_file, 'r')
+        contents = io.readlines(nil)
 
-      return contents if contents.empty?
+        return contents if contents.empty?
 
-      s = StringIO.new(contents[0])
+        s = StringIO.new(contents[0])
 
-      traces = []
+        traces = []
 
-      until s.eof?
-        if ::BSON.respond_to? :read_bson_document
-          traces << BSON.read_bson_document(s)
-        else
-          traces << BSON::Document.from_bson(s)
+        until s.eof?
+          if ::BSON.respond_to? :read_bson_document
+            traces << BSON.read_bson_document(s)
+          else
+            traces << BSON::Document.from_bson(s)
+          end
         end
-      end
 
-      traces
+        traces
+      end
     end
   end
 
@@ -90,9 +101,9 @@ module TraceView
         return false unless TraceView.always? && TraceView.loaded
 
         # Assure defaults since SWIG enforces Strings
-        layer   = opts[:layer]      ? opts[:layer].strip      : ''
-        xtrace  = opts[:xtrace]     ? opts[:xtrace].strip     : ''
-        tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].strip : ''
+        layer   = opts[:layer]      ? opts[:layer].to_s.strip      : ''
+        xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip     : ''
+        tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].to_s.strip : ''
 
         rv = TraceView::Context.sampleRequest(layer, xtrace, tv_meta)
 
@@ -100,6 +111,8 @@ module TraceView
           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

data/lib/traceview/api/layerinit.rb

@@ -11,11 +11,13 @@ module TraceView
       # layer.
       #
       def report_init(layer = 'rack')
-        # Don't send __Init in development or test
-        return if %w(development test).include? ENV['RACK_ENV']
-
-        # Don't send __Init if the c-extension hasn't loaded
-        return unless TraceView.loaded
+        # Don't send __Init in development, test or if the gem
+        # isn't fully loaded (e.g. missing c-extension)
+        if %w(development test).include? ENV['RACK_ENV'] ||
+                          ENV.key?('TRACEVIEW_GEM_TEST') ||
+                          !TraceView.loaded
+          return
+        end
 
         platform_info = TraceView::Util.build_init_report
 

data/lib/traceview/api/logging.rb

@@ -1,6 +1,13 @@
 # Copyright (c) 2013 AppNeta, Inc.
 # All rights reserved.
 
+# Make sure Set is loaded if possible.
+begin
+  require 'set'
+rescue LoadError
+  class Set; end
+end
+
 module TraceView
   module API
     ##
@@ -105,7 +112,7 @@ module TraceView
           # sample rate and sample source
           opts[:SampleRate]        = TraceView.sample_rate
           opts[:SampleSource]      = TraceView.sample_source
-          opts[:TraceOrigin] = :always_sampled
+          opts[:TraceOrigin]       = :always_sampled
 
           log_event(layer, 'entry', TraceView::Context.startTrace, opts)
         end

data/lib/traceview/config.rb

@@ -14,8 +14,8 @@ module TraceView
     @@instrumentation = [:action_controller, :action_view, :active_record,
                          :cassandra, :curb, :dalli, :em_http_request, :excon, :faraday,
                          :grape, :httpclient, :nethttp, :memcached, :memcache, :mongo,
-                         :moped, :rack, :redis, :resque, :rest_client, :sequel,
-                         :typhoeus]
+                         :moped, :rack, :redis, :resque, :rest_client, :sequel, :sidekiqclient,
+                         :sidekiqworker, :typhoeus]
 
     # Subgrouping of instrumentation
     @@http_clients = [:curb, :excon, :em_http_request, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
@@ -60,6 +60,8 @@ module TraceView
       TraceView::Config[:resque][:collect_backtraces] = true
       TraceView::Config[:rest_client][:collect_backtraces] = false
       TraceView::Config[:sequel][:collect_backtraces] = true
+      TraceView::Config[:sidekiqclient][:collect_backtraces] = false
+      TraceView::Config[:sidekiqworker][:collect_backtraces] = false
       TraceView::Config[:typhoeus][:collect_backtraces] = false
 
       # Special instrument specific flags
@@ -214,6 +216,9 @@ module TraceView
         @@config[key.to_sym] = value.to_i
         TraceView.set_sample_rate(value) if TraceView.loaded
 
+      elsif key == :action_blacklist
+        TraceView.logger.warn "[traceview/deprecation] :action_blacklist will be deprecated in a future version."
+
       elsif key == :include_url_query_params
         # Obey the global flag and update all of the per instrumentation
         # <tt>:log_args</tt> values.

data/lib/traceview/inst/sidekiq-client.rb

@@ -0,0 +1,54 @@
+module TraceView
+  class SidekiqClient
+    def collect_kvs(args)
+      begin
+        # Attempt to collect up pertinent info.  If we hit something unexpected,
+        # keep calm and instrument on.
+
+        report_kvs = {}
+        worker_class, msg, queue, _ = args
+
+        report_kvs[:Spec]      = :msgclient
+        report_kvs[:Flavor]    = :sidekiq
+        report_kvs[:Queue]     = queue
+        report_kvs[:Retry]     = msg['retry']
+        report_kvs[:JobName]   = worker_class
+        report_kvs[:MsgID]     = msg['jid']
+        report_kvs[:Args]      = msg['args'].to_s[0..1024] if TV::Config[:sidekiqclient][:log_args]
+        report_kvs[:Backtrace] = TV::API.backtrace         if TV::Config[:sidekiqclient][:collect_backtraces]
+      rescue => e
+        TraceView.logger.warn "[traceview/sidekiq] Non-fatal error capturing KVs: #{e.message}"
+      end
+      report_kvs
+    end
+
+    def call(*args)
+      # args: 0: worker_class, 1: msg, 2: queue, 3: redis_pool
+
+      result = nil
+      report_kvs = collect_kvs(args)
+
+      TraceView::API.log_entry('sidekiq-client', report_kvs)
+      args[1]['X-Trace'] = TraceView::Context.toString if TraceView.tracing?
+
+      result = yield
+
+      report_kvs = { :JobID => result["jid"] }
+      result
+    rescue => e
+      TraceView::API.log_exception('sidekiq-client', e, report_kvs)
+      raise
+    ensure
+      TraceView::API.log_exit('sidekiq-client', report_kvs)
+    end
+  end
+end
+
+if defined?(::Sidekiq) && RUBY_VERSION >= '2.0' && TraceView::Config[:sidekiqclient][:enabled]
+  ::Sidekiq.configure_client do |config|
+    config.client_middleware do |chain|
+      ::TraceView.logger.info '[traceview/loading] Adding Sidekiq client middleware' if TraceView::Config[:verbose]
+      chain.add ::TraceView::SidekiqClient
+    end
+  end
+end