traceview 3.8.0 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1290a31bde98b6d4248897cf8e17f5e515818c16
-  data.tar.gz: 26e335a7365cfdc38c667520fa5f37f97517cc1c
+  metadata.gz: a0891c16459fdf94a5c62c35540312c60a5e42c3
+  data.tar.gz: 9e32e05df0fc3b27efb43de2f812666c7b9113c3
 SHA512:
-  metadata.gz: fb16839d64fe8562ef5e0e8afe8ff6448d773b38889d5b146b309addda5156503d0d34c03a76a940e226eb7e3ed1d6e01cb8e487d0d7ab6132dcb80369238c65
-  data.tar.gz: 7be6d76914a3be0e20513956794d9790d185de3eb5c22c21cc2bbcdadcdd6ee531f1ff956e45c7dd18bd78a2ae0a92c400d44b8283f9d34ea7058afc67f1025d
+  metadata.gz: 456635e75d7ebb9dbcce019d5f1c2b3c1649adc16e852fef35b78a8e2fb80cb9b4e4324b81ad771df5fbc4af6f600f4d13d9e28d767353ca96901e939c15c717
+  data.tar.gz: 707e48cd731becdab72dc1dabfbf54de8b65bab4ea79b0b0f9d569ca5928a061cba8e26ac64b505823f73c24f9776d25d3ba46c0190cefc6243450b28a9e0d4b

data/CHANGELOG.md

@@ -4,6 +4,18 @@ https://github.com/appneta/oboe-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# traceview 3.8.1
+
+This patch release includes the following fixes:
+
+* Use less string literals and more symbols: #168
+* Fix `alias_method_chain` deprecation under Rails 5: #169
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/traceview/versions/3.8.1
+https://rubygems.org/gems/traceview/versions/3.8.1-java
+
 # traceview 3.8.0
 
 This minor release includes the following new feature:

data/README.md

@@ -332,9 +332,9 @@ rake recompile           # Rebuild the gem's c extension
 Note: Make sure you have the development package `liboboe0-dev` installed before attempting to compile the C extension.
 
 ```bash
->$ dpkg -l | grep liboboe
-ii  liboboe-dev    1.1.1-precise1    Tracelytics common library -- development files
-ii  liboboe0       1.1.1-precise1    Tracelytics common library
+>>$ dpkg -l | grep liboboe
+ii  liboboe-dev  1.2.1-trusty1  AppNeta TraceView common library -- development files
+ii  liboboe0     1.2.1-trusty1  AppNeta Traceview common library
 ```
 
 See [Installing Base Packages on Debian and Ubuntu](https://docs.appneta.com/installation-overview) in the Knowledge Base for details.  Our hacker extraordinaire [Rob Salmond](https://github.com/rsalmond) from the support team has even gotten these packages to [run on Gentoo](http://www.appneta.com/blog/unsupported-doesnt-work/)!

data/lib/joboe_metal.rb

@@ -66,11 +66,11 @@ module Oboe_metal
           cfg = LayerUtil.getLocalSampleRate(nil, nil)
 
           if cfg.hasSampleStartFlag
-            TraceView::Config.tracing_mode = 'always'
+            TraceView::Config.tracing_mode = :always
           elsif cfg.hasSampleThroughFlag
-            TraceView::Config.tracing_mode = 'through'
+            TraceView::Config.tracing_mode = :through
           else
-            TraceView::Config.tracing_mode = 'never'
+            TraceView::Config.tracing_mode = :never
           end
 
           TraceView.sample_rate = cfg.getSampleRate
@@ -205,7 +205,7 @@ case Java::ComTracelyticsAgent::Agent.getStatus
     $stderr.puts '=============================================================='
     $stderr.puts 'TraceView Java Agent not initialized properly.'
     $stderr.puts 'Possibly misconfigured?  Going into no-op mode.'
-    $stderr.puts 'See: http://bit.ly/1zwS5xj'
+    $stderr.puts 'https://docs.appneta.com/installing-jruby-instrumentation'
     $stderr.puts '=============================================================='
 
   when Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED

data/lib/oboe_metal.rb

@@ -118,9 +118,9 @@ module TraceView
         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      : ''
-        xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip     : ''
-        tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].to_s.strip : ''
+        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)
 

data/lib/traceview/api/layerinit.rb

@@ -10,7 +10,7 @@ module TraceView
       # installed, as well as the version of instrumentation and version of
       # layer.
       #
-      def report_init(layer = 'rack')
+      def report_init(layer = :rack)
         # Don't send __Init in development, test or if the gem
         # isn't fully loaded (e.g. missing c-extension)
         return if %w(development test).include?(ENV['RACK_ENV']) ||
@@ -41,7 +41,7 @@ module TraceView
                          'removed in a subsequent version.'
 
         saved_mode = TraceView::Config[:tracing_mode]
-        TraceView::Config[:tracing_mode] = 'always'
+        TraceView::Config[:tracing_mode] = :always
         yield
       ensure
         TraceView::Config[:tracing_mode] = saved_mode

data/lib/traceview/api/logging.rb

@@ -68,7 +68,7 @@ module TraceView
                    :Backtrace => exn.backtrace.join("\r\n"))
 
         exn.instance_variable_set(:@oboe_logged, true)
-        log(layer, 'error', kvs)
+        log(layer, :error, kvs)
       end
 
       ##
@@ -118,7 +118,7 @@ module TraceView
         elsif opts.key?('Force')
           # Forced tracing: used by __Init reporting
           opts[:TraceOrigin] = :forced
-          log_event(layer, 'entry', TraceView::Context.startTrace, opts)
+          log_event(layer, :entry, TraceView::Context.startTrace, opts)
 
         elsif TraceView.sample?(opts.merge(:layer => layer, :xtrace => xtrace))
           # Probablistic tracing of a subset of requests based off of
@@ -132,7 +132,7 @@ module TraceView
             opts[:TraceOrigin]       = :always_sampled
           end
 
-          log_event(layer, 'entry', TraceView::Context.startTrace, opts)
+          log_event(layer, :entry, TraceView::Context.startTrace, opts)
         end
       end
 
@@ -152,7 +152,7 @@ module TraceView
       def log_end(layer, opts = {})
         return unless TraceView.loaded
 
-        log_event(layer, 'exit', TraceView::Context.createEvent, opts)
+        log_event(layer, :exit, TraceView::Context.createEvent, opts)
         xtrace = TraceView::Context.toString
         TraceView::Context.clear unless TraceView.has_incoming_context?
         xtrace
@@ -177,8 +177,8 @@ module TraceView
       def log_entry(layer, kvs = {}, op = nil)
         return unless TraceView.loaded
 
-        TraceView.layer_op = op if op
-        log_event(layer, 'entry', TraceView::Context.createEvent, kvs)
+        TraceView.layer_op = op.to_sym if op
+        log_event(layer, :entry, TraceView::Context.createEvent, kvs)
       end
 
       ##
@@ -199,7 +199,7 @@ module TraceView
       def log_info(layer, kvs = {})
         return unless TraceView.loaded
 
-        log_event(layer, 'info', TraceView::Context.createEvent, kvs)
+        log_event(layer, :info, TraceView::Context.createEvent, kvs)
       end
 
       ##
@@ -222,7 +222,7 @@ module TraceView
         return unless TraceView.loaded
 
         TraceView.layer_op = nil if op
-        log_event(layer, 'exit', TraceView::Context.createEvent, kvs)
+        log_event(layer, :exit, TraceView::Context.createEvent, kvs)
       end
 
       ##
@@ -247,11 +247,11 @@ module TraceView
       def log_event(layer, label, event, opts = {})
         return unless TraceView.loaded
 
-        event.addInfo('Layer', layer.to_s) if layer
-        event.addInfo('Label', label.to_s)
+        event.addInfo(TV_STR_LAYER, layer.to_s.freeze) if layer
+        event.addInfo(TV_STR_LABEL, label.to_s.freeze)
 
-        TraceView.layer = layer if label == 'entry'
-        TraceView.layer = nil   if label == 'exit'
+        TraceView.layer = layer.to_sym if label == :entry
+        TraceView.layer = nil          if label == :exit
 
         opts.each do |k, v|
           value = nil

data/lib/traceview/api/profiling.rb

@@ -30,7 +30,7 @@ module TraceView
         report_kvs[:ProfileName] ||= profile_name
         report_kvs[:Backtrace] = TraceView::API.backtrace if with_backtrace
 
-        TraceView::API.log(nil, 'profile_entry', report_kvs)
+        TraceView::API.log(nil, :profile_entry, report_kvs)
 
         begin
           yield
@@ -42,7 +42,7 @@ module TraceView
           exit_kvs[:Language] = :ruby
           exit_kvs[:ProfileName] = report_kvs[:ProfileName]
 
-          TraceView::API.log(nil, 'profile_exit', exit_kvs)
+          TraceView::API.log(nil, :profile_exit, exit_kvs)
         end
       end
 
@@ -133,8 +133,8 @@ module TraceView
               profile_wrapper(without_traceview, report_kvs, opts, *args, &block)
             end
 
-            alias_method without_traceview, "#{method}"
-            alias_method "#{method}", with_traceview
+            alias_method without_traceview, method.to_s
+            alias_method method.to_s, with_traceview
           end
         elsif class_method
           klass.define_singleton_method(with_traceview) do |*args, &block|
@@ -142,8 +142,8 @@ module TraceView
           end
 
           klass.singleton_class.class_eval do
-            alias_method without_traceview, "#{method}"
-            alias_method "#{method}", with_traceview
+            alias_method without_traceview, method.to_s
+            alias_method method.to_s, with_traceview
           end
         end
         true

data/lib/traceview/api/tracing.rb

@@ -126,7 +126,7 @@ module TraceView
           raise
         ensure
           exit_evt.addEdge(TraceView::Context.get)
-          log_event(layer, 'exit', exit_evt)
+          log_event(layer, :exit, exit_evt)
           TraceView::Context.clear
         end
       end

data/lib/traceview/api/util.rb

@@ -17,7 +17,7 @@ module TraceView
       #
       # Return a boolean indicating whether or not key is reserved.
       def valid_key?(key)
-        !%w(Label Layer Edge Timestamp Timestamp_u).include? key.to_s
+        ![:Label, :Layer, :Edge, :Timestamp, :Timestamp_u].include?(key.to_sym)
       end
 
       # Internal: Get the current backtrace.

data/lib/traceview/base.rb

@@ -22,6 +22,10 @@ SAMPLE_SOURCE_MASK = 0b1111000000000000000000000000
 ZERO_SAMPLE_RATE_MASK   = 0b1111000000000000000000000000
 ZERO_SAMPLE_SOURCE_MASK = 0b0000111111111111111111111111
 
+TV_STR_BLANK = ''.freeze
+TV_STR_LAYER = 'Layer'.freeze
+TV_STR_LABEL = 'Label'.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
@@ -111,7 +115,7 @@ module TraceViewBase
   # operation tracing or one instrumented operation calling another.
   #
   def tracing_layer?(layer)
-    TraceView.layer == layer
+    TraceView.layer == layer.to_sym
   end
 
   ##
@@ -121,13 +125,16 @@ module TraceViewBase
   # operation being traced.  This is used in cases of recursive
   # operation tracing or one instrumented operation calling another.
   #
+  # <operation> can be a single symbol or an array of symbols that
+  # will be checked against.
+  #
   # In such cases, we only want to trace the outermost operation.
   #
   def tracing_layer_op?(operation)
     if operation.is_a?(Array)
       return operation.include?(TraceView.layer_op)
     else
-      return TraceView.layer_op == operation
+      return TraceView.layer_op == operation.to_sym
     end
   end
 
@@ -150,7 +157,7 @@ module TraceViewBase
   # False otherwise
   #
   def always?
-    TraceView::Config[:tracing_mode].to_s == 'always'
+    TraceView::Config[:tracing_mode].to_sym == :always
   end
 
   ##
@@ -158,7 +165,7 @@ module TraceViewBase
   # False otherwise
   #
   def never?
-    TraceView::Config[:tracing_mode].to_s == 'never'
+    TraceView::Config[:tracing_mode].to_sym == :never
   end
 
   ##
@@ -166,7 +173,7 @@ module TraceViewBase
   # False otherwise
   #
   def passthrough?
-    %w(always through).include?(TraceView::Config[:tracing_mode])
+    [:always, :through].include?(TraceView::Config[:tracing_mode])
   end
 
   ##
@@ -174,7 +181,7 @@ module TraceViewBase
   # False otherwise
   #
   def through?
-    TraceView::Config[:tracing_mode].to_s == 'through'
+    TraceView::Config[:tracing_mode].to_sym == :through
   end
 
   ##
@@ -240,7 +247,7 @@ module TraceViewBase
   # or not
   #
   def framework?
-    defined?(::Rails) && defined?(::Sinatra) && defined?(::Padrino) && defined?(::Grape)
+    defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
   end
 
   ##

data/lib/traceview/config.rb

@@ -43,8 +43,8 @@ module TraceView
       TraceView::Config[:em_http_request][:enabled] = false
 
       # Set collect_backtraces defaults
-      TraceView::Config[:action_controller][:collect_backtraces] = true
-      TraceView::Config[:action_controller_api][:collect_backtraces] = true
+      TraceView::Config[:action_controller][:collect_backtraces] = false
+      TraceView::Config[:action_controller_api][:collect_backtraces] = false
       TraceView::Config[:active_record][:collect_backtraces] = true
       TraceView::Config[:bunnyclient][:collect_backtraces] = false
       TraceView::Config[:bunnyconsumer][:collect_backtraces] = false
@@ -190,12 +190,12 @@ module TraceView
       # Environment support for OpenShift.
       if ENV.key?('OPENSHIFT_TRACEVIEW_TLYZER_IP')
         # We're running on OpenShift
-        @@config[:tracing_mode] = 'always'
+        @@config[:tracing_mode] = :always
         @@config[:reporter_host] = ENV['OPENSHIFT_TRACEVIEW_TLYZER_IP']
         @@config[:reporter_port] = ENV['OPENSHIFT_TRACEVIEW_TLYZER_PORT']
       else
         # The default configuration
-        @@config[:tracing_mode] = 'through'
+        @@config[:tracing_mode] = :through
         @@config[:reporter_host] = '127.0.0.1'
         @@config[:reporter_port] = '7831'
       end
@@ -265,7 +265,10 @@ module TraceView
 
       # Update liboboe if updating :tracing_mode
       if key == :tracing_mode
-        TraceView.set_tracing_mode(value) if TraceView.loaded
+        TraceView.set_tracing_mode(value.to_sym) if TraceView.loaded
+
+        # Make sure that the mode is stored as a symbol
+        @@config[key.to_sym] = value.to_sym
       end
     end
 

data/lib/traceview/frameworks/padrino/templates.rb

@@ -19,13 +19,13 @@ module TraceView
             report_kvs[:template] = engine
           end
 
-          if TraceView.tracing_layer_op?('render')
+          if TraceView.tracing_layer_op?(:render)
             # For recursive calls to :render (for sub-partials and layouts),
             # use method profiling.
             begin
               report_kvs[:FunctionName] = :render
               report_kvs[:Class]        = :Rendering
-              report_kvs[:Module]       = 'Padrino'
+              report_kvs[:Module]       = :Padrino
               report_kvs[:File]         = __FILE__
               report_kvs[:LineNumber]   = __LINE__
             rescue StandardError => e
@@ -41,12 +41,12 @@ module TraceView
             # back on exit (a limitation of the TraceView::API.trace
             # block method) This removes the need for an info
             # event to send additonal KVs
-            ::TraceView::API.log_entry('render', {}, 'render')
+            ::TraceView::API.log_entry(:render, {}, :render)
 
             begin
               render_without_traceview(engine, data, options, locals, &block)
             ensure
-              ::TraceView::API.log_exit('render', report_kvs)
+              ::TraceView::API.log_exit(:render, report_kvs)
             end
           end
         else

data/lib/traceview/frameworks/rails.rb

@@ -43,9 +43,9 @@ module TraceView
       # Force load the TraceView Rails initializer if there is one
       # Prefer traceview.rb but give priority to the legacy tracelytics.rb if it exists
       if ::Rails::VERSION::MAJOR > 2
-        rails_root = "#{::Rails.root}"
+        rails_root = ::Rails.root.to_s
       else
-        rails_root = "#{RAILS_ROOT}"
+        rails_root = RAILS_ROOT.to_s
       end
 
       #

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

@@ -76,14 +76,18 @@ end
 if defined?(ActionController::Base) && TraceView::Config[:action_controller][:enabled]
   TraceView.logger.info '[traceview/loading] Instrumenting actioncontroller' if TraceView::Config[:verbose]
   require "traceview/frameworks/rails/inst/action_controller#{Rails::VERSION::MAJOR}"
-  ::TraceView::Util.send_include(::ActionController::Base, TraceView::Inst::ActionController)
+  if Rails::VERSION::MAJOR >= 5
+    ::ActionController::Base.send(:prepend, ::TraceView::Inst::ActionController)
+  else
+    ::TraceView::Util.send_include(::ActionController::Base, TraceView::Inst::ActionController)
+  end
 end
 
 # ActionController::API (Rails 5+)
 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"
-  ::TraceView::Util.send_include(::ActionController::API, TraceView::Inst::ActionControllerAPI)
+  ::ActionController::API.send(:prepend, ::TraceView::Inst::ActionControllerAPI)
 end
 
 # vim:set expandtab:tabstop=2

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

@@ -31,11 +31,13 @@ module TraceView
       end
 
       def perform_action_with_traceview(*arguments)
-        report_kvs = {
+        kvs = {
           :Controller  => @_request.path_parameters['controller'],
           :Action      => @_request.path_parameters['action']
         }
-        TraceView::API.log(nil, 'info', report_kvs)
+        kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:action_controller][:collect_backtraces]
+
+        TraceView::API.log(nil, 'info', kvs)
         perform_action_without_traceview(*arguments)
       end
 

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

@@ -32,16 +32,17 @@ module TraceView
       end
 
       def process_action_with_traceview(*args)
-        report_kvs = {
+        kvs = {
           :Controller   => self.class.name,
           :Action       => action_name,
         }
-        TraceView::API.log(nil, 'info', report_kvs)
+        kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:action_controller][:collect_backtraces]
+        TraceView::API.log(nil, 'info', kvs)
 
         process_action_without_traceview(*args)
       rescue Exception
-        report_kvs[:Status] = 500
-        TraceView::API.log(nil, 'info', report_kvs)
+        kvs[:Status] = 500
+        TraceView::API.log(nil, 'info', kvs)
         raise
       end
     end