solarwinds_apm 5.0.0

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

@@ -0,0 +1,100 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  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 do |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
+        end
+        has_handler
+      rescue => e
+        SolarWindsAPM.logger.debug "[solarwinds_apm/debug] Error searching Rails handlers: #{e.message}"
+        return false
+      end
+
+      #
+      # log_rails_error?
+      #
+      # Determines whether we should log a raised exception to the
+      # SolarWinds dashboard.  This is determined by whether the exception
+      # has a rescue handler setup and the value of
+      # SolarWindsAPM::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(:@exn_logged)
+
+        return false if has_handler?(exception) && !SolarWindsAPM::Config[:report_rescued_errors]
+
+        true
+      end
+
+      ##
+      # This method does the logging if we are tracing
+      # it `wraps` around the call to the original method
+      #
+      # This can't use the SDK trace() method because of the log_rails_error?(e) condition
+      def trace(layer)
+        return yield unless SolarWindsAPM.tracing?
+        begin
+          SolarWindsAPM::API.log_entry(layer)
+          yield
+        rescue Exception => e
+          SolarWindsAPM::API.log_exception(layer, e) if log_rails_error?(e)
+          raise
+        ensure
+          SolarWindsAPM::API.log_exit(layer)
+        end
+      end
+
+
+      #
+      # render_with_sw_apm
+      #
+      # Our render wrapper that calls 'add_logging', which will log if we are tracing
+      #
+      def render_with_sw_apm(*args, &blk)
+        trace('actionview') do
+          render_without_sw_apm(*args, &blk)
+        end
+      end
+    end
+  end
+end
+
+# ActionController::Base
+if defined?(ActionController::Base) && SolarWindsAPM::Config[:action_controller][:enabled]
+  SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting actioncontroller' if SolarWindsAPM::Config[:verbose]
+  require "solarwinds_apm/frameworks/rails/inst/action_controller5"
+  ActionController::Base.send(:prepend, ::SolarWindsAPM::Inst::ActionController)
+end
+
+# ActionController::API
+if defined?(ActionController::API) && SolarWindsAPM::Config[:action_controller_api][:enabled]
+  SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting actioncontroller api' if SolarWindsAPM::Config[:verbose]
+  require "solarwinds_apm/frameworks/rails/inst/action_controller_api"
+  ActionController::API.send(:prepend, ::SolarWindsAPM::Inst::ActionControllerAPI)
+end
+
+# vim:set expandtab:tabstop=2

data/lib/solarwinds_apm/frameworks/rails/inst/action_controller5.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Inst
+    #
+    # ActionController
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v5
+    #
+    module ActionController
+      include SolarWindsAPM::Inst::RailsBase
+
+      def process_action(method_name, *args)
+        kvs = {
+            :Controller   => self.class.name,
+            :Action       => self.action_name,
+        }
+        request.env['solarwinds_apm.controller'] = kvs[:Controller]
+        request.env['solarwinds_apm.action'] = kvs[:Action]
+
+        return super(method_name, *args) unless SolarWindsAPM.tracing?
+        begin
+          kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:action_controller][:collect_backtraces]
+
+          SolarWindsAPM::API.log_entry('rails', kvs)
+          super(method_name, *args)
+
+        rescue Exception => e
+          SolarWindsAPM::API.log_exception('rails', e) if log_rails_error?(e)
+          raise
+        ensure
+          SolarWindsAPM::API.log_exit('rails')
+        end
+      end
+
+      #
+      # render
+      #
+      # Our render wrapper that calls 'trace', which will log if we are tracing
+      #
+      def render(*args, &blk)
+        trace('actionview') do
+          super(*args, &blk)
+        end
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/frameworks/rails/inst/action_controller_api.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Inst
+    #
+    # ActionController
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v5.
+    #
+    module ActionControllerAPI
+      include SolarWindsAPM::Inst::RailsBase
+
+      def process_action(method_name, *args)
+        kvs = {
+            :Controller   => self.class.name,
+            :Action       => self.action_name
+        }
+        request.env['solarwinds_apm.controller'] = kvs[:Controller]
+        request.env['solarwinds_apm.action'] = kvs[:Action]
+
+        return super(method_name, *args) unless SolarWindsAPM.tracing?
+        begin
+          kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:action_controller_api][:collect_backtraces]
+
+          SolarWindsAPM::API.log_entry('rails-api', kvs)
+          super(method_name, *args)
+
+        rescue Exception => e
+          SolarWindsAPM::API.log_exception('rails', e) if log_rails_error?(e)
+          raise
+        ensure
+          SolarWindsAPM::API.log_exit('rails-api')
+        end
+      end
+
+      #
+      # render
+      #
+      # Our render wrapper that calls 'trace', which will log if we are tracing
+      #
+      def render(*args, &blk)
+        trace('actionview') do
+          super(*args, &blk)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+if defined?(ActionView::Base) && SolarWindsAPM::Config[:action_view][:enabled]
+
+  if Rails::VERSION::MAJOR >= 4
+
+    SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting actionview' if SolarWindsAPM::Config[:verbose]
+    if ActionView.version >= Gem::Version.new('6.1.0') # the methods changed in this version
+
+      ActionView::PartialRenderer.class_eval do
+        alias :render_partial_template_without_sw_apm :render_partial_template
+
+        def render_partial_template(*args)
+          _, _, template, _, _ = args
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+          rescue => e
+            SolarWindsAPM.logger.debug "[solarwinds_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if SolarWindsAPM::Config[:verbose]
+          end
+          SolarWindsAPM::SDK.trace(:partial, kvs: entry_kvs) do
+            entry_kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:action_view][:collect_backtraces]
+            render_partial_template_without_sw_apm(*args)
+          end
+        end
+      end
+
+      ActionView::CollectionRenderer.class_eval do
+        alias :render_collection_without_sw_apm :render_collection
+
+        def render_collection(*args)
+          _, _, _, template, _, _ = args
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+          rescue => e
+            SolarWindsAPM.logger.debug "[solarwinds_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if SolarWindsAPM::Config[:verbose]
+          end
+          SolarWindsAPM::SDK.trace(:collection, kvs: entry_kvs) do
+            entry_kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:action_view][:collect_backtraces]
+            render_collection_without_sw_apm(*args)
+          end
+        end
+      end
+
+    else # Rails < 6.1.0
+
+      ActionView::PartialRenderer.class_eval do
+        alias :render_partial_without_sw_apm :render_partial
+        def render_partial(*args)
+          template = @template || args[1]
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+            # entry_kvs[:Partial] = SolarWindsAPM::Util.prettify(@options[:partial]) if @options.is_a?(Hash)
+          rescue => e
+            SolarWindsAPM.logger.debug "[solarwinds_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if SolarWindsAPM::Config[:verbose]
+          end
+
+          SolarWindsAPM::SDK.trace('partial', kvs: entry_kvs) do
+            entry_kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:action_view][:collect_backtraces]
+            render_partial_without_sw_apm(*args)
+          end
+        end
+
+        alias :render_collection_without_sw_apm :render_collection
+        def render_collection(*args)
+          template = @template || args[1]
+          entry_kvs = {}
+          begin
+            entry_kvs[:Partial] = template.virtual_path
+          rescue => e
+            SolarWindsAPM.logger.debug "[solarwinds_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if SolarWindsAPM::Config[:verbose]
+          end
+
+          SolarWindsAPM::SDK.trace('collection', kvs: entry_kvs) do
+            entry_kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:action_view][:collect_backtraces]
+            render_collection_without_sw_apm(*args)
+          end
+        end
+      end
+
+    end
+  end
+end
+
+# vim:set expandtab:tabstop=2

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

@@ -0,0 +1,26 @@
+# Copyright (c) SolarWinds, LLC.
+# All rights reserved.
+
+require 'solarwinds_apm/frameworks/rails/inst/connection_adapters/mysql2'
+require 'solarwinds_apm/frameworks/rails/inst/connection_adapters/postgresql'
+
+if SolarWindsAPM::Config[:active_record][:enabled]
+  begin
+    SolarWindsAPM::Config[:verbose]
+    adapter = if ActiveRecord::Base.respond_to?(:connection_db_config)
+                ActiveRecord::Base.connection_db_config.adapter
+              else
+                ActiveRecord::Base.connection_config[:adapter]
+              end
+
+    require 'solarwinds_apm/frameworks/rails/inst/connection_adapters/utils5x'
+
+    SolarWindsAPM::Inst::ConnectionAdapters::FlavorInitializers.mysql2     if adapter == 'mysql2'
+    SolarWindsAPM::Inst::ConnectionAdapters::FlavorInitializers.postgresql if adapter =~ /postgresql|postgis/i
+
+  rescue StandardError => e
+    SolarWindsAPM.logger.error "[solarwinds_apm/error] SolarWindsAPM/ActiveRecord error: #{e.inspect}"
+    SolarWindsAPM.logger.debug e.backtrace.join("\n")
+  end
+end
+# vim:set expandtab:tabstop=2

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

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

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

@@ -0,0 +1,22 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.postgresql
+
+          SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting activerecord postgresqladapter' if SolarWindsAPM::Config[:verbose]
+
+          SolarWindsAPM::Util.send_include(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter,
+                                  SolarWindsAPM::Inst::ConnectionAdapters::Utils)
+
+          SolarWindsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_query)
+          SolarWindsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_update)
+          SolarWindsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_delete)
+        end
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/frameworks/rails/inst/connection_adapters/utils5x.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Inst
+    module ConnectionAdapters
+      module Utils
+
+        def exec_query_with_sw_apm(*args, **args2)
+          trace_wrap(*args) do |args|
+            exec_query_without_sw_apm(*args, **args2)
+          end
+        end
+
+        # need to instrument them all
+        def exec_insert_with_sw_apm(*args)
+          trace_wrap(*args) do |args|
+            exec_insert_without_sw_apm(*args)
+          end
+        end
+
+        def exec_delete_with_sw_apm(*args)
+          trace_wrap(*args) do |args|
+            exec_delete_without_sw_apm(*args)
+          end
+        end
+
+        def exec_update_with_sw_apm(*args)
+          trace_wrap(*args) do |args|
+            exec_update_without_sw_apm(*args)
+          end
+        end
+
+        private
+
+        def trace_wrap(*args)
+          sql, name, binds, _ = args
+          kvs = {}
+          args[0] = SolarWindsAPM::SDK.current_trace_info.add_traceparent_to_sql(sql, kvs)
+          if SolarWindsAPM.tracing? && !ignore_payload?(name)
+            assign_kvs(sql, kvs, name, binds || [])
+            # use protect_op to avoid double tracing in mysql2
+            SolarWindsAPM::SDK.trace('activerecord', kvs: kvs, protect_op: :ar_started) do
+              yield args
+            end
+          else
+            yield args
+          end
+        end
+
+        def assign_kvs(sql, kvs, name = nil, binds = [])
+          sql = SolarWindsAPM::Util.remove_traceparent(sql.to_s)
+          if SolarWindsAPM::Config[:sanitize_sql]
+            # Sanitize SQL and don't report binds
+            kvs[:Query] = SolarWindsAPM::Util.sanitize_sql(sql)
+          else
+            # Report raw SQL or name of statement and any binds if they exist
+            kvs[:Query] = sql
+            if binds && !binds.empty?
+              kvs[:QueryArgs] = binds.map(&:value)
+            end
+          end
+
+          kvs[:Name] = name.to_s if name
+          if SolarWindsAPM::Config[:active_record] && SolarWindsAPM::Config[:active_record][:collect_backtraces]
+            kvs[:Backtrace] = SolarWindsAPM::API.backtrace
+          end
+
+          if ActiveRecord::Base.respond_to?(:connection_db_config)
+            config = ActiveRecord::Base.connection_db_config.configuration_hash
+          else
+            config = ActiveRecord::Base.connection_config
+          end
+
+          if config
+            kvs[:Database] = config[:database] if config.key?(:database)
+            kvs[:RemoteHost] = config[:host] if config.key?(:host)
+            adapter_name = config[:adapter]
+
+            case adapter_name
+            when /mysql/i
+              kvs[:Flavor] = 'mysql'
+            when /^postgres|^postgis/i
+              kvs[:Flavor] = 'postgresql'
+            end
+          end
+        rescue StandardError => e
+          SolarWindsAPM.logger.debug "[solarwinds_apm/rails] Exception raised capturing ActiveRecord KVs: #{e.inspect}"
+          SolarWindsAPM.logger.debug e.backtrace.join('\n')
+        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
+
+      end # Utils
+    end
+  end
+end

data/lib/solarwinds_apm/frameworks/rails/inst/logger_formatters.rb

@@ -0,0 +1,14 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
+if SolarWindsAPM.loaded && defined?(ActiveSupport::Logger::SimpleFormatter)
+  # even though SimpleFormatter inherits from Logger,
+  # this will not append trace info twice,
+  # because SimpleFormatter#call does not call super
+  ActiveSupport::Logger::SimpleFormatter.send(:prepend, SolarWindsAPM::Logger::Formatter)
+end
+
+
+if SolarWindsAPM.loaded && defined?(ActiveSupport::TaggedLogging::Formatter)
+  ActiveSupport::TaggedLogging::Formatter.send(:prepend, SolarWindsAPM::Logger::Formatter)
+end

data/lib/solarwinds_apm/frameworks/rails.rb

@@ -0,0 +1,100 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require_relative '../../../lib/solarwinds_apm/inst/logger_formatter'
+
+module SolarWindsAPM
+  module Rails
+    module Helpers
+      extend ActiveSupport::Concern if defined?(::Rails)
+
+      # Deprecated
+      # no usages
+      def sw_apm_rum_header
+        SolarWindsAPM.logger.warn '[solarwinds_apm/warn] Note that sw_apm_rum_header is deprecated.  It is now a no-op and should be removed from your application code.'
+        return ''
+      end
+      alias_method :oboe_rum_header, :sw_apm_rum_header
+
+      # Deprecated
+      def sw_apm_rum_footer
+        SolarWindsAPM.logger.warn '[solarwinds_apm/warn] Note that sw_apm_rum_footer is deprecated.  It is now a no-op and should be removed from your application code.'
+        return ''
+      end
+      alias_method :oboe_rum_footer, :sw_apm_rum_footer
+    end # Helpers
+
+    def self.load_initializer
+      # Force load the SolarWindsAPM Rails initializer if there is one
+      # Prefer solarwinds_apm.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.to_s
+      end
+
+      #
+      # We've been through 3 initializer names.  Try each one.
+      #
+      if File.exist?("#{rails_root}/config/initializers/tracelytics.rb")
+        tr_initializer = "#{rails_root}/config/initializers/tracelytics.rb"
+      elsif File.exist?("#{rails_root}/config/initializers/oboe.rb")
+        tr_initializer = "#{rails_root}/config/initializers/oboe.rb"
+      else
+        tr_initializer = "#{rails_root}/config/initializers/solarwinds_apm.rb"
+      end
+      require tr_initializer if File.exist?(tr_initializer)
+    end
+
+    def self.load_instrumentation
+      # Load the Rails specific instrumentation
+      require 'solarwinds_apm/frameworks/rails/inst/action_controller'
+      require 'solarwinds_apm/frameworks/rails/inst/action_view'
+      require 'solarwinds_apm/frameworks/rails/inst/active_record'
+      require 'solarwinds_apm/frameworks/rails/inst/logger_formatters'
+
+      SolarWindsAPM.logger.info "[solarwinds_apm/rails] SolarWindsAPM gem #{SolarWindsAPM::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 SolarWindsAPM::Rails::Helpers
+      # end
+      ActiveSupport.on_load(:action_view) do
+        include SolarWindsAPM::Rails::Helpers
+      end
+    end
+  end # Rails
+end # SolarWindsAPM
+
+if defined?(::Rails)
+  require 'solarwinds_apm/inst/rack'
+
+  module SolarWindsAPM
+    class Railtie < ::Rails::Railtie
+      initializer 'solarwinds_apm.helpers' do
+        SolarWindsAPM::Rails.include_helpers
+      end
+
+      initializer 'solarwinds_apm.controller', before: 'wicked_pdf.register' do
+        SolarWindsAPM::Rails.load_instrumentation
+      end
+
+      initializer 'solarwinds_apm.rack' do |app|
+        SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting rack' if SolarWindsAPM::Config[:verbose]
+        app.config.middleware.insert 0, SolarWindsAPM::Rack
+      end
+
+      config.after_initialize do
+        SolarWindsAPM.logger = ::Rails.logger if ::Rails.logger && !ENV.key?('SW_APM_GEM_TEST')
+
+        SolarWindsAPM::Inst.load_instrumentation
+        # SolarWindsAPM::Rails.load_instrumentation
+
+        # Report __Init after fork when in Heroku
+        SolarWindsAPM::API.report_init unless SolarWindsAPM.heroku?
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/frameworks/sinatra.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Sinatra
+    module Base
+      def self.included(klass)
+        SolarWindsAPM::Util.method_alias(klass, :dispatch!,         ::Sinatra::Base)
+        SolarWindsAPM::Util.method_alias(klass, :handle_exception!, ::Sinatra::Base)
+      end
+
+      def dispatch_with_sw_apm
+
+        SolarWindsAPM::API.log_entry('sinatra', {})
+
+        response = dispatch_without_sw_apm
+
+        # Report Controller/Action and transaction as best possible
+        report_kvs = {}
+        report_kvs[:Controller] = self.class
+        report_kvs[:Action] = env['sinatra.route']
+        env['solarwinds_apm.controller'] = report_kvs[:Controller]
+        env['solarwinds_apm.action']     = report_kvs[:Action]
+
+        response
+      rescue => e
+        SolarWindsAPM::API.log_exception('sinatra', e)
+        raise e
+      ensure
+        report_kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:sinatra][:collect_backtraces]
+        SolarWindsAPM::API.log_exit('sinatra', report_kvs)
+      end
+
+      def handle_exception_with_sw_apm(boom)
+        SolarWindsAPM::API.log_exception(:sinatra, boom)
+        handle_exception_without_sw_apm(boom)
+      end
+
+      def sw_apm_rum_header
+        SolarWindsAPM.logger.warn '[solarwinds_apm/warn] Note that sw_apm_rum_header is deprecated.  It is now a no-op and should be removed from your application code.'
+        return ''
+      end
+      alias_method :oboe_rum_header, :sw_apm_rum_header
+
+      def sw_apm_rum_footer
+        SolarWindsAPM.logger.warn '[solarwinds_apm/warn] Note that sw_apm_rum_footer is deprecated.  It is now a no-op and should be removed from your application code.'
+        return ''
+      end
+      alias_method :oboe_rum_footer, :sw_apm_rum_footer
+    end
+
+    module Templates
+      def self.included(klass)
+        SolarWindsAPM::Util.method_alias(klass, :render, ::Sinatra::Templates)
+      end
+
+      def render_with_sw_apm(engine, data, options = {}, locals = {}, &block)
+        if SolarWindsAPM.tracing?
+          report_kvs = {}
+
+          report_kvs[:engine] = engine
+          report_kvs[:template] = data
+
+          SolarWindsAPM::SDK.trace(:sinatra_render, kvs: report_kvs, protect_op: :sinatra_render) do
+            report_kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:sinatra][:collect_backtraces]
+            render_without_sw_apm(engine, data, options, locals, &block)
+          end
+        else
+          render_without_sw_apm(engine, data, options, locals, &block)
+        end
+      end
+    end
+  end
+end
+
+if defined?(Sinatra) && SolarWindsAPM::Config[:sinatra][:enabled]
+  require 'solarwinds_apm/inst/rack'
+
+  SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting Sinatra' if SolarWindsAPM::Config[:verbose]
+
+  SolarWindsAPM::Inst.load_instrumentation
+
+  Sinatra::Base.use SolarWindsAPM::Rack
+
+  # When in the gem TEST environment, we load this instrumentation regardless.
+  # Otherwise, only when Padrino isn't around.
+  unless defined?(Padrino) && !ENV.key?('SW_APM_GEM_TEST')
+    # Padrino has 'enhanced' routes and rendering so the Sinatra
+    # instrumentation won't work anyways.  Only load for pure Sinatra apps.
+    SolarWindsAPM::Util.send_include(Sinatra::Base,      SolarWindsAPM::Sinatra::Base)
+    SolarWindsAPM::Util.send_include(Sinatra::Templates, SolarWindsAPM::Sinatra::Templates)
+
+    # Report __Init after fork when in Heroku
+    SolarWindsAPM::API.report_init unless SolarWindsAPM.heroku?
+  end
+end