traceview 3.0.0

data/lib/traceview/frameworks/rails.rb

@@ -0,0 +1,145 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Rails
+    module Helpers
+      extend ActiveSupport::Concern if defined?(::Rails) and ::Rails::VERSION::MAJOR > 2
+
+      @@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
+        begin
+          return unless TraceView::Config.rum_id
+          if TraceView.tracing?
+            if request.xhr?
+              return raw(ERB.new(@@rum_xhr_tmpl).result)
+            else
+              return raw(ERB.new(@@rum_hdr_tmpl).result)
+            end
+          end
+        rescue StandardError => e
+          TraceView.logger.warn "traceview_rum_header: #{e.message}."
+          return ""
+        end
+      end
+
+      def traceview_rum_footer
+        begin
+          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 raw(@@rum_ftr_tmpl)
+          end
+        rescue StandardError => e
+          TraceView.logger.warn "traceview_rum_footer: #{e.message}."
+          return ""
+        end
+      end
+    end # Helpers
+
+    def self.load_initializer
+      # Force load the TraceView Rails initializer if there is one
+      # Prefer traceview.rb but give priority to the legacy tracelytics.rb if it exists
+      if ::Rails::VERSION::MAJOR > 2
+        rails_root = "#{::Rails.root.to_s}"
+      else
+        rails_root = "#{RAILS_ROOT}"
+      end
+
+      #
+      # We've been through 3 initializer names.  Try each one.
+      #
+      if File.exists?("#{rails_root}/config/initializers/tracelytics.rb")
+        tr_initializer = "#{rails_root}/config/initializers/tracelytics.rb"
+
+      elsif File.exists?("#{rails_root}/config/initializers/oboe.rb")
+        tr_initializer = "#{rails_root}/config/initializers/oboe.rb"
+
+      else
+        tr_initializer = "#{rails_root}/config/initializers/traceview.rb"
+      end
+      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')
+      Dir.glob(pattern) do |f|
+        begin
+          require f
+        rescue => e
+          TraceView.logger.error "[traceview/loading] Error loading rails insrumentation file '#{f}' : #{e}"
+        end
+      end
+
+      TraceView.logger.info "TraceView gem #{TraceView::Version::STRING} successfully loaded."
+    end
+
+    def self.include_helpers
+      # TBD: This would make the helpers available to controllers which is occasionally desired.
+      # ActiveSupport.on_load(:action_controller) do
+      #   include TraceView::Rails::Helpers
+      # end
+      if ::Rails::VERSION::MAJOR > 2
+        ActiveSupport.on_load(:action_view) do
+          include TraceView::Rails::Helpers
+        end
+      else
+        ActionView::Base.send :include, TraceView::Rails::Helpers
+      end
+    end
+
+  end # Rails
+end # TraceView
+
+if defined?(::Rails)
+  require 'traceview/inst/rack'
+
+  if ::Rails::VERSION::MAJOR > 2
+    module TraceView
+      class Railtie < ::Rails::Railtie
+
+        initializer 'traceview.helpers' do
+          TraceView::Rails.include_helpers
+        end
+
+        initializer 'traceview.rack' do |app|
+          TraceView.logger.info "[traceview/loading] Instrumenting rack" if TraceView::Config[:verbose]
+          app.config.middleware.insert 0, "TraceView::Rack"
+        end
+
+        config.after_initialize do
+          TraceView.logger = ::Rails.logger if ::Rails.logger
+
+          TraceView::Loading.load_access_key
+          TraceView::Inst.load_instrumentation
+          TraceView::Rails.load_instrumentation
+
+          # Report __Init after fork when in Heroku
+          TraceView::API.report_init unless TraceView.heroku?
+        end
+      end
+    end
+  else
+    TraceView.logger = ::Rails.logger if ::Rails.logger
+
+    TraceView::Rails.load_initializer
+    TraceView::Loading.load_access_key
+
+    Rails.configuration.after_initialize do
+      TraceView.logger.info "[traceview/loading] Instrumenting rack" if TraceView::Config[:verbose]
+      Rails.configuration.middleware.insert 0, "TraceView::Rack"
+
+      TraceView::Inst.load_instrumentation
+      TraceView::Rails.load_instrumentation
+      TraceView::Rails.include_helpers
+
+      # Report __Init after fork when in Heroku
+      TraceView::API.report_init unless TraceView.heroku?
+    end
+  end
+end

data/lib/traceview/frameworks/rails/helpers/rum/rum_ajax_header.js.erb

@@ -0,0 +1,5 @@
+<script type="text/javascript">(function(){var d=this._tly={q:[],mark:function(a,b){d.q.push(["mark",a,b||(new Date).getTime()])},measure:function(a,b,c){d.q.push(["measure",a,b,c||(new Date).getTime()])},done:function(a){d.q.push(["done",a])},cid:"<%= TraceView::Config[:rum_id] %>",xt:"<%= TraceView::Context.toString %>"};d.mark("firstbyte");var f;f=function(){};var g=0;function h(a){return function(b){b[a]||(b[a]=!0,d.measure(["_ajax",b.a,a]))}}var i=h("recv"),j=h("send");
+function l(){var a=this&&this._tl,b=a.b;4===this.readyState&&i(a);f();for(a=0;a<b.length;a++)b[a].apply(this,arguments)}var m=this.XMLHttpRequest,n=m&&m.prototype;
+if(n){var o=n.open;n.open=function(a,b,c,e,u){f();this._tl||(this._tl={a:g++,async:c,b:[]},d.measure(["_ajax",this._tl.a,"init",a,b]));return e?o.call(this,a,b,c,e,u):o.call(this,a,b,c)};var p=n.send;n.send=function(a){function b(){try{var a;a:{var b=l;try{if(c.addEventListener){c.addEventListener("readystatechange",b);a=!0;break a}}catch(w){}a=!1}if(!a){var k=c.onreadystatechange;if(k){if(!k.apply)return;f();e.b.push(k)}f();c.onreadystatechange=l}}catch(x){}}var c=this,e=c&&c._tl;f();b();j(e);a=
+p.call(c,a);!e.async||4===c.readyState?i(e):setTimeout(function(){try{4===c.readyState?i(e):c.onreadystatechange!==l&&b()}catch(a){}},0);return a}}this.onerror=function(a,b,c){d.measure(["_jserror ",a,"|",b,"|",c].join(""))};var q=this.attachEvent,r=this.addEventListener;var s=function(){d.measure("winload");d.done()};q?q("onload",s):r&&r("load",s,!1);var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.src=("http:"===document.location.protocol?"http:":"https:")+"//d2gfdmu30u15x7.cloudfront.net/1/tly.js";
+var v=document.getElementsByTagName("script")[0];v.parentNode.insertBefore(t,v);}());</script>

data/lib/traceview/frameworks/rails/helpers/rum/rum_footer.js.erb

@@ -0,0 +1 @@
+<script type="text/javascript">this._tly&&this._tly.measure("domload");</script>

data/lib/traceview/frameworks/rails/helpers/rum/rum_header.js.erb

@@ -0,0 +1,3 @@
+<script type="text/javascript">(function(){var b=this._tly={q:[],mark:function(a,c){b.q.push(["mark",a,c||(new Date).getTime()])},measure:function(a,c,e){b.q.push(["measure",a,c,e||(new Date).getTime()])},done:function(a){b.q.push(["done",a])},cid:"<%= TraceView::Config[:rum_id] %>",xt:"<%= TraceView::Context.toString %>"};b.mark("firstbyte");this.onerror=function(a,c,e){b.measure(["_jserror ",a,"|",c,"|",e].join(""))};var d=this.attachEvent,f=this.addEventListener;var g=function(){b.measure("winload");b.done()};d?d("onload",g):f&&f("load",g,!1);var h=document.createElement("script");
+h.type="text/javascript";h.async=!0;h.src=("http:"===document.location.protocol?"http:":"https:")+"//d2gfdmu30u15x7.cloudfront.net/1/tly.js";var i=document.getElementsByTagName("script")[0];i.parentNode.insertBefore(h,i);}());</script>
+

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

@@ -0,0 +1,216 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    #
+    # RailsBase
+    #
+    # This module contains the instrumentation code common to
+    # many Rails versions.
+    #
+    module RailsBase
+      #
+      # has_handler?
+      #
+      # Determins if <tt>exception</tt> has a registered
+      # handler via <tt>rescue_from</tt>
+      #
+      def has_handler?(exception)
+        # Don't log exceptions if they have a rescue handler set
+        has_handler = false
+        rescue_handlers.detect { | klass_name, handler |
+          # Rescue handlers can be specified as strings or constant names
+          klass = self.class.const_get(klass_name) rescue nil
+          klass ||= klass_name.constantize rescue nil
+          has_handler = exception.is_a?(klass) if klass
+        }
+        has_handler
+      rescue => e
+        TraceView.logger.debug "[traceview/debug] Error searching Rails handlers: #{e.message}"
+        return false
+      end
+
+      #
+      # log_rails_error?
+      #
+      # Determins whether we should log a raised exception to the
+      # TraceView dashboard.  This is determined by whether the exception
+      # has a rescue handler setup and the value of
+      # TraceView::Config[:report_rescued_errors]
+      #
+      def log_rails_error?(exception)
+        # As it's perculating up through the layers...  make sure that
+        # we only report it once.
+        return false if exception.instance_variable_get(:@traceview_logged)
+
+        has_handler = has_handler?(exception)
+
+        if !has_handler || (has_handler && TraceView::Config[:report_rescued_errors])
+          return true
+        end
+        false
+      end
+
+      #
+      # render_with_traceview
+      #
+      # Our render wrapper that just times and conditionally
+      # reports raised exceptions
+      #
+      def render_with_traceview(*args, &blk)
+        TraceView::API.log_entry('actionview')
+        render_without_traceview(*args, &blk)
+
+      rescue Exception => e
+        TraceView::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        TraceView::API.log_exit('actionview')
+      end
+    end
+
+    #
+    # ActionController3
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v3
+    #
+    module ActionController3
+      include ::TraceView::Inst::RailsBase
+
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :process, :traceview
+          alias_method_chain :process_action, :traceview
+          alias_method_chain :render, :traceview
+        end
+      end
+
+      def process_with_traceview(*args)
+        TraceView::API.log_entry('rails')
+        process_without_traceview *args
+
+      rescue Exception => e
+        TraceView::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        TraceView::API.log_exit('rails')
+      end
+
+      def process_action_with_traceview(*args)
+        report_kvs = {
+          :Controller   => self.class.name,
+          :Action       => self.action_name,
+        }
+        TraceView::API.log(nil, 'info', report_kvs)
+
+        process_action_without_traceview *args
+      rescue Exception
+        report_kvs[:Status] = 500
+        TraceView::API.log(nil, 'info', report_kvs)
+        raise
+      end
+    end
+
+    #
+    # ActionController4
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v4
+    #
+    module ActionController4
+      include ::TraceView::Inst::RailsBase
+
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :process_action, :traceview
+          alias_method_chain :render, :traceview
+        end
+      end
+
+      def process_action_with_traceview(method_name, *args)
+        return process_action_without_traceview(method_name, *args) if TraceView::Config[:action_blacklist].present? &&
+          TraceView::Config[:action_blacklist][[self.controller_name, self.action_name].join('#')]
+
+        report_kvs = {
+          :Controller   => self.class.name,
+          :Action       => self.action_name,
+        }
+
+        TraceView::API.log_entry('rails')
+        process_action_without_traceview(method_name, *args)
+
+      rescue Exception => e
+        TraceView::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        TraceView::API.log_exit('rails')
+      end
+    end
+  end
+end
+
+if defined?(ActionController::Base) && TraceView::Config[:action_controller][:enabled]
+  if ::Rails::VERSION::MAJOR == 4
+
+    class ActionController::Base
+      include TraceView::Inst::ActionController4
+    end
+
+  elsif ::Rails::VERSION::MAJOR == 3
+
+    class ActionController::Base
+      include TraceView::Inst::ActionController3
+    end
+
+  elsif ::Rails::VERSION::MAJOR == 2
+
+    ActionController::Base.class_eval do
+      include ::TraceView::Inst::RailsBase
+
+      alias :perform_action_without_traceview :perform_action
+      alias :rescue_action_without_traceview :rescue_action
+      alias :process_without_traceview :process
+      alias :render_without_traceview :render
+
+      def process(*args)
+        TraceView::API.log_entry('rails')
+        process_without_traceview(*args)
+
+      rescue Exception => e
+        TraceView::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        TraceView::API.log_exit('rails')
+      end
+
+      def perform_action(*arguments)
+        report_kvs = {
+          :Controller  => @_request.path_parameters['controller'],
+          :Action      => @_request.path_parameters['action']
+        }
+        TraceView::API.log(nil, 'info', report_kvs)
+        perform_action_without_traceview(*arguments)
+      end
+
+      def rescue_action(exn)
+        TraceView::API.log_exception(nil, exn) if log_rails_error?(exn)
+        rescue_action_without_traceview(exn)
+      end
+
+      def render(options = nil, extra_options = {}, &block)
+        TraceView::API.log_entry('actionview')
+        render_without_traceview(options, extra_options, &block)
+
+      rescue Exception => e
+        TraceView::API.log_exception(nil, e) if log_rails_error?(e)
+        raise
+      ensure
+        TraceView::API.log_exit('actionview')
+      end
+    end
+  end
+  TraceView.logger.info '[traceview/loading] Instrumenting actioncontroler' if TraceView::Config[:verbose]
+end
+# vim:set expandtab:tabstop=2

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

@@ -0,0 +1,56 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
+
+  ##
+  # 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 && Rails::VERSION::MINOR > 0) || Rails::VERSION::MAJOR == 4
+
+    TraceView.logger.info '[traceview/loading] Instrumenting actionview' if TraceView::Config[:verbose]
+
+    ActionView::PartialRenderer.class_eval do
+      alias :render_partial_without_traceview :render_partial
+      def render_partial
+        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
+          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
+        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
+          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/action_view_2x.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
+
+  if Rails::VERSION::MAJOR == 2
+
+    TraceView.logger.info '[traceview/loading] Instrumenting actionview' if TraceView::Config[:verbose]
+
+    ActionView::Partials.module_eval do
+      alias :render_partial_without_traceview :render_partial
+      def render_partial(options = {})
+        if options.key?(:partial) && options[:partial].is_a?(String)
+          entry_kvs = {}
+          begin
+            name  = TraceView::Util.prettify(options[:partial]) if options.is_a?(Hash)
+            entry_kvs[:FunctionName] = :render_partial
+            entry_kvs[:Class]        = :Partials
+            entry_kvs[:Module]       = :ActionView
+            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(options)
+          end
+        else
+          render_partial_without_traceview(options)
+        end
+      end
+
+      alias :render_partial_collection_without_traceview :render_partial_collection
+      def render_partial_collection(options = {})
+        entry_kvs = {}
+        begin
+          name  = 'partial_collection'
+          entry_kvs[:FunctionName] = :render_partial_collection
+          entry_kvs[:Class]        = :Partials
+          entry_kvs[:Module]       = :ActionView
+          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_collection_without_traceview(options)
+        end
+      end
+    end
+  end
+end
+
+# vim:set expandtab:tabstop=2