oboe 1.3.9.1 → 1.4.0.2

data/lib/joboe_metal.rb

@@ -77,41 +77,6 @@ end
 module Oboe
   include Oboe_metal
   
-  # TODO: Ensure that the :tracing_mode is set to "always", "through", or "never"
-  Config = {
-    :tracing_mode => "through",
-    :reporter_host => "127.0.0.1",
-    :sample_rate => 1000000
-  }
-
-  def self.passthrough?
-    ["always", "through"].include?(Oboe::Config[:tracing_mode])
-  end
-
-  def self.always?
-    Oboe::Config[:tracing_mode] == "always"
-  end
-
-  def self.through?
-    Oboe::Config[:tracing_mode] == "through"
-  end
-
-  def self.never?
-    Oboe::Config[:tracing_mode] == "never"
-  end
-
-  def self.now?
-    Oboe::Context.isValid and not Oboe.never?
-  end
-
-  def self.start?
-    not Oboe::Context.isValid and Oboe.always?
-  end
-
-  def self.continue?
-    Oboe::Context.isValid and not Oboe.never?
-  end
-
   def self.log(layer, label, options = {})
     Context.log(layer, label, options = options)
   end

data/lib/oboe/api/logging.rb

@@ -60,15 +60,15 @@ module Oboe
       #
       # Returns nothing.
       def log_start(layer, xtrace, opts={})
-        return if Oboe::Config.never?
+        return if Oboe.never?
   
         if xtrace
           Oboe::Context.fromString(xtrace)
         end
   
-        if Oboe::Config.tracing?
+        if Oboe.tracing?
           log_entry(layer, opts)
-        elsif Oboe::Config.always? or Oboe::Config.sample?
+        elsif Oboe.always? or Oboe.sample?
           log_event(layer, 'entry', Oboe::Context.startTrace, opts)
         end
       end

data/lib/oboe/api/memcache.rb

@@ -4,7 +4,7 @@
 module Oboe
   module API
     module Memcache
-      MEMCACHE_OPS = %w{add append cas decr decrement delete fetch get get_multi incr increment prepend replace set}
+      MEMCACHE_OPS = %w{add append cas decr decrement delete fetch get incr increment prepend replace set}
 
       def memcache_hit?(result)
         result.nil? ? 0 : 1

data/lib/oboe/api/tracing.rb

@@ -118,7 +118,7 @@ module Oboe
         log_start(layer, xtrace, opts)
         exit_evt = Oboe::Context.createEvent
         begin
-          target['X-Trace'] = Oboe::Event.metadataString(exit_evt) if Oboe::Config.tracing?
+          target['X-Trace'] = Oboe::Event.metadataString(exit_evt) if Oboe.tracing?
           yield
         rescue Exception => e
           log_exception(layer, e)

data/lib/oboe/config.rb

@@ -2,38 +2,113 @@
 # All rights reserved.
 
 module Oboe
-  # The following is done for compatability with older versions of oboe and
-  # oboe_fu (0.2.x)
-  if not defined?(Oboe::Config)
-    Config = {
-        :tracing_mode => "through",
-        :reporter_host => "127.0.0.1",
-        :sample_rate => 3e5
-    }
-  end
-
-  class << Config 
-    def always?
-      self[:tracing_mode].to_s == "always"
-    end
   
-    def never?
-      self[:tracing_mode].to_s == "never"
-    end
+  def self.always?
+    Oboe::Config[:tracing_mode].to_s == "always"
+  end
   
-    def tracing?
-      Oboe::Context.isValid and not never?
-    end
+  def self.continue?
+    Oboe::Context.isValid and not Oboe.never?
+  end
   
-    def start?
-      not Oboe::Context.isValid and always?
+  def self.log(layer, label, options = {})
+    Context.log(layer, label, options = options)
+  end
+
+  def self.never?
+    Oboe::Config[:tracing_mode].to_s == "never"
+  end
+
+  def self.now?
+    Oboe::Context.isValid and not Oboe.never?
+  end
+  
+  def self.passthrough?
+    ["always", "through"].include?(Oboe::Config[:tracing_mode])
+  end
+    
+  def self.sample?
+    # Note that this the only point in the code that currently does and
+    # should ever read the sample rate. When autopilot is released, modify
+    # the line below and that line only.
+    Oboe::Config[:sample_rate].to_i < rand(1e6)
+  end
+
+  def self.start?
+    not Oboe::Context.isValid and Oboe.always?
+  end
+  
+  def self.through?
+    Oboe::Config[:tracing_mode] == "through"
+  end
+    
+  def self.tracing?
+    Oboe::Context.isValid and not Oboe.never?
+  end
+
+  ############################
+  # Oboe Configuration Module
+  ############################
+  module Config
+    @@config = {}
+
+    @@instrumentation = [ :cassandra, :dalli, :nethttp, :memcached, :memcache, :mongo,
+                          :moped, :rack, :resque, :action_controller, :action_view, 
+                          :active_record ]
+
+    def self.show
+      @@config
     end
 
-    def sample?
-      # Note that this the only point in the code that currently does and
-      # should ever read the sample rate. When autopilot is released, modify
-      # the line below and that line only.
-      self[:sample_rate].to_i < rand(1e6)
+    def self.initialize(data={})
+      # Setup default instrumentation values
+      @@instrumentation.each do |k|
+        @@config[k] = {}
+        @@config[k][:enabled] = true
+        @@config[k][:log_args] = true
+      end
+
+      # Special instrument specific flags
+      #
+      # :link_workers - associates enqueue operations with the jobs they queue by piggybacking
+      #                 an additional argument that is stripped prior to job proecessing 
+      #                 !!Note: Make sure both the queue side and the Resque workers are instrumented
+      #                 or jobs will fail
+      #                 (Default: false)
+      @@config[:resque][:link_workers] = false
+
+      update!(data)
+    end
+
+    def self.update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def self.[](key)
+      @@config[key.to_sym]
+    end
+
+    def self.[]=(key, value)
+      @@config[key.to_sym] = value
+    end
+
+    def self.method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
     end
   end
 end
+
+config = {
+      :tracing_mode => "through",
+      :reporter_host => "127.0.0.1",
+      :sample_rate => 1000000,
+      :verbose => false }
+
+Oboe::Config.initialize(config)
+

data/lib/oboe/frameworks/rails.rb

@@ -5,8 +5,8 @@ module Oboe
 
       def oboe_rum_header
         begin
-          return unless Oboe::Config.has_key?(:rum_id)
-          if Oboe::Config.tracing?
+          return unless Oboe::Config.rum_id
+          if Oboe.tracing?
             if request.xhr?
               header_tmpl = File.read(File.dirname(__FILE__) + '/rails/helpers/rum/rum_ajax_header.js.erb')
             else
@@ -22,8 +22,8 @@ module Oboe
       
       def oboe_rum_footer
         begin
-          return unless Oboe::Config.has_key?(:rum_id)
-          if Oboe::Config.tracing?
+          return unless Oboe::Config.rum_id
+          if Oboe.tracing?
             # Even though the footer template is named xxxx.erb, there are no ERB tags in it so we'll
             # skip that step for now
             footer_tmpl = File.read(File.dirname(__FILE__) + '/rails/helpers/rum/rum_footer.js.erb')
@@ -53,7 +53,6 @@ module Oboe
       require tr_initializer if File.exists?(tr_initializer)
     end
 
-
     def self.load_instrumentation
       # Load the Rails specific instrumentation
       pattern = File.join(File.dirname(__FILE__), 'rails/inst', '*.rb')
@@ -101,7 +100,7 @@ if defined?(::Rails)
         end
 
         initializer 'oboe.rack' do |app|
-          puts "[oboe/loading] Instrumenting rack" if true or Oboe::Config[:verbose]
+          puts "[oboe/loading] Instrumenting rack" if Oboe::Config[:verbose]
           app.config.middleware.insert 0, "Oboe::Rack"
         end
 
@@ -115,14 +114,15 @@ if defined?(::Rails)
   else
     Oboe::Rails.load_initializer
     Oboe::Loading.load_access_key
-
-    puts "[oboe/loading] Instrumenting rack" if true or Oboe::Config[:verbose]
-    Rails.configuration.middleware.insert 0, "Oboe::Rack"
-
-    Oboe::Inst.load_instrumentation
-    Oboe::Rails.load_instrumentation
-    Oboe::Rails.include_helpers
     
+    Rails.configuration.after_initialize do
+      puts "[oboe/loading] Instrumenting rack" if Oboe::Config[:verbose]
+      Rails.configuration.middleware.insert 0, "Oboe::Rack"
+
+      Oboe::Inst.load_instrumentation
+      Oboe::Rails.load_instrumentation
+      Oboe::Rails.include_helpers
+    end
   end
 end
 

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

@@ -4,14 +4,21 @@
 module Oboe
   module Inst
     module Rails3ActionController
-      def process(*args)
-
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :render, :oboe
+          alias_method_chain :process, :oboe
+          alias_method_chain :process_action, :oboe
+        end
+      end
+      
+      def process_with_oboe(*args)
         Oboe::API.trace('rails', {}) do
-          super
+          process_without_oboe *args
         end
       end
 
-      def process_action(*args)
+      def process_action_with_oboe(*args)
         report_kvs = {
           'HTTP-Host'   => @_request.headers['HTTP_HOST'],
           :URL          => @_request.headers['REQUEST_URI'],
@@ -19,27 +26,28 @@ module Oboe
           :Controller   => self.class.name,
           :Action       => self.action_name,
         }
-        super
+        result = process_action_without_oboe *args
 
         report_kvs[:Status] = @_response.status
         Oboe::API.log('rails', 'info', report_kvs)
-      
+     
+        result
       rescue Exception => exception
         report_kvs[:Status] = 500
         Oboe::API.log('rails', 'info', report_kvs)
         raise
       end
 
-      def render(*args)
+      def render_with_oboe(*args)
         Oboe::API.trace('actionview', {}) do
-          super
+          render_without_oboe *args
         end
       end
     end
   end
 end
 
-if defined?(ActionController::Base)
+if defined?(ActionController::Base) and Oboe::Config[:action_controller][:enabled]
   if ::Rails::VERSION::MAJOR == 3
     Oboe::API.report_init('rails')
 
@@ -92,3 +100,4 @@ if defined?(ActionController::Base)
   end
   puts "[oboe/loading] Instrumenting actioncontroler" if Oboe::Config[:verbose]
 end
+# vim:set expandtab:tabstop=2

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

@@ -1,9 +1,10 @@
 # Copyright (c) 2012 by Tracelytics, Inc.
 # All rights reserved.
 
-if defined?(ActionView::Base)
+if defined?(ActionView::Base) and Oboe::Config[:action_view][:enabled]
+
   if Rails::VERSION::MAJOR == 3
-    puts "[oboe/loading] Instrumenting actionview" 
+    puts "[oboe/loading] Instrumenting actionview" if Oboe::Config[:verbose]
 
     if Rails::VERSION::MINOR == 0
       ActionView::Partials::PartialRenderer.class_eval do
@@ -123,7 +124,7 @@ if defined?(ActionView::Base)
       end
     end
   elsif Rails::VERSION::MAJOR == 2
-    puts "[oboe/loading] Instrumenting ActionView" 
+    puts "[oboe/loading] Instrumenting actionview" if Oboe::Config[:verbose]
 
     ActionView::Partials.module_eval do
       alias :render_partial_without_oboe :render_partial

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

@@ -8,19 +8,21 @@ module Oboe
         def extract_trace_details(sql, name = nil)
           opts = {}
 
-          opts[:Query] = sql.to_s
-          opts[:Name] = name.to_s if name
-          opts[:Backtrace] = Oboe::API.backtrace
+          begin
+            opts[:Query] = sql.to_s
+            opts[:Name] = name.to_s if name
+            opts[:Backtrace] = Oboe::API.backtrace
 
-          if defined?(ActiveRecord::Base.connection.cfg)
-            opts[:Database] = ActiveRecord::Base.connection.cfg[:database]
-            if ActiveRecord::Base.connection.cfg.has_key?(:host)
-              opts[:RemoteHost] = ActiveRecord::Base.connection.cfg[:host]
-            end
-          end
+            if ::Rails::VERSION::MAJOR == 2
+              config = ::Rails.configuration.database_configuration[::Rails.env]
+            else
+              config = ::Rails.application.config.database_configuration[::Rails.env]
+            end  
 
-          if defined?(ActiveRecord::Base.connection.adapter_name)
-            opts[:Flavor] = ActiveRecord::Base.connection.adapter_name
+            opts[:Database]   = config["database"] if config.has_key?("database")
+            opts[:RemoteHost] = config["host"]     if config.has_key?("host")
+            opts[:Flavor]     = config["adapter"]  if config.has_key?("adapter")
+          rescue Exception => e
           end
 
           return opts || {}
@@ -37,7 +39,7 @@ module Oboe
         end
         
         def execute_with_oboe(sql, name = nil)
-          if Oboe::Config.tracing? and !ignore_payload?(name)
+          if Oboe.tracing? and !ignore_payload?(name)
 
             opts = extract_trace_details(sql, name)
             Oboe::API.trace('activerecord', opts || {}) do
@@ -49,7 +51,7 @@ module Oboe
         end
         
         def exec_query_with_oboe(sql, name = nil, binds = [])
-          if Oboe::Config.tracing? and !ignore_payload?(name)
+          if Oboe.tracing? and !ignore_payload?(name)
 
             opts = extract_trace_details(sql, name)
             Oboe::API.trace('activerecord', opts || {}) do
@@ -61,7 +63,7 @@ module Oboe
         end
         
         def exec_delete_with_oboe(sql, name = nil, binds = [])
-          if Oboe::Config.tracing? and !ignore_payload?(name)
+          if Oboe.tracing? and !ignore_payload?(name)
 
             opts = extract_trace_details(sql, name)
             Oboe::API.trace('activerecord', opts || {}) do
@@ -73,7 +75,7 @@ module Oboe
         end
         
         def exec_insert_with_oboe(sql, name = nil, binds = [])
-          if Oboe::Config.tracing? and !ignore_payload?(name)
+          if Oboe.tracing? and !ignore_payload?(name)
 
             opts = extract_trace_details(sql, name)
             Oboe::API.trace('activerecord', opts || {}) do
@@ -85,7 +87,7 @@ module Oboe
         end
         
         def begin_db_transaction_with_oboe()
-          if Oboe::Config.tracing?
+          if Oboe.tracing?
             opts = {}
 
             opts[:Query] = "BEGIN"
@@ -234,60 +236,62 @@ module Oboe
 
       module FlavorInitializers
         def self.mysql
-          if ActiveRecord::Base::connection.adapter_name.downcase.to_sym == :mysql
-            puts "[oboe/loading] Instrumenting activerecord mysqladapter" if Oboe::Config[:verbose]
-            if ::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR > 1
-              ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.module_eval do
-                include Oboe::Inst::ConnectionAdapters::AbstractMysqlAdapter
-              end if defined?(::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter) 
+          puts "[oboe/loading] Instrumenting activerecord mysqladapter" if Oboe::Config[:verbose]
+          if ::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR > 1
+            ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.module_eval do
+              include Oboe::Inst::ConnectionAdapters::AbstractMysqlAdapter
+            end if defined?(::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter) 
 
-              ::ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
-                include Oboe::Inst::ConnectionAdapters::MysqlAdapter
-              end if defined?(::ActiveRecord::ConnectionAdapters::MysqlAdapter)
-            else
-              ::ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
-                include Oboe::Inst::ConnectionAdapters::LegacyMysqlAdapter
-              end if defined?(::ActiveRecord::ConnectionAdapters::MysqlAdapter)
-            end
+            ::ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+              include Oboe::Inst::ConnectionAdapters::MysqlAdapter
+            end if defined?(::ActiveRecord::ConnectionAdapters::MysqlAdapter)
+          else
+            ::ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+              include Oboe::Inst::ConnectionAdapters::LegacyMysqlAdapter
+            end if defined?(::ActiveRecord::ConnectionAdapters::MysqlAdapter)
           end
         end
 
         def self.mysql2
-          if ActiveRecord::Base::connection.adapter_name.downcase.to_sym == :mysql2
-            puts "[oboe/loading] Instrumenting activerecord mysql2adapter" if Oboe::Config[:verbose]
-            ::ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
-              include Oboe::Inst::ConnectionAdapters::Mysql2Adapter
-            end if defined?(::ActiveRecord::ConnectionAdapters::Mysql2Adapter)
-          end
+          puts "[oboe/loading] Instrumenting activerecord mysql2adapter" if Oboe::Config[:verbose]
+          ::ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
+            include Oboe::Inst::ConnectionAdapters::Mysql2Adapter
+          end if defined?(::ActiveRecord::ConnectionAdapters::Mysql2Adapter)
         end
 
         def self.postgresql
-          if ActiveRecord::Base::connection.adapter_name.downcase.to_sym == :postgresql
-            puts "[oboe/loading] Instrumenting activerecord postgresqladapter" if Oboe::Config[:verbose]
-            ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
-              if ::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR > 0
-                include Oboe::Inst::ConnectionAdapters::PostgreSQLAdapter
-              else
-                include Oboe::Inst::ConnectionAdapters::LegacyPostgreSQLAdapter
-              end
-            end if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-          end
+          puts "[oboe/loading] Instrumenting activerecord postgresqladapter" if Oboe::Config[:verbose]
+          ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
+            if ::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR > 0
+              include Oboe::Inst::ConnectionAdapters::PostgreSQLAdapter
+            else
+              include Oboe::Inst::ConnectionAdapters::LegacyPostgreSQLAdapter
+            end
+          end if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
         end
 
         def self.oracle
-          if ActiveRecord::Base::connection.adapter_name.downcase.to_sym == :oracleenhanced
-            puts "[oboe/loading] Instrumenting activerecord oracleenhancedadapter" if Oboe::Config[:verbose]
-            ::ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.module_eval do
-              include Oboe::Inst::ConnectionAdapters
-            end if defined?(::ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter)
-          end
+          puts "[oboe/loading] Instrumenting activerecord oracleenhancedadapter" if Oboe::Config[:verbose]
+          ::ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.module_eval do
+            include Oboe::Inst::ConnectionAdapters
+          end if defined?(::ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter)
         end
       end
     end
   end
 end
 
-Oboe::Inst::ConnectionAdapters::FlavorInitializers.mysql
-Oboe::Inst::ConnectionAdapters::FlavorInitializers.mysql2
-Oboe::Inst::ConnectionAdapters::FlavorInitializers.postgresql
-Oboe::Inst::ConnectionAdapters::FlavorInitializers.oracle
+if Oboe::Config[:active_record][:enabled]
+  begin
+    adapter = ActiveRecord::Base::connection.adapter_name.downcase
+
+    Oboe::Inst::ConnectionAdapters::FlavorInitializers.mysql      if adapter == "mysql"
+    Oboe::Inst::ConnectionAdapters::FlavorInitializers.mysql2     if adapter == "mysql2"
+    Oboe::Inst::ConnectionAdapters::FlavorInitializers.postgresql if adapter == "postgresql"
+    Oboe::Inst::ConnectionAdapters::FlavorInitializers.oracle     if adapter == "oracleenhanced"
+
+  rescue Exception => e
+    puts "[oboe/error] Oboe/ActiveRecord error: #{e.message}" if Oboe::Config[:verbose]
+  end
+end
+# vim:set expandtab:tabstop=2