oboe 2.1.4 → 2.2.0

data/CHANGELOG

@@ -1,31 +1,41 @@
 
+# oboe 2.2.0
+
+* Initial support for Rails 4
+* Various internal reporting fixes and improvements
+* Fix for auto sampling rate
+
+# oboe 2.1.4 (08/01/13)
+
+* Integration support for AppView Web
+
 # oboe 2.1.3 (07/16/13)
 
 * Allow _Access Key_ assignment via Environment variable: TRACEVIEW_CUUID
 
-# oboe 2.1.1 (07/04/13)
+# oboe 2.1.1
 
 * The gem now logs via a standard Ruby logger: Oboe.logger
 * Add in rspec tests
 * JRuby now supports Smart Tracing
 * Fixed an invalid Profile name in ActionView Partial tracing
 
-# oboe 1.4.2.2 (05/16/13)
+# oboe 1.4.2.2
 
 * Rack - add handling for potential nil result
 
-# oboe 1.4.2 (05/02/13)
+# oboe 1.4.2
 
 * Cassandra - ensure all keys are captured when reporting exceptions
 * JRuby detection fix
 
-# oboe 1.4.1.2 (04/29/13)
+# oboe 1.4.1.2
 
 * HTTP keys now captured at Rack level instead of Rails
 * RUM templates are now pre-loaded
 * Improved layer agnostic info event reporting
 
-# oboe 1.4.0.2 (03/08/13)
+# oboe 1.4.0.2
 
 * Resque support
 * Fix Rails 2 bug where SET and SHOW could result in recursive calls
@@ -35,49 +45,49 @@ of hits
 instrumentation
 * Configuration - sending Resque parameters can be skipped if privacy an issue.
 
-# oboe 1.3.9.1 (02/04/13)
+# oboe 1.3.9.1
 
 * Add in Rack instrumentation
 * Fix Function profiling of class methods bug
 * Add backtraces to Cassandra and Mongo operations
 * Rename the "render" layer to "actionview"
 
-# oboe 1.3.8 (01/04/13)
+# oboe 1.3.8
 
 * More comprehensive JRuby support
 
-# oboe 1.3.7 (12/10/12)
+# oboe 1.3.7
 
 * Added Moped driver instrumentation (Mongo/Mongoid)
 
-# oboe 1.3.6 (12/10/12)
+# oboe 1.3.6
 
 * Added Rails ActionView partial and collection rendering instrumentation
 
-# oboe 1.3.5 (11/14/12)
+# oboe 1.3.5
 
 * Added cassandra instrumentation
 
-# oboe 1.3.4 (10/23/12)
+# oboe 1.3.4
 
 * Added mongo-ruby-driver support
 
-# oboe 1.3.3 (10/18/12)
+# oboe 1.3.3
 
 * Updated RUM instrumentation templates
 
-# oboe 1.3.2 (10/17/12)
+# oboe 1.3.2
 
 * Fix a case when the RUM instrumentation header/footer methods would not 
 return JS output, depending on how the way they were called from HAML.
 
-# oboe 1.3.1 (10/15/12)
+# oboe 1.3.1
 
 * Support for RUM instrumentation.
 Fix for certain cases where exceptions were not properly propagated up to Rails 
 error handlers.
 
-# oboe 1.3.0 (9/26/12)
+# oboe 1.3.0
 
 * The oboe and oboe_fu gems have been merged to simplify installation. The 
 final oboe_fu gem (1.3.0) simply calls "require 'oboe'" now for backwards 
@@ -88,11 +98,11 @@ Ruby oboe API methods.
 base packages (liboboe) installed, so you can deploy to environments with or 
 without TraceView support.
 
-# oboe_fu 1.2.1 (9/12/12)
+# oboe_fu 1.2.1
 
 * Support for instrumenting the dalli module.
 
-# oboe_fu 1.2.0 (8/28/12)
+# oboe_fu 1.2.0
 
 * Support for Rails 2.3, 3.0, 3.1, and 3.2.
 

data/lib/oboe/api.rb

@@ -6,6 +6,7 @@ module Oboe
     def self.extend_with_tracing
       extend Oboe::API::Logging
       extend Oboe::API::Tracing
+      extend Oboe::API::Profiling
       extend Oboe::API::LayerInit
     end
     extend Oboe::API::Util

data/lib/oboe/api/layerinit.rb

@@ -9,12 +9,12 @@ module Oboe
         platform_info = { '__Init' => 1 }
         
         begin
-          platform_info['Force']                 = true
-          platform_info['RubyPlatformVersion']   = RUBY_PLATFORM
-          platform_info['RubyVersion']           = RUBY_VERSION
-          platform_info['RailsVersion']          = ::Rails.version if defined?(Rails)
-          platform_info['OboeRubyVersion']       = Oboe::Version::STRING
-          platform_info['OboeHerokuRubyVersion'] = OboeHeroku::Version::STRING if defined?(OboeHeroku)
+          platform_info['Force']                   = true
+          platform_info['Ruby.Platform.Version']   = RUBY_PLATFORM
+          platform_info['Ruby.Version']            = RUBY_VERSION
+          platform_info['Ruby.Rails.Version']      = ::Rails.version if defined?(::Rails)
+          platform_info['Ruby.Oboe.Version']       = ::Oboe::Version::STRING
+          platform_info['Ruby.OboeHeroku.Version'] = ::OboeHeroku::Version::STRING if defined?(::OboeHeroku)
         rescue
         end
 

data/lib/oboe/api/profiling.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+module Oboe
+  module API
+    module Profiling 
+
+      ##
+      # Public: Profile a given block of code. Detect any exceptions thrown by
+      # the block and report errors.
+      #
+      # profile_name - A name used to identify the block being profiled.
+      # report_kvs - A hash containing key/value pairs that will be reported along
+      # with the event of this profile (optional).
+      #
+      # Example
+      #
+      #   def computation(n)
+      #     Oboe::API.profile('fib', { :n => n }) do
+      #       fib(n)
+      #     end
+      #   end
+      #
+      # Returns the result of the block.
+      def profile(profile_name, report_kvs={})
+        
+        report_kvs[:Language] ||= :ruby
+        report_kvs[:ProfileName] ||= profile_name
+
+        Oboe::Context.log(nil, 'profile_entry', report_kvs)
+
+        begin 
+          yield
+        rescue Exception => e
+          log_exception(nil, e) 
+          raise
+        ensure
+          exit_kvs = {}
+          exit_kvs[:Language] = :ruby
+          exit_kvs[:ProfileName] = report_kvs[:ProfileName]
+
+          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+        end
+      end
+    end
+  end
+end

data/lib/oboe/config.rb

@@ -43,6 +43,9 @@ module Oboe
       @@config[:blacklist] = []
 
       update!(data)
+
+      # For Initialization, mark this as the default SampleRate
+      @@config[:sample_source] = 2 # OBOE_SAMPLE_RATE_SOURCE_DEFAULT
     end
 
     def self.update!(data)
@@ -57,6 +60,35 @@ module Oboe
 
     def self.[]=(key, value)
       @@config[key.to_sym] = value
+
+      if key == :sample_rate
+        # When setting SampleRate, note that it's been manually set
+        # OBOE_SAMPLE_RATE_SOURCE_FILE == 1
+        @@config[:sample_source] = 1 
+       
+        # Validate :sample_rate value
+        unless value.between?(1, 1e6)
+          raise "oboe :sample_rate must be between 1 and 1000000 (1m)" 
+        end
+
+        # Update liboboe with the new SampleRate value
+        Oboe::Context.setDefaultSampleRate(value)
+      end
+
+      # Update liboboe if updating :tracing_mode
+      if key == :tracing_mode
+        case value.downcase
+        when 'never'
+          # OBOE_TRACE_NEVER
+          Oboe::Context.setTracingMode(0)
+        when 'always'
+          # OBOE_TRACE_ALWAYS
+          Oboe::Context.setTracingMode(1)
+        else
+          # OBOE_TRACE_THROUGH
+          Oboe::Context.setTracingMode(2)
+        end
+      end
     end
 
     def self.method_missing(sym, *args)

data/lib/oboe/frameworks/rails.rb

@@ -108,7 +108,6 @@ if defined?(::Rails)
 
         config.after_initialize do
           Oboe::Loading.setup_logger
-          Oboe::Loading.set_tracing_mode
           Oboe::Loading.load_access_key
           Oboe::Inst.load_instrumentation
           Oboe::Rails.load_instrumentation
@@ -118,7 +117,6 @@ if defined?(::Rails)
   else
     Oboe::Loading.setup_logger
     Oboe::Rails.load_initializer
-    Oboe::Loading.set_tracing_mode
     Oboe::Loading.load_access_key
     
     Rails.configuration.after_initialize do

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

@@ -6,9 +6,9 @@ module Oboe
     module Rails3ActionController
       def self.included(base)
         base.class_eval do
-          alias_method_chain :render, :oboe
           alias_method_chain :process, :oboe
           alias_method_chain :process_action, :oboe
+          alias_method_chain :render, :oboe
         end
       end
       
@@ -38,15 +38,47 @@ module Oboe
         end
       end
     end
+    
+    module Rails4ActionController
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :process_action, :oboe
+          alias_method_chain :render, :oboe
+        end
+      end
+      
+      def process_action_with_oboe(method_name, *args)
+        report_kvs = {
+          :Controller   => self.class.name,
+          :Action       => self.action_name,
+        }
+        Oboe::API.trace('rails', report_kvs) do
+          process_action_without_oboe(method_name, *args)
+        end
+      end
+
+      def render_with_oboe(*args)
+        Oboe::API.trace('actionview', {}) do
+          render_without_oboe(*args)
+        end
+      end
+    end
   end
 end
 
 if defined?(ActionController::Base) and Oboe::Config[:action_controller][:enabled]
-  if ::Rails::VERSION::MAJOR == 3
+  if ::Rails::VERSION::MAJOR == 4
+
+    class ActionController::Base
+      include Oboe::Inst::Rails4ActionController
+    end
+  
+  elsif ::Rails::VERSION::MAJOR == 3
 
     class ActionController::Base
       include Oboe::Inst::Rails3ActionController
     end
+
   elsif ::Rails::VERSION::MAJOR == 2
 
     ActionController::Base.class_eval do

data/lib/oboe/frameworks/rails/inst/action_view.rb

@@ -3,190 +3,54 @@
 
 if defined?(ActionView::Base) and Oboe::Config[:action_view][:enabled]
 
-  if Rails::VERSION::MAJOR == 3
-    Oboe.logger.info "[oboe/loading] Instrumenting actionview" if Oboe::Config[:verbose]
-
-    if Rails::VERSION::MINOR == 0
-      ActionView::Partials::PartialRenderer.class_eval do
-        alias :render_partial_without_oboe :render_partial
-        def render_partial(object = @object)
-          entry_kvs = {}
-          begin
-            entry_kvs[:Language]     = :ruby
-            entry_kvs[:FunctionName] = :render_partial
-            entry_kvs[:Class]        = :PartialRenderer
-            entry_kvs[:Module]       = 'ActionView::Partials'
-            entry_kvs[:File]         = __FILE__
-            entry_kvs[:LineNumber]   = __LINE__
-            entry_kvs[:ProfileName]  = @options[:partial].to_s if @options.is_a?(Hash)
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
-          ret =  render_partial_without_oboe(object)
-
-          exit_kvs = {}
-          begin
-            exit_kvs[:Language] = :ruby
-            exit_kvs[:ProfileName]  = @options[:partial].to_s if @options.is_a?(Hash)
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
-          ret
-        end
-        
-        alias :render_collection_without_oboe :render_collection
-        def render_collection
-          entry_kvs = {}
-          begin
-            entry_kvs[:Language]     = :ruby
-            entry_kvs[:ProfileName]  = @path
-            entry_kvs[:FunctionName] = :render_collection
-            entry_kvs[:Class]        = :PartialRenderer
-            entry_kvs[:Module]       = 'ActionView::Partials'
-            entry_kvs[:File]         = __FILE__
-            entry_kvs[:LineNumber]   = __LINE__
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
-          ret =  render_collection_without_oboe
-
-          exit_kvs = {}
-          begin
-            exit_kvs[:Language] = :ruby
-            exit_kvs[:ProfileName]  = @path
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
-          ret
-        end
-      end
-    else
-      ActionView::PartialRenderer.class_eval do
-        alias :render_partial_without_oboe :render_partial
-        def render_partial
-          entry_kvs = {}
-          begin
-            entry_kvs[:Language]     = :ruby
-            entry_kvs[:FunctionName] = :render_partial
-            entry_kvs[:Class]        = :PartialRenderer
-            entry_kvs[:Module]       = :ActionView
-            entry_kvs[:File]         = __FILE__
-            entry_kvs[:LineNumber]   = __LINE__
-            entry_kvs[:ProfileName]  = @options[:partial].to_s if @options.is_a?(Hash)
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
-          ret =  render_partial_without_oboe
-
-          exit_kvs = {}
-          begin
-            exit_kvs[:Language] = :ruby
-            exit_kvs[:ProfileName]  = @options[:partial].to_s if @options.is_a?(Hash)
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
-          ret
-        end
-
-        alias :render_collection_without_oboe :render_collection
-        def render_collection
-          entry_kvs = {}
-          begin
-            entry_kvs[:Language]     = :ruby
-            entry_kvs[:ProfileName]  = @path
-            entry_kvs[:FunctionName] = :render_collection
-            entry_kvs[:Class]        = :PartialRenderer
-            entry_kvs[:Module]       = :ActionView
-            entry_kvs[:File]         = __FILE__
-            entry_kvs[:LineNumber]   = __LINE__
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
-          ret =  render_collection_without_oboe
+  ##
+  # ActionView Instrumentation is version dependent.  ActionView 2.x is separate 
+  # and ActionView 3.0 is a special case.
+  # Everything else goes here. (ActionView 3.1 - 4.0 as of this writing)
+  #
+  if (Rails::VERSION::MAJOR == 3 and Rails::VERSION::MINOR > 0) or Rails::VERSION::MAJOR == 4
 
-          exit_kvs = {}
-          begin
-            exit_kvs[:Language] = :ruby
-            exit_kvs[:ProfileName]  = @path
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
-          ret
-        end
-      end
-    end
-  elsif Rails::VERSION::MAJOR == 2
     Oboe.logger.info "[oboe/loading] Instrumenting actionview" if Oboe::Config[:verbose]
 
-    ActionView::Partials.module_eval do
+    ActionView::PartialRenderer.class_eval do
       alias :render_partial_without_oboe :render_partial
-      def render_partial(options = {})
-        if options.has_key?(:partial) and options[:partial].is_a?(String)
-          entry_kvs = {}
-          begin
-            entry_kvs[:Language]     = :ruby
-            entry_kvs[:FunctionName] = :render_partial
-            entry_kvs[:Class]        = :Partials
-            entry_kvs[:Module]       = :ActionView
-            entry_kvs[:File]         = __FILE__
-            entry_kvs[:LineNumber]   = __LINE__
-            entry_kvs[:ProfileName]  = options[:partial].to_s if options.is_a?(Hash)
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
-          ret = render_partial_without_oboe(options)
-
-          exit_kvs = {}
-          begin
-            exit_kvs[:Language] = :ruby
-            exit_kvs[:ProfileName] = options[:partial].to_s if options.is_a?(Hash)
-          rescue
-          end
-
-          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
-        else
-          ret = render_partial_without_oboe(options)
-        end
-        ret
-      end
-      
-      alias :render_partial_collection_without_oboe :render_partial_collection
-      def render_partial_collection(options = {})
+      def render_partial
         entry_kvs = {}
         begin
-          entry_kvs[:Language]     = :ruby
-          entry_kvs[:ProfileName]  = :collection
-          entry_kvs[:FunctionName] = :render_partial_collection
-          entry_kvs[:Class]        = :Partials
+          name = @options[:partial].to_s if @options.is_a?(Hash)
+          entry_kvs[:FunctionName] = :render_partial
+          entry_kvs[:Class]        = :PartialRenderer
           entry_kvs[:Module]       = :ActionView
           entry_kvs[:File]         = __FILE__
           entry_kvs[:LineNumber]   = __LINE__
         rescue
         end
 
-        Oboe::Context.log(nil, 'profile_entry', entry_kvs)
-        ret =  render_partial_collection_without_oboe(options)
+        Oboe::API.profile(name, entry_kvs) do
+          render_partial_without_oboe
+        end
+      end
 
-        exit_kvs = {}
+      alias :render_collection_without_oboe :render_collection
+      def render_collection
+        entry_kvs = {}
         begin
-          exit_kvs[:Language] = :ruby
-          exit_kvs[:ProfileName] = :collection
+          name = @path.to_s
+          entry_kvs[:FunctionName] = :render_collection
+          entry_kvs[:Class]        = :PartialRenderer
+          entry_kvs[:Module]       = :ActionView
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
         rescue
         end
 
-        Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
-        ret
+        Oboe::API.profile(name, entry_kvs) do
+          ret =  render_collection_without_oboe
+        end
       end
+        
     end
   end
 end
+
 # vim:set expandtab:tabstop=2