traceview 3.0.0

data/lib/traceview/frameworks/rails/inst/action_view_30.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
+
+  if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 0
+
+    ActionView::Partials::PartialRenderer.class_eval do
+      alias :render_partial_without_traceview :render_partial
+      def render_partial(object = @object)
+        entry_kvs = {}
+        begin
+          name  = TraceView::Util.prettify(@options[:partial]) if @options.is_a?(Hash)
+          entry_kvs[:FunctionName] = :render_partial
+          entry_kvs[:Class]        = :PartialRenderer
+          entry_kvs[:Module]       = 'ActionView::Partials'
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
+        rescue
+        end
+
+        TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do
+          render_partial_without_traceview(object)
+        end
+      end
+
+      alias :render_collection_without_traceview :render_collection
+      def render_collection
+        entry_kvs = {}
+        begin
+          name  = TraceView::Util.prettify(@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
+
+        TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do
+          render_collection_without_traceview
+        end
+      end
+    end
+  end
+end
+
+# vim:set expandtab:tabstop=2

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

@@ -0,0 +1,24 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+require 'traceview/frameworks/rails/inst/connection_adapters/utils'
+require 'traceview/frameworks/rails/inst/connection_adapters/mysql'
+require 'traceview/frameworks/rails/inst/connection_adapters/mysql2'
+require 'traceview/frameworks/rails/inst/connection_adapters/postgresql'
+require 'traceview/frameworks/rails/inst/connection_adapters/oracle'
+
+if TraceView::Config[:active_record][:enabled] && !defined?(JRUBY_VERSION)
+  begin
+    adapter = ActiveRecord::Base.connection.adapter_name.downcase
+
+    TraceView::Inst::ConnectionAdapters::FlavorInitializers.mysql      if adapter == 'mysql'
+    TraceView::Inst::ConnectionAdapters::FlavorInitializers.mysql2     if adapter == 'mysql2'
+    TraceView::Inst::ConnectionAdapters::FlavorInitializers.postgresql if adapter == 'postgresql'
+    TraceView::Inst::ConnectionAdapters::FlavorInitializers.oracle     if adapter == 'oracleenhanced'
+
+  rescue StandardError => e
+    TraceView.logger.error "[traceview/error] TraceView/ActiveRecord error: #{e.inspect}"
+    TraceView.logger.debug e.backtrace.join("\n")
+  end
+end
+# vim:set expandtab:tabstop=2

data/lib/traceview/frameworks/rails/inst/connection_adapters/mysql.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.mysql
+          TraceView.logger.info '[traceview/loading] Instrumenting activerecord mysqladapter' if TraceView::Config[:verbose]
+
+          # ActiveRecord 3.2 and higher
+          if (::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR >= 2) ||
+              ::ActiveRecord::VERSION::MAJOR == 4
+
+            # AbstractMysqlAdapter
+            TraceView::Util.send_include(::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter,
+                                    ::TraceView::Inst::ConnectionAdapters::Utils)
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter, :execute)
+
+            # MysqlAdapter
+            TraceView::Util.send_include(::ActiveRecord::ConnectionAdapters::MysqlAdapter,
+                                    ::TraceView::Inst::ConnectionAdapters::Utils)
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::MysqlAdapter, :exec_query)
+
+          else
+            # ActiveRecord 3.1 and below
+
+            # MysqlAdapter
+            TraceView::Util.send_include(::ActiveRecord::ConnectionAdapters::MysqlAdapter,
+                                    ::TraceView::Inst::ConnectionAdapters::Utils)
+
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::MysqlAdapter, :execute)
+
+            if ::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR == 1
+              TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::MysqlAdapter, :begin_db_transaction)
+              TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::MysqlAdapter, :exec_delete)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.mysql2
+          TraceView.logger.info '[traceview/loading] Instrumenting activerecord mysql2adapter' if TraceView::Config[:verbose]
+
+          TraceView::Util.send_include(::ActiveRecord::ConnectionAdapters::Mysql2Adapter,
+                                  ::TraceView::Inst::ConnectionAdapters::Utils)
+
+          if (::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR == 0) ||
+              ::ActiveRecord::VERSION::MAJOR == 2
+            # ActiveRecord 3.0 and prior
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::Mysql2Adapter, :execute)
+          else
+            # ActiveRecord 3.1 and above
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_insert)
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_query)
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_delete)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.oracle
+          TraceView.logger.info '[traceview/loading] Instrumenting activerecord oracleenhancedadapter' if TraceView::Config[:verbose]
+          ::ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.module_eval do
+            include TraceView::Inst::ConnectionAdapters
+          end if defined?(::ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter)
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,30 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.postgresql
+
+          TraceView.logger.info '[traceview/loading] Instrumenting activerecord postgresqladapter' if TraceView::Config[:verbose]
+
+          TraceView::Util.send_include(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter,
+                                  ::TraceView::Inst::ConnectionAdapters::Utils)
+
+          if (::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR > 0) ||
+                ::ActiveRecord::VERSION::MAJOR == 4
+
+            # ActiveRecord 3.1 and up
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_query)
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_delete)
+
+          else
+            # ActiveRecord 3.0 and prior
+            TraceView::Util.method_alias(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :execute)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    module ConnectionAdapters
+      module Utils
+
+        def extract_trace_details(sql, name = nil, binds = [])
+          opts = {}
+
+          begin
+            if TraceView::Config[:sanitize_sql]
+              # Sanitize SQL and don't report binds
+              opts[:Query] = sql.gsub(/\'[\s\S][^\']*\'/, '?')
+            else
+              # Report raw SQL and any binds if they exist
+              opts[:Query] = sql.to_s
+              opts[:QueryArgs] = binds.map { |col, val| type_cast(val, col) } unless binds.empty?
+            end
+
+            opts[:Name] = name.to_s if name
+            opts[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:active_record][:collect_backtraces]
+
+            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.key?('database')
+            opts[:RemoteHost] = config['host']     if config.key?('host')
+            opts[:Flavor]     = config['adapter']  if config.key?('adapter')
+          rescue StandardError => e
+            TraceView.logger.debug "Exception raised capturing ActiveRecord KVs: #{e.inspect}"
+            TraceView.logger.debug e.backtrace.join('\n')
+          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) ||
+            (name && name.to_sym == :skip_logging) ||
+              name == 'ActiveRecord::SchemaMigration Load'
+        end
+
+        # def cfg
+        #   @config
+        # end
+
+        def execute_with_traceview(sql, name = nil)
+          if TraceView.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            TraceView::API.trace('activerecord', opts || {}) do
+              execute_without_traceview(sql, name)
+            end
+          else
+            execute_without_traceview(sql, name)
+          end
+        end
+
+        def exec_query_with_traceview(sql, name = nil, binds = [])
+          if TraceView.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            TraceView::API.trace('activerecord', opts || {}) do
+              exec_query_without_traceview(sql, name, binds)
+            end
+          else
+            exec_query_without_traceview(sql, name, binds)
+          end
+        end
+
+        def exec_delete_with_traceview(sql, name = nil, binds = [])
+          if TraceView.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            TraceView::API.trace('activerecord', opts || {}) do
+              exec_delete_without_traceview(sql, name, binds)
+            end
+          else
+            exec_delete_without_traceview(sql, name, binds)
+          end
+        end
+
+        def exec_insert_with_traceview(sql, name = nil, binds = [], *args)
+          if TraceView.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            TraceView::API.trace('activerecord', opts || {}) do
+              exec_insert_without_traceview(sql, name, binds, *args)
+            end
+          else
+            exec_insert_without_traceview(sql, name, binds, *args)
+          end
+        end
+
+        def begin_db_transaction_with_traceview
+          if TraceView.tracing?
+            opts = {}
+
+            opts[:Query] = 'BEGIN'
+            TraceView::API.trace('activerecord', opts || {}) do
+              begin_db_transaction_without_traceview
+            end
+          else
+            begin_db_transaction_without_traceview
+          end
+        end
+      end # Utils
+    end
+  end
+end

data/lib/traceview/frameworks/sinatra.rb

@@ -0,0 +1,95 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Sinatra
+    module Base
+      def self.included(klass)
+        ::TraceView::Util.method_alias(klass, :dispatch!,         ::Sinatra::Base)
+        ::TraceView::Util.method_alias(klass, :handle_exception!, ::Sinatra::Base)
+      end
+
+      def dispatch_with_traceview
+        if TraceView.tracing?
+          report_kvs = {}
+
+          report_kvs[:Controller] = self.class
+          report_kvs[:Action] = env['PATH_INFO']
+
+          # Fall back to the raw tracing API so we can pass KVs
+          # back on exit (a limitation of the TraceView::API.trace
+          # block method) This removes the need for an info
+          # event to send additonal KVs
+          ::TraceView::API.log_entry('sinatra', {})
+
+          begin
+            dispatch_without_traceview
+          ensure
+            ::TraceView::API.log_exit('sinatra', report_kvs)
+          end
+        else
+          dispatch_without_traceview
+        end
+      end
+
+      def handle_exception_with_traceview(boom)
+        TraceView::API.log_exception(nil, boom) if TraceView.tracing?
+        handle_exception_without_traceview(boom)
+      end
+
+      @@rum_xhr_tmpl = File.read(File.dirname(__FILE__) + '/rails/helpers/rum/rum_ajax_header.js.erb')
+      @@rum_hdr_tmpl = File.read(File.dirname(__FILE__) + '/rails/helpers/rum/rum_header.js.erb')
+      @@rum_ftr_tmpl = File.read(File.dirname(__FILE__) + '/rails/helpers/rum/rum_footer.js.erb')
+
+      def traceview_rum_header
+        return unless TraceView::Config.rum_id
+        if TraceView.tracing?
+          if request.xhr?
+            return ERB.new(@@rum_xhr_tmpl).result
+          else
+            return ERB.new(@@rum_hdr_tmpl).result
+          end
+        end
+      rescue StandardError => e
+        TraceView.logger.warn "traceview_rum_header: #{e.message}."
+        return ''
+      end
+
+      def traceview_rum_footer
+        return unless TraceView::Config.rum_id
+        if TraceView.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
+          return @@rum_ftr_tmpl
+        end
+      rescue StandardError => e
+        TraceView.logger.warn "traceview_rum_footer: #{e.message}."
+        return ''
+      end
+    end
+  end
+end
+
+if defined?(::Sinatra)
+  require 'traceview/inst/rack'
+  require 'traceview/frameworks/sinatra/templates'
+
+  TraceView.logger.info '[traceview/loading] Instrumenting Sinatra' if TraceView::Config[:verbose]
+
+  TraceView::Loading.load_access_key
+  TraceView::Inst.load_instrumentation
+
+  ::Sinatra::Base.use TraceView::Rack
+
+  # When in the gem TEST environment, we load this instrumentation regardless.
+  # Otherwise, only when Padrino isn't around.
+  unless defined?(::Padrino) and not (ENV.key?('TRACEVIEW_GEM_TEST'))
+    # Padrino has 'enhanced' routes and rendering so the Sinatra
+    # instrumentation won't work anyways.  Only load for pure Sinatra apps.
+    ::TraceView::Util.send_include(::Sinatra::Base,      ::TraceView::Sinatra::Base)
+    ::TraceView::Util.send_include(::Sinatra::Templates, ::TraceView::Sinatra::Templates)
+
+    # Report __Init after fork when in Heroku
+    TraceView::API.report_init unless TraceView.heroku?
+  end
+end

data/lib/traceview/frameworks/sinatra/templates.rb

@@ -0,0 +1,56 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Sinatra
+    module Templates
+      def self.included(klass)
+        ::TraceView::Util.method_alias(klass, :render, ::Sinatra::Templates)
+      end
+
+      def render_with_traceview(engine, data, options = {}, locals = {}, &block)
+        if TraceView.tracing?
+          report_kvs = {}
+
+          report_kvs[:engine] = engine
+          report_kvs[:template] = data
+
+          if TraceView.tracing_layer_op?('render')
+            # For recursive calls to :render (for sub-partials and layouts),
+            # use method profiling.
+            begin
+              name = data
+              report_kvs[:FunctionName] = :render
+              report_kvs[:Class]        = :Templates
+              report_kvs[:Module]       = 'Sinatra::Templates'
+              report_kvs[:File]         = __FILE__
+              report_kvs[:LineNumber]   = __LINE__
+            rescue StandardError => e
+              ::TraceView.logger.debug e.message
+              ::TraceView.logger.debug e.backtrace.join(", ")
+            end
+
+            TraceView::API.profile(name, report_kvs, false) do
+              render_without_traceview(engine, data, options, locals, &block)
+            end
+
+          else
+            # Fall back to the raw tracing API so we can pass KVs
+            # back on exit (a limitation of the TraceView::API.trace
+            # block method) This removes the need for an info
+            # event to send additonal KVs
+            ::TraceView::API.log_entry('render', {}, 'render')
+
+            begin
+              render_without_traceview(engine, data, options, locals, &block)
+            ensure
+              ::TraceView::API.log_exit('render', report_kvs)
+            end
+          end
+        else
+          render_without_traceview(engine, data, options, locals, &block)
+        end
+      end
+    end
+  end
+end