oboe 1.3.0

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

@@ -0,0 +1,86 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module Rails3ActionController
+      def process(*args)
+
+        header = request.headers['X-Trace']
+        Oboe::API.start_trace_with_target('rails', header, response.headers) do
+          super
+        end
+      end
+
+      def process_action(*args)
+        opts = {
+          'HTTP-Host'   => @_request.headers['HTTP_HOST'],
+          :URL          => @_request.headers['REQUEST_URI'],
+          :Method       => @_request.headers['REQUEST_METHOD'],
+          :Controller   => self.class.name,
+          :Action       => self.action_name,
+        }
+        super
+
+        opts[:Status] = @_response.status
+        Oboe::API.log('rails', 'info', opts)
+      
+      rescue Exception => exception
+        opts[:Status] = 500
+        Oboe::API.log('rails', 'info', opts)
+      end
+
+      def render(*args)
+        Oboe::API.trace('render', {}) do
+          super
+        end
+      end
+    end
+  end
+end
+
+if defined?(ActionController::Base)
+  if ::Rails::VERSION::MAJOR == 3
+    Oboe::API.report_init('rails')
+
+    class ActionController::Base
+      include Oboe::Inst::Rails3ActionController
+    end
+  elsif ::Rails::VERSION::MAJOR == 2
+    Oboe::API.report_init('rails')
+
+    ActionController::Base.class_eval do
+      alias :perform_action_without_oboe :perform_action
+      alias :rescue_action_without_oboe :rescue_action
+      alias :process_without_oboe :process
+
+      def process(*args)
+        header = args[0].headers['X-Trace']
+        Oboe::API.start_trace_with_target('rails', header, args[1].headers) do
+          process_without_oboe(*args)
+        end
+      end
+
+      def perform_action(*arguments)
+        opts = {
+            'HTTP-Host'   => @_request.headers['HTTP_HOST'],
+            :URL          => @_request.headers['REQUEST_URI'],
+            :Method       => @_request.headers['REQUEST_METHOD'],
+            :Status       => @_response.status,
+            'Controller'  => @_request.path_parameters['controller'],
+            'Action'      => @_request.path_parameters['action']
+        }
+
+        Oboe::API.log('rails', 'info', opts)
+        perform_action_without_oboe(*arguments)
+      end
+
+      def rescue_action(exn)
+        Oboe::API.log_exception('rails', exn)
+        rescue_action_without_oboe(exn)
+      end
+    end
+  end
+  puts "[oboe/loading] Instrumenting ActionControler" if Oboe::Config[:verbose]
+end
+# vim:set expandtab:tabstop=2

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

@@ -0,0 +1,291 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module ConnectionAdapters
+      module Utils
+        def extract_trace_details(sql, name = nil)
+          opts = {}
+
+          opts[:Query] = sql.to_s
+          opts[:Name] = name.to_s if name 
+
+          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 defined?(ActiveRecord::Base.connection.adapter_name)
+            opts[:Flavor] = ActiveRecord::Base.connection.adapter_name
+          end
+
+          return opts || {}
+        end
+
+        # We don't want to trace framework caches.  Only instrument SQL that
+        # directly hits the database.
+        def ignore_payload?(name)
+          %w(SCHEMA EXPLAIN CACHE).include? name.to_s or (name and name.to_sym == :skip_logging)
+        end
+
+        def cfg
+          @config
+        end
+        
+        def execute_with_oboe(sql, name = nil)
+          if Oboe::Config.tracing? and !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            Oboe::API.trace('ActiveRecord', opts || {}) do
+              execute_without_oboe(sql, name)
+            end
+          else
+            execute_without_oboe(sql, name)
+          end
+        end
+        
+        def exec_query_with_oboe(sql, name = nil, binds = [])
+          if Oboe::Config.tracing? and !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            Oboe::API.trace('ActiveRecord', opts || {}) do
+              exec_query_without_oboe(sql, name, binds)
+            end
+          else
+            exec_query_without_oboe(sql, name, binds)
+          end
+        end
+        
+        def exec_delete_with_oboe(sql, name = nil, binds = [])
+          if Oboe::Config.tracing? and !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            Oboe::API.trace('ActiveRecord', opts || {}) do
+              exec_delete_without_oboe(sql, name, binds)
+            end
+          else
+            exec_delete_without_oboe(sql, name, binds)
+          end
+        end
+        
+        def exec_insert_with_oboe(sql, name = nil, binds = [])
+          if Oboe::Config.tracing? and !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            Oboe::API.trace('ActiveRecord', opts || {}) do
+              exec_insert_without_oboe(sql, name, binds)
+            end
+          else
+            exec_insert_without_oboe(sql, name, binds)
+          end
+        end
+        
+        def begin_db_transaction_with_oboe()
+          if Oboe::Config.tracing?
+            opts = {}
+
+            opts[:Query] = "BEGIN"
+            Oboe::API.trace('ActiveRecord', opts || {}) do
+              begin_db_transaction_without_oboe()
+            end
+          else
+            begin_db_transaction_without_oboe()
+          end
+        end
+      end # Utils
+      
+      module PostgreSQLAdapter
+        include Oboe::Inst::ConnectionAdapters::Utils
+      
+        def self.included(cls)
+          cls.class_eval do
+            if ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::method_defined? :exec_query
+              alias exec_query_without_oboe exec_query
+              alias exec_query exec_query_with_oboe
+            else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+            end
+              
+            if ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::method_defined? :exec_delete
+              alias exec_delete_without_oboe exec_delete
+              alias exec_delete exec_delete_with_oboe
+            else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+            end
+          end
+        end
+      end # PostgreSQLAdapter
+
+      module LegacyPostgreSQLAdapter
+        include Oboe::Inst::ConnectionAdapters::Utils
+      
+        def self.included(cls)
+          cls.class_eval do
+            if ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::method_defined? :execute
+              alias execute_without_oboe execute
+              alias execute execute_with_oboe
+            else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+            end
+          end
+        end
+      end # LegacyPostgreSQLAdapter
+
+      module AbstractMysqlAdapter
+        include Oboe::Inst::ConnectionAdapters::Utils
+      
+        def self.included(cls)
+          cls.class_eval do
+            if ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter::method_defined? :execute
+              alias execute_without_oboe execute
+              alias execute execute_with_oboe
+            else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+            end
+          end
+        end
+      end # AbstractMysqlAdapter
+
+      module MysqlAdapter
+        include Oboe::Inst::ConnectionAdapters::Utils
+      
+        def self.included(cls)
+          cls.class_eval do
+            if ActiveRecord::ConnectionAdapters::MysqlAdapter::method_defined? :exec_query
+              alias exec_query_without_oboe exec_query
+              alias exec_query exec_query_with_oboe
+            else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+            end
+          end
+        end
+      end # MysqlAdapter
+
+      module LegacyMysqlAdapter
+        include Oboe::Inst::ConnectionAdapters::Utils
+      
+        def self.included(cls)
+          cls.class_eval do
+            if ActiveRecord::ConnectionAdapters::MysqlAdapter::method_defined? :execute
+              alias execute_without_oboe execute
+              alias execute execute_with_oboe
+            else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+            end
+            
+            if ::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR == 1
+              if ActiveRecord::ConnectionAdapters::MysqlAdapter::method_defined? :begin_db_transaction
+                alias begin_db_transaction_without_oboe begin_db_transaction
+                alias begin_db_transaction begin_db_transaction_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+            end
+            
+            if ::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR > 0
+              if ActiveRecord::ConnectionAdapters::MysqlAdapter::method_defined? :exec_query
+                alias exec_query_without_oboe exec_query
+                alias exec_query exec_query_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+              
+              if ActiveRecord::ConnectionAdapters::MysqlAdapter::method_defined? :exec_delete
+                alias exec_delete_without_oboe exec_delete
+                alias exec_delete exec_delete_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+            end
+          end
+        end
+      end # LegacyMysqlAdapter
+      
+      module Mysql2Adapter
+        include Oboe::Inst::ConnectionAdapters::Utils
+      
+        def self.included(cls)
+          cls.class_eval do
+            if ::Rails::VERSION::MAJOR == 2 or (::Rails::VERSION::MAJOR == 3 and ::Rails::VERSION::MINOR == 0)
+              if ActiveRecord::ConnectionAdapters::Mysql2Adapter::method_defined? :execute
+                alias execute_without_oboe execute
+                alias execute execute_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+            else
+              if ActiveRecord::ConnectionAdapters::Mysql2Adapter::method_defined? :exec_insert
+                alias exec_insert_without_oboe exec_insert
+                alias exec_insert exec_insert_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+             
+              # In Rails 3.1, exec_query was defined as a private method
+              if ActiveRecord::ConnectionAdapters::Mysql2Adapter::method_defined? :exec_query or
+                ActiveRecord::ConnectionAdapters::Mysql2Adapter::private_method_defined? :exec_query
+                alias exec_query_without_oboe exec_query
+                alias exec_query exec_query_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+              
+              if ActiveRecord::ConnectionAdapters::Mysql2Adapter::method_defined? :exec_delete
+                alias exec_delete_without_oboe exec_delete
+                alias exec_delete exec_delete_with_oboe
+              else puts "[oboe/loading] Couldn't properly instrument ActiveRecord layer.  Partial traces may occur."
+              end
+            end
+          end
+        end
+      end # Mysql2Adapter
+
+      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
+              ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+                include Oboe::Inst::ConnectionAdapters::MysqlAdapter
+              end
+            else
+              ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+                include Oboe::Inst::ConnectionAdapters::LegacyMysqlAdapter
+              end
+            end
+          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
+          end
+        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
+          end
+        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
+          end
+        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

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

@@ -0,0 +1,45 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module Dalli
+      include Oboe::API::Memcache
+
+      def self.included(cls)
+        cls.class_eval do
+          puts "[oboe/loading] Instrumenting Memcache (Dalli)" if Oboe::Config[:verbose]
+          if ::Dalli::Client.private_method_defined? :perform
+            alias perform_without_oboe perform
+            alias perform perform_with_oboe
+          else puts "[oboe/loading] Couldn't properly instrument Memcache (Dalli).  Partial traces may occur."
+          end
+        end
+      end
+
+      def perform_with_oboe(op, key, *args)
+        if Oboe::Config.tracing?
+          opts = {}
+          opts[:KVOp] = op
+          opts[:KVKey] = key 
+
+          Oboe::API.trace('memcache', opts || {}) do
+            result = perform_without_oboe(op, key, *args)
+            if op == :get and key.class == String
+                Oboe::API.log('memcache', 'info', { :KVHit => memcache_hit?(result) })
+            end
+            result
+          end
+        else
+          perform_without_oboe(op, key, *args)
+        end
+      end
+    end
+  end
+end
+
+if defined?(Dalli)
+  Dalli::Client.module_eval do
+    include Oboe::Inst::Dalli
+  end
+end

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

@@ -0,0 +1,40 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+require 'net/http'
+
+Net::HTTP.class_eval do
+  def request_with_oboe(*args, &block)
+    unless started?
+      return request_without_oboe(*args, &block)
+    end
+
+    Oboe::API.trace('net-http') do
+        opts = {}
+        if args.length and args[0]
+          req = args[0]
+          req['X-Trace'] = Oboe::Context.toString()
+
+          opts['IsService'] = 1
+          opts['RemoteProtocol'] = use_ssl? ? 'HTTPS' : 'HTTP'
+          opts['RemoteHost'] = addr_port
+          opts['ServiceArg'] = req.path
+          opts['Method'] = req.method
+        end
+
+        Oboe::API.log('net-http', 'info', opts)
+        resp = request_without_oboe(*args, &block)
+
+        xtrace = resp.get_fields('X-Trace')
+        if xtrace and xtrace.size and Oboe::Config.tracing?
+          Oboe::Context.fromString(xtrace[0])
+        end
+        next resp
+    end
+  end
+
+  alias request_without_oboe request
+  alias request request_with_oboe
+
+  puts "[oboe/loading] Instrumenting net/http" if Oboe::Config[:verbose]
+end