oboe 2.1.4 → 2.2.0

data/lib/oboe/frameworks/rails/inst/connection_adapters/mysql2.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2013 by AppNeta
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module ConnectionAdapters
+
+      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 Oboe.logger.warn "[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 Oboe.logger.warn "[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 Oboe.logger.warn "[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 Oboe.logger.warn "[oboe/loading] Couldn't properly instrument activerecord layer.  Partial traces may occur."
+              end
+            end
+          end
+        end
+      end # Mysql2Adapter
+
+      module FlavorInitializers
+        def self.mysql2
+          Oboe.logger.info "[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
+      end
+
+    end
+  end
+end

data/lib/oboe/frameworks/rails/inst/connection_adapters/oracle.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2013 by AppNeta
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.oracle
+          Oboe.logger.info "[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
+

data/lib/oboe/frameworks/rails/inst/connection_adapters/postgresql.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2013 by AppNeta
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module ConnectionAdapters
+
+      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 Oboe.logger.warn "[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 Oboe.logger.warn "[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 Oboe.logger.warn "[oboe/loading] Couldn't properly instrument activerecord layer.  Partial traces may occur."
+            end
+          end
+        end
+      end # LegacyPostgreSQLAdapter
+
+      module FlavorInitializers
+        def self.postgresql
+          Oboe.logger.info "[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) or ::Rails::VERSION::MAJOR == 4
+              include Oboe::Inst::ConnectionAdapters::PostgreSQLAdapter
+            else
+              include Oboe::Inst::ConnectionAdapters::LegacyPostgreSQLAdapter
+            end
+          end if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+        end
+      end
+
+    end
+  end
+end

data/lib/oboe/frameworks/rails/inst/connection_adapters/utils.rb

@@ -0,0 +1,105 @@
+# Copyright (c) 2013 by AppNeta
+# All rights reserved.
+
+module Oboe
+  module Inst
+    module ConnectionAdapters
+      module Utils
+        def extract_trace_details(sql, name = nil)
+          opts = {}
+
+          begin
+            opts[:Query] = sql.to_s
+            opts[:Name] = name.to_s if name
+            opts[:Backtrace] = Oboe::API.backtrace
+
+            if ::Rails::VERSION::MAJOR == 2
+              config = ::Rails.configuration.database_configuration[::Rails.env]
+            else
+              config = ::Rails.application.config.database_configuration[::Rails.env]
+            end  
+
+            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 || {}
+        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.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.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.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 = [], *args)
+          if Oboe.tracing? and !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            Oboe::API.trace('activerecord', opts || {}) do
+              exec_insert_without_oboe(sql, name, binds, *args)
+            end
+          else
+            exec_insert_without_oboe(sql, name, binds, *args)
+          end
+        end
+        
+        def begin_db_transaction_with_oboe()
+          if Oboe.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
+    end
+  end
+end
+

data/lib/oboe/inst/dalli.rb

@@ -22,21 +22,23 @@ module Oboe
         end
       end
 
-      def perform_with_oboe(op, key, *args)
+      def perform_with_oboe(*all_args, &blk)
+        op, key, *args = *all_args
+
         if Oboe.tracing? and not Oboe::Context.tracing_layer_op?(:get_multi)
           opts = {}
           opts[:KVOp] = op
           opts[:KVKey] = key 
 
           Oboe::API.trace('memcache', opts || {}) do
-            result = perform_without_oboe(op, key, *args)
+            result = perform_without_oboe(*all_args, &blk)
             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)
+          perform_without_oboe(*all_args, &blk)
         end
       end
 

data/lib/oboe/inst/rack.rb

@@ -15,16 +15,24 @@ module Oboe
 
       begin
         xtrace = env['HTTP_X_TRACE'] if env.is_a?(Hash)
-
+        
         req = ::Rack::Request.new(env)
-        report_kvs[:SampleRate]      = Oboe::Config[:sample_rate]
-        report_kvs['HTTP-Host']      = req.host
-        report_kvs['HTTP-Port']      = req.port
-        report_kvs['Query-String']   = req.query_string unless req.query_string.blank?
-        report_kvs[:URL]             = req.path
-        report_kvs[:Method]          = req.request_method
-        report_kvs['AJAX']           = true if req.xhr?
-        report_kvs['X-TV-Meta']      = req.headers['X-TV-Meta'] if req.headers.has_key?('X-TV-Meta')
+        report_kvs[:SampleRate]        = Oboe::Config[:sample_rate]
+        report_kvs[:SampleSource]      = Oboe::Config[:sample_source]
+        report_kvs['HTTP-Host']        = req.host
+        report_kvs['Port']             = req.port
+        report_kvs['Proto']            = req.scheme
+        report_kvs['Query-String']     = req.query_string unless req.query_string.blank?
+        report_kvs[:URL]               = req.path
+        report_kvs[:Method]            = req.request_method
+        report_kvs['AJAX']             = true if req.xhr?
+        report_kvs['ClientIP']         = req.ip
+         
+        report_kvs['TV-Meta']          = env['HTTP_X-TV-META']          if env.has_key?('HTTP_X-TV-META')
+        report_kvs['Forwarded-For']    = env['HTTP_X-FORWARDED-FOR']    if env.has_key?('HTTP_X-FORWARDED-FOR')
+        report_kvs['Forwarded-Host']   = env['HTTP_X-FORWARDED-HOST']   if env.has_key?('HTTP_X-FORWARDED-HOST')
+        report_kvs['Forwarded-Proto']  = env['HTTP_X-FORWARDED-PROTO']  if env.has_key?('HTTP_X-FORWARDED-PROTO')
+        report_kvs['Forwarded-Port']   = env['HTTP_X-FORWARDED-PORT']   if env.has_key?('HTTP_X-FORWARDED-PORT')
       rescue
         # Discard any potential exceptions. Report whatever we can.
       end

data/lib/oboe/loading.rb

@@ -109,42 +109,6 @@ module Oboe
         end
       end
     end
-
-    ##
-    # Update liboboe with the configured tracing mode
-    #
-    def self.set_tracing_mode
-      # If we are in Heroku, let the oboe-heroku gem configure tracing mode 
-      # itself as the requirements are slightly different.
-      return if defined?(OboeHeroku)
-      
-      # OBOE_TRACE_NEVER   0
-      # OBOE_TRACE_ALWAYS  1
-      # OBOE_TRACE_THROUGH 2
-      
-      if defined?(Oboe::Config)
-        
-        case Oboe::Config[:tracing_mode].to_s.downcase.to_sym
-        when :never
-          # OBOE_TRACE_NEVER
-          Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_NEVER"
-          Oboe::Context.setTracingMode(0)
-        when :always
-          # OBOE_TRACE_ALWAYS
-          Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_ALWAYS"
-          Oboe::Context.setTracingMode(1)
-        else
-          # OBOE_TRACE_THROUGH
-          Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_THROUGH"
-          Oboe::Context.setTracingMode(2)
-        end
-      else
-        # OBOE_TRACE_THROUGH
-        Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_THROUGH (no Oboe::Config?)"
-        Oboe::Context.setTracingMode(2)
-      end
-    end
-
   end
 end
 

data/lib/oboe/ruby.rb

@@ -2,7 +2,6 @@ module Oboe
   module Ruby
     def self.initialize
       Oboe::Loading.load_access_key
-      Oboe::Loading.set_tracing_mode
       Oboe::Inst.load_instrumentation
     end
   end

data/lib/oboe/version.rb

@@ -1,8 +1,8 @@
 module Oboe
   module Version
     MAJOR = 2
-    MINOR = 1
-    PATCH = 4
+    MINOR = 2
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/rails/generators/oboe/install_generator.rb

@@ -11,19 +11,27 @@ module Oboe
       @verbose = 'false'
 
       say ""
-      say set_color "Welcome to the Tracelytics Ruby instrumentation setup.", :green, :bold
+      say set_color "Welcome to the TraceView Ruby instrumentation setup.", :green, :bold
       say ""
       say "To instrument your Rails application, you have the option to setup sampling strategies here."
       say ""
+      say set_color "Documentation Links", :magenta
+      say "-------------------"
+      say ""
+      say "Details on configuring your sampling rate:"
+      say "http://support.tv.appneta.com/support/solutions/articles/86336-configuring-sampling"
+      say ""
       say "More information on instrumenting Ruby applications can be found here:"
-      say "http://support.tracelytics.com/kb/ruby/instrumenting-ruby-apps"
+      say "http://support.tv.appneta.com/support/solutions/articles/86393-instrumenting-ruby-apps"
       while true do
         say ""
-        say set_color "Tracing Mode", :green
+        say set_color "Tracing Mode", :magenta
         say "------------"
-        say "When traces should be initiated for incoming requests. Valid options are 'always',"
-        say "'through' (when the request is initiated with a tracing header from upstream) and 'never'."
-        say "You must set this directive to 'always' in order to initiate tracing."
+        say "Tracing Mode determines when traces should be initiated for incoming requests.  Valid"
+        say "options are #{set_color "always", :yellow}, #{set_color "through", :yellow} (when using an instrumented Apache or Nginx) and #{set_color "never", :yellow}."
+        say ""
+        say "If you're not using an instrumented Apache or Nginx, set this directive to #{set_color "always", :yellow} in"
+        say "order to initiate tracing from Ruby."
         say ""
         user_tracing_mode = ask set_color "* Tracing Mode? [through]:", :yellow
         user_tracing_mode.downcase!
@@ -59,7 +67,7 @@ module Oboe
       say ""
       say "You can change these values in the future by modifying config/initializers/oboe.rb"
       say ""
-      say "Thanks! Creating initialization file..."
+      say "Thanks! Creating the TraceView initializer..."
       say ""
 
       template "oboe_initializer.rb", "config/initializers/oboe.rb"

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -1,8 +1,18 @@
-if defined?(::Oboe::Config) 
-  # When traces should be initiated for incoming requests. Valid options are 'always', 
-  # 'through' (when the request is initiated with a tracing header from upstream) and 'never'. 
-  # You must set this directive to 'always' in order to initiate tracing when there
-  # is no front-end webserver initiating traces.
+# AppNeta TraceView Initializer (the oboe gem)
+# http://www.appneta.com/products/traceview/
+#
+# Details on configuring your sampling rate:
+# http://support.tv.appneta.com/support/solutions/articles/86336-configuring-sampling
+#
+# More information on instrumenting Ruby applications can be found here:
+# http://support.tv.appneta.com/support/solutions/articles/86393-instrumenting-ruby-apps
+
+if defined?(Oboe::Config) 
+  # Tracing Mode determines when traces should be initiated for incoming requests.  Valid
+  # options are always, through (when using an instrumented Apache or Nginx) and never.
+  #
+  # If you're not using an instrumented Apache or Nginx, set this directive to always in
+  # order to initiate tracing from Ruby.
   Oboe::Config[:tracing_mode] = '<%= @tracing_mode %>'
 <% if ['through', 'never'].include?(@tracing_mode) %>
   # sample_rate is a value from 0 - 1m indicating the fraction of requests per million to trace

data/oboe.gemspec

@@ -16,14 +16,4 @@ Gem::Specification.new do |s|
     s.test_files  = Dir.glob("{spec}/**/*.rb")
     s.add_development_dependency 'rake'
     s.add_development_dependency 'rspec'
-
-    s.post_install_message = "
-
-This oboe gem requires updated AppNeta liboboe (>= 1.1.1) and 
-tracelytics-java-agent packages (if using JRuby).  Make sure to update all 
-of your hosts or this gem will just sit in the corner and weep quietly.
-
-- Your Friendly AppNeta TraceView Team
-
-"
 end