oboe 2.7.1.7-java → 2.7.2.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f61d146e29c52fd9cfd7df4b64e37907660c646
-  data.tar.gz: 6e0643dfdd8202eab11ddf38f0f5ddc36b67d563
+  metadata.gz: 44cdd9c6976e59b8300d6360a68f7072be9f965d
+  data.tar.gz: 41db567e21e8a0bdb4848c371c04490700d1bb71
 SHA512:
-  metadata.gz: f1ee3d5063bae9674ac2083a12a08459aa5103f209d7d7548df53ad5e7edc721b45182fa96483d3ab3e196a6ebb9cd53355d2150b1800fc1194e453a24a61e23
-  data.tar.gz: ff2ec048ad2c95013644396bf71a3fb3626b737b51c9be8796d5de835e3c07eee6660d0fa8dd1ed9608ae9bc35df10308b62c8faf8e213a1123026a2ffcca6b7
+  metadata.gz: 0efc756cc2b47d47eb1b3d4a4d2b285032b3fc0e3836041a7a1b3774ef773960ef672408c0a74a69a73b1fb3cbd3de3a00c8b17ce9744388b7e4753f1db62128
+  data.tar.gz: b1c8edfb51062734b1e6a9a6e86e0a3d83442d0ef7db1a17591d3f678b9b00d1fbf9403caf4387a9a15938bcc3b151bac2f68dcf038a7b1436f2b7a750e8f4a3

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets

data/Gemfile

@@ -26,6 +26,8 @@ gem 'cassandra'
 gem 'mongo'
 gem 'resque'
 gem 'redis'
+gem 'faraday'
+gem 'excon'
 
 if RUBY_VERSION >= '1.9'
   gem 'moped'

data/README.md

@@ -123,7 +123,7 @@ You must explicitly tell your Grape application to use Oboe::Rack for tracing to
 
 ## Custom Ruby Scripts & Applications
 
-The oboe gem has the ability to instrument any arbitrary Ruby application or script as long as the gem is initialized with the manual methods:
+The oboe gem has the ability to instrument any arbitrary Ruby application or script.  Only the `tracing_mode` needs to be set to tell the oboe gem to initiate performance metric collection.
 
 ```ruby
 require 'rubygems'
@@ -135,12 +135,12 @@ require 'oboe'
 
 # Tracing mode can be 'never', 'through' (to follow upstream) or 'always'
 Oboe::Config[:tracing_mode] = 'always'
-
-Oboe::Ruby.initialize
 ```
 
 From here, you can use the Tracing API to instrument areas of code using `Oboe::API.start_trace` (see below).  If you prefer to instead dive directly into code, take a look at [this example](https://gist.github.com/pglombardo/8550713) of an instrumented Ruby script.
 
+Once inside of the `Oboe::API.start_trace` block, performance metrics will be automatically collected for all supported libraries and gems (Redis, Mongo, ActiveRecord etc..).
+
 ## Other
 
 You can send deploy notifications to TraceView and have the events show up on your dashboard.  See: [Capistrano Deploy Notifications with tlog](https://support.appneta.com/cloud/capistrano-deploy-notifications-tlog)

data/ext/oboe_metal/extconf.rb

@@ -7,7 +7,7 @@ require 'rbconfig'
 # Check if we're running in JRuby
 jruby = defined?(JRUBY_VERSION) ? true : false
 
-openshift = ENV.has_key?('OPENSHIFT_TRACEVIEW_DIR')
+openshift = ENV.key?('OPENSHIFT_TRACEVIEW_DIR')
 
 # When on OpenShift, set the mkmf lib paths so we have no issues linking to
 # the TraceView libs.
@@ -23,7 +23,7 @@ else
   dir_config('oboe')
 end
 
-if jruby or ENV.has_key?('TRACEVIEW_URL')
+if jruby || ENV.key?('TRACEVIEW_URL')
   # Build the noop extension under JRuby and Heroku.
   # The oboe-heroku gem builds it's own c extension which links to
   # libs specific to a Heroku dyno
@@ -32,30 +32,30 @@ if jruby or ENV.has_key?('TRACEVIEW_URL')
 
 elsif have_library('oboe', 'oboe_config_get_revision', 'oboe/oboe.h')
 
-  $libs = append_library($libs, "oboe")
-  $libs = append_library($libs, "stdc++")
+  $libs = append_library($libs, 'oboe')
+  $libs = append_library($libs, 'stdc++')
 
-  $CFLAGS << " #{ENV["CFLAGS"]}"
-  $CPPFLAGS << " #{ENV["CPPFLAGS"]}"
-  $LIBS << " #{ENV["LIBS"]}"
+  $CFLAGS << " #{ENV['CFLAGS']}"
+  $CPPFLAGS << " #{ENV['CPPFLAGS']}"
+  $LIBS << " #{ENV['LIBS']}"
 
   # On OpenShift user rpath to point out the TraceView libraries
   if openshift
-    $LDFLAGS << " #{ENV["LDFLAGS"]} -Wl,-rpath=#{tv_lib64},--rpath=#{tv_tlyzer}"
+    $LDFLAGS << " #{ENV['LDFLAGS']} -Wl,-rpath=#{tv_lib64},--rpath=#{tv_tlyzer}"
   end
 
   if RUBY_VERSION < '1.9'
     cpp_command('g++')
-    $CPPFLAGS << "-I./src/"
+    $CPPFLAGS << '-I./src/'
   end
   create_makefile('oboe_metal', 'src')
 
 else
   if have_library('oboe')
-    $stderr.puts "Error: The oboe gem requires an updated liboboe.  Please update your liboboe packages."
+    $stderr.puts 'Error: The oboe gem requires an updated liboboe.  Please update your liboboe packages.'
   end
 
-  $stderr.puts "Error: Could not find the base liboboe libraries.  No tracing will occur."
+  $stderr.puts 'Error: Could not find the base liboboe libraries.  No tracing will occur.'
   create_makefile('oboe_noop', 'noop')
 end
 

data/lib/joboe_metal.rb

@@ -48,42 +48,36 @@ module Oboe_metal
     # Initialize the Oboe Context, reporter and report the initialization
     #
     def self.start
-      begin
-        return unless Oboe.loaded
-
-        if ENV.has_key?("OBOE_GEM_TEST")
-          Oboe.reporter = Java::ComTracelyticsJoboe::TestReporter.new
-        else
-          Oboe.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance().buildUdpReporter()
-        end
+      return unless Oboe.loaded
 
+      if ENV.key?('OBOE_GEM_TEST')
+        Oboe.reporter = Java::ComTracelyticsJoboe::TestReporter.new
+      else
+        Oboe.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance.buildUdpReporter
+      end
 
-        # 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
-          Oboe::Config.tracing_mode = 'always'
-        elsif cfg.hasSampleThroughFlag
-          Oboe::Config.tracing_mode = 'through'
-        else
-          Oboe::Config.tracing_mode = 'never'
-        end
+      # 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)
 
-        Oboe.sample_rate = cfg.sampleRate
-        Oboe::Config.sample_rate = cfg.sampleRate
-        Oboe::Config.sample_source = cfg.sampleRateSource.a
+      if cfg.hasSampleStartFlag
+        Oboe::Config.tracing_mode = 'always'
+      elsif cfg.hasSampleThroughFlag
+        Oboe::Config.tracing_mode = 'through'
+      else
+        Oboe::Config.tracing_mode = 'never'
+      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)
-          Oboe::API.report_init
-        end
+      Oboe.sample_rate = cfg.sampleRate
+      Oboe::Config.sample_rate = cfg.sampleRate
+      Oboe::Config.sample_source = cfg.sampleRateSource.a
 
-      rescue Exception => e
-        $stderr.puts e.message
-        raise
+      # 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)
+        Oboe::API.report_init
       end
     end
 
@@ -112,7 +106,7 @@ module Oboe_metal
       traces = []
       Oboe.reporter.getSentEventsAsBsonDocument.to_a.each do |e|
         t = {}
-        e.each_pair { |k,v|
+        e.each_pair { |k, v|
           t[k] = v
         }
         traces << t
@@ -133,22 +127,23 @@ module Oboe
   class << self
     def sample?(opts = {})
       begin
-        return false unless Oboe.always? and Oboe.loaded
+        return false unless Oboe.always? && Oboe.loaded
 
-        return true if ENV['OBOE_GEM_TEST'] == "test"
+        return true if ENV.key?('OBOE_GEM_TEST')
 
         # Validation to make Joboe happy.  Assure that we have the KVs and that they
         # are not empty strings.
-        opts[:layer]  = nil      if opts[:layer].is_a?(String)      and opts[:layer].empty?
-        opts[:xtrace] = nil      if opts[:xtrace].is_a?(String)     and opts[:xtrace].empty?
-        opts['X-TV-Meta'] = nil  if opts['X-TV-Meta'].is_a?(String) and opts['X-TV-Meta'].empty?
+        opts[:layer]  = nil      if opts[:layer].is_a?(String)      && opts[:layer].empty?
+        opts[:xtrace] = nil      if opts[:xtrace].is_a?(String)     && opts[:xtrace].empty?
+        opts['X-TV-Meta'] = nil  if opts['X-TV-Meta'].is_a?(String) && opts['X-TV-Meta'].empty?
 
         opts[:layer]      ||= nil
         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 Oboe::Config
         if sr_cfg
@@ -163,11 +158,11 @@ module Oboe
       end
     end
 
-    def set_tracing_mode(mode)
-      Oboe.logger.warn "When using JRuby set the tracing mode in /usr/local/tracelytics/javaagent.json instead"
+    def set_tracing_mode(_mode)
+      Oboe.logger.warn 'When using JRuby set the tracing mode in /usr/local/tracelytics/javaagent.json instead'
     end
 
-    def set_sample_rate(rate)
+    def set_sample_rate(_rate)
       # N/A
     end
   end
@@ -180,4 +175,3 @@ if status == Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
 else
   Oboe.loaded = true
 end
-

data/lib/oboe.rb

@@ -2,53 +2,55 @@
 # All rights reserved.
 
 begin
-  require "oboe/version"
-  require "oboe/thread_local"
-  require "oboe/logger"
-  require "oboe/util"
-  require "oboe/xtrace"
+  require 'oboe/version'
+  require 'oboe/thread_local'
+  require 'oboe/logger'
+  require 'oboe/util'
+  require 'oboe/xtrace'
 
   # If OboeHeroku is already defined then we are in a PaaS environment
   # with an alternate metal (see the oboe-heroku gem)
   unless defined?(OboeHeroku)
-    require "oboe/base"
+    require 'oboe/base'
 
     begin
       if RUBY_PLATFORM == 'java'
-        require "/usr/local/tracelytics/tracelyticsagent.jar"
-        require "joboe_metal"
+        require '/usr/local/tracelytics/tracelyticsagent.jar'
+        require 'joboe_metal'
       else
-        require "oboe_metal.so"
-        require "oboe_metal"
+        require 'oboe_metal.so'
+        require 'oboe_metal'
       end
     rescue LoadError
       Oboe.loaded = false
 
-      unless ENV['RAILS_GROUP'] == 'assets'
-        $stderr.puts "=============================================================="
-        $stderr.puts "Missing TraceView libraries.  Tracing disabled."
-        $stderr.puts "See: https://support.tv.appneta.com/solution/articles/137973"
-        $stderr.puts "=============================================================="
+      unless ENV['RAILS_GROUP'] == 'assets' or ENV['IGNORE_TRACEVIEW_WARNING']
+        $stderr.puts '=============================================================='
+        $stderr.puts 'Missing TraceView libraries.  Tracing disabled.'
+        $stderr.puts 'See: http://bit.ly/1DaNOjw'
+        $stderr.puts '=============================================================='
       end
     end
   end
 
-  require "oboe/config"
+  require 'oboe/config'
 
   if Oboe.loaded
-    require "oboe/loading"
-    require "method_profiling"
-    require "oboe/instrumentation"
-    require "oboe/ruby"
+    require 'oboe/loading'
+    require 'oboe/method_profiling'
+    require 'oboe/instrumentation'
 
     # Frameworks
-    require "oboe/frameworks/rails"   if defined?(::Rails)
-    require "oboe/frameworks/sinatra" if defined?(::Sinatra)
-    require "oboe/frameworks/padrino" if defined?(::Padrino)
-    require "oboe/frameworks/grape"   if defined?(::Grape)
+    require 'oboe/frameworks/rails'
+    require 'oboe/frameworks/sinatra'
+    require 'oboe/frameworks/padrino'
+    require 'oboe/frameworks/grape'
   end
-rescue Exception => e
-  $stderr.puts "[oboe/error] Problem loading: #{e.inspect}"
+
+  # Load Ruby module last.  If there is no framework detected,
+  # it will load all of the Ruby instrumentation
+  require 'oboe/ruby'
+rescue => e
+  $stderr.puts '[oboe/error] Problem loading: #{e.inspect}'
   $stderr.puts e.backtrace
 end
-

data/lib/oboe/api.rb

@@ -2,6 +2,10 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # This module implements the TraceView tracing API.
+  # See: https://github.com/appneta/oboe-ruby#the-tracing-api
+  # and/or: http://rdoc.info/gems/oboe/Oboe/API/Tracing
   module API
     def self.extend_with_tracing
       extend Oboe::API::Logging

data/lib/oboe/api/layerinit.rb

@@ -3,6 +3,8 @@
 
 module Oboe
   module API
+    ##
+    # Provides methods related to layer initialization and reporting
     module LayerInit
       # Internal: Report that instrumentation for the given layer has been
       # installed, as well as the version of instrumentation and version of
@@ -10,7 +12,7 @@ module Oboe
       #
       def report_init(layer = 'rack')
         # Don't send __Init in development or test
-        return if ["development", "test"].include? ENV['RACK_ENV']
+        return if %w(development test).include? ENV['RACK_ENV']
 
         # Don't send __Init if the c-extension hasn't loaded
         return unless Oboe.loaded
@@ -44,8 +46,8 @@ module Oboe
           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.has_key?('mongo')
-            platform_info['Ruby.Mongo.Version']     = "Mongo-#{::Gem.loaded_specs['mongo'].version.to_s}"
+          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)
@@ -66,7 +68,7 @@ module Oboe
           elsif defined?(::WEBrick)
             platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"
           else
-            platform_info['Ruby.AppContainer.Version'] = File.basename($0)
+            platform_info['Ruby.AppContainer.Version'] = File.basename($PROGRAM_NAME)
           end
 
         rescue StandardError, ScriptError => e
@@ -79,14 +81,15 @@ module Oboe
           Oboe.logger.debug e.backtrace
         end
 
-        start_trace(layer, nil, platform_info.merge('Force' => true)) { }
+        start_trace(layer, nil, platform_info.merge('Force' => true)) {}
       end
 
       ##
       # force_trace has been deprecated and will be removed in a subsequent version.
       #
       def force_trace
-        Oboe.logger.warn "Oboe::API::LayerInit.force_trace has been deprecated and will be removed in a subsequent version."
+        Oboe.logger.warn 'Oboe::API::LayerInit.force_trace has been deprecated and will be ' \
+                         'removed in a subsequent version.'
 
         saved_mode = Oboe::Config[:tracing_mode]
         Oboe::Config[:tracing_mode] = 'always'

data/lib/oboe/api/logging.rb

@@ -3,8 +3,9 @@
 
 module Oboe
   module API
+    ##
+    # This modules provides the X-Trace logging facilities.
     module Logging
-
       # Public: Report an event in an active trace.
       #
       # layer - The layer the reported event belongs to
@@ -20,7 +21,7 @@ module Oboe
       #   log('logical_layer', 'exit')
       #
       # Returns nothing.
-      def log(layer, label, opts={})
+      def log(layer, label, opts = {})
         log_event(layer, label, Oboe::Context.createEvent, opts)
       end
 
@@ -40,14 +41,14 @@ module Oboe
       #
       # Returns nothing.
       def log_exception(layer, exn)
-        unless exn.instance_variable_get(:@oboe_logged)
-          log(layer, 'error', {
-            :ErrorClass => exn.class.name,
-            :Message => exn.message,
-            :Backtrace => exn.backtrace.join("\r\n")
-          })
-          exn.instance_variable_set(:@oboe_logged, true)
-        end
+        return if exn.instance_variable_get(:@oboe_logged)
+
+        kvs = { :ErrorClass => exn.class.name,
+                :Message => exn.message,
+                :Backtrace => exn.backtrace.join("\r\n") }
+
+        exn.instance_variable_set(:@oboe_logged, true)
+        log(layer, 'error', kvs)
       end
 
       # Public: Decide whether or not to start a trace, and report an event
@@ -59,16 +60,14 @@ module Oboe
       #        with this event (optional).
       #
       # Returns nothing.
-      def log_start(layer, xtrace, opts={})
-        return if Oboe.never? or (opts.has_key?(:URL) and ::Oboe::Util.static_asset?(opts[:URL]))
+      def log_start(layer, xtrace, opts = {})
+        return if Oboe.never? || (opts.key?(:URL) && ::Oboe::Util.static_asset?(opts[:URL]))
 
-        if xtrace and not xtrace.to_s.empty?
-          Oboe::Context.fromString(xtrace)
-        end
+        Oboe::Context.fromString(xtrace) if xtrace && !xtrace.to_s.empty?
 
         if Oboe.tracing?
           log_entry(layer, opts)
-        elsif opts.has_key?('Force') or Oboe.sample?(opts.merge(:layer => layer, :xtrace => xtrace))
+        elsif opts.key?('Force') || Oboe.sample?(opts.merge(:layer => layer, :xtrace => xtrace))
           log_event(layer, 'entry', Oboe::Context.startTrace, opts)
         end
       end
@@ -78,21 +77,46 @@ module Oboe
       # layer - The layer the reported event belongs to
       #
       # Returns an xtrace metadata string
-      def log_end(layer, opts={})
+      def log_end(layer, opts = {})
         log_event(layer, 'exit', Oboe::Context.createEvent, opts)
         xtrace = Oboe::Context.toString
         Oboe::Context.clear
         xtrace
       end
 
-      def log_entry(layer, opts={}, protect_op=nil)
-        Oboe.layer_op = protect_op if protect_op
-        log_event(layer, 'entry', Oboe::Context.createEvent, opts)
+      ##
+      # Public: Log an entry event
+      #
+      # A helper method to create and log an
+      # entry event
+      #
+      # Returns an xtrace metadata string
+      def log_entry(layer, kvs = {}, op = nil)
+        Oboe.layer_op = op if op
+        log_event(layer, 'entry', Oboe::Context.createEvent, kvs)
       end
 
-      def log_exit(layer, opts={}, protect_op=nil)
-        Oboe.layer_op = nil if protect_op
-        log_event(layer, 'exit', Oboe::Context.createEvent, opts)
+      ##
+      # Public: Log an info event
+      #
+      # A helper method to create and log an
+      # info event
+      #
+      # Returns an xtrace metadata string
+      def log_info(layer, kvs = {})
+        log_event(layer, 'info', Oboe::Context.createEvent, kvs)
+      end
+
+      ##
+      # Public: Log an exit event
+      #
+      # A helper method to create and log an
+      # exit event
+      #
+      # Returns an xtrace metadata string
+      def log_exit(layer, kvs = {}, op = nil)
+        Oboe.layer_op = nil if op
+        log_event(layer, 'exit', Oboe::Context.createEvent, kvs)
       end
 
       # Internal: Report an event.
@@ -112,15 +136,13 @@ module Oboe
       #   log_event('rails', 'exit', exit)
       #
       # Returns nothing.
-      def log_event(layer, label, event, opts={})
-        if layer
-            event.addInfo('Layer', layer.to_s)
-        end
+      def log_event(layer, label, event, opts = {})
+        event.addInfo('Layer', layer.to_s) if layer
         event.addInfo('Label', label.to_s)
 
         opts.each do |k, v|
           event.addInfo(k.to_s, v.to_s) if valid_key? k
-        end if !opts.nil? and opts.any?
+        end if !opts.nil? && opts.any?
 
         Oboe::Reporter.sendReport(event) if Oboe.loaded
       end