mmtrix_rpm 1.0.0.1

data/lib/mmtrix/agent/instrumentation/rails3/errors.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+module Mmtrix
+  module Agent
+    module Instrumentation
+      module Rails3
+        module Errors
+
+          # @api public
+          # @deprecated
+          def mmtrix_notice_error(exception, custom_params = {})
+            Mmtrix::Agent::Deprecator.deprecate("ActionController#mmtrix_notice_error",
+                                                  "Mmtrix::Agent#notice_error")
+
+            Mmtrix::Agent::Transaction.notice_error(exception,
+                                                      :metric => mmtrix_metric_path,
+                                                      :custom_params => custom_params)
+          end
+        end
+      end
+    end
+  end
+end
+
+DependencyDetection.defer do
+  @name = :rails3_error
+
+  depends_on do
+    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 3
+  end
+
+  depends_on do
+    defined?(ActionController) && defined?(ActionController::Base)
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Rails 3 Error instrumentation'
+  end
+
+  executes do
+    class ActionController::Base
+      include Mmtrix::Agent::Instrumentation::Rails3::Errors
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/rails4/action_controller.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+require 'mmtrix/agent/instrumentation/action_controller_subscriber'
+
+
+DependencyDetection.defer do
+  @name = :rails4_controller
+
+  depends_on do
+    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 4
+  end
+
+  depends_on do
+    defined?(ActionController) && defined?(ActionController::Base)
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Rails 4 Controller instrumentation'
+  end
+
+  executes do
+    class ActionController::Base
+      include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+    end
+    Mmtrix::Agent::Instrumentation::ActionControllerSubscriber \
+      .subscribe(/^process_action.action_controller$/)
+  end
+end

data/lib/mmtrix/agent/instrumentation/rails4/action_view.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+require 'mmtrix/agent/instrumentation/action_view_subscriber'
+
+DependencyDetection.defer do
+  @name = :rails4_view
+
+  depends_on do
+    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 4
+  end
+
+  depends_on do
+    !Mmtrix::Agent.config[:disable_view_instrumentation] &&
+      !Mmtrix::Agent::Instrumentation::ActionViewSubscriber.subscribed?
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Rails 4 view instrumentation'
+  end
+
+  executes do
+    Mmtrix::Agent::Instrumentation::ActionViewSubscriber.subscribe(/render_.+\.action_view$/)
+  end
+end

data/lib/mmtrix/agent/instrumentation/rails4/errors.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+module Mmtrix
+  module Agent
+    module Instrumentation
+      module Rails4
+        module Errors
+
+          # @api public
+          # @deprecated
+          def mmtrix_notice_error(exception, custom_params = {})
+            Mmtrix::Agent::Deprecator.deprecate("ActionController#mmtrix_notice_error",
+                                                  "Mmtrix::Agent#notice_error")
+
+            Mmtrix::Agent::Transaction.notice_error(exception,
+                                                      :custom_params => custom_params)
+          end
+        end
+      end
+    end
+  end
+end
+
+DependencyDetection.defer do
+  @name = :rails4_error
+
+  depends_on do
+    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i == 4
+  end
+
+  depends_on do
+    defined?(ActionController) && defined?(ActionController::Base)
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Rails 4 Error instrumentation'
+  end
+
+  executes do
+    class ActionController::Base
+      include Mmtrix::Agent::Instrumentation::Rails4::Errors
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/rails_middleware.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require 'mmtrix/agent/instrumentation/middleware_proxy'
+
+DependencyDetection.defer do
+  named :rails_middleware
+
+  depends_on do
+    defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
+  end
+
+  depends_on do
+    !::Mmtrix::Agent.config[:disable_middleware_instrumentation]
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info("Installing Rails 3+ middleware instrumentation")
+    module ActionDispatch
+      class MiddlewareStack
+        class Middleware
+          def build_with_mmtrix(app)
+            # MiddlewareProxy.wrap guards against double-wrapping here.
+            # We need to instrument the innermost app (usually a RouteSet),
+            # which will never itself be the return value from #build, but will
+            # instead be the initial value of the app argument.
+            wrapped_app = ::Mmtrix::Agent::Instrumentation::MiddlewareProxy.wrap(app)
+            result = build_without_mmtrix(wrapped_app)
+            ::Mmtrix::Agent::Instrumentation::MiddlewareProxy.wrap(result)
+          end
+
+          alias_method :build_without_mmtrix, :build
+          alias_method :build, :build_with_mmtrix
+        end
+      end
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/rainbows_instrumentation.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+DependencyDetection.defer do
+  @name = :rainbows
+
+  depends_on do
+    defined?(::Rainbows) && defined?(::Rainbows::HttpServer)
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Rainbows instrumentation'
+    ::Mmtrix::Agent.logger.info 'Detected Rainbows, please see additional documentation: https://mmtrix.com/docs/troubleshooting/im-using-unicorn-and-i-dont-see-any-data'
+  end
+
+  executes do
+    Rainbows::HttpServer.class_eval do
+      old_worker_loop = instance_method(:worker_loop)
+      define_method(:worker_loop) do |worker|
+        Mmtrix::Agent.after_fork(:force_reconnect => true)
+        old_worker_loop.bind(self).call(worker)
+      end
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/resque.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+DependencyDetection.defer do
+  @name = :resque
+
+  depends_on do
+    defined?(::Resque::Job) && !Mmtrix::Agent.config[:disable_resque]  &&
+      !Mmtrix::LanguageSupport.using_version?('1.9.1')
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Resque instrumentation'
+  end
+
+  executes do
+    if Mmtrix::Agent.config[:'resque.use_ruby_dns'] && Mmtrix::Agent.config[:dispatcher] == :resque
+      ::Mmtrix::Agent.logger.info 'Requiring resolv-replace'
+      require 'resolv'
+      require 'resolv-replace'
+    end
+  end
+
+  executes do
+    module Resque
+      module Plugins
+        module MmtrixInstrumentation
+          include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+
+          def around_perform_with_monitoring(*args)
+            begin
+              perform_action_with_mmtrix_trace(
+                :name => 'perform',
+                :class_name => self.name,
+                :category => 'OtherTransaction/ResqueJob') do
+
+                Mmtrix::Agent::Transaction.merge_untrusted_agent_attributes(args, :'job.resque.args',
+                  Mmtrix::Agent::AttributeFilter::DST_NONE)
+
+                yield(*args)
+              end
+            ensure
+              Mmtrix::Agent.agent.flush_pipe_data
+            end
+          end
+        end
+      end
+    end
+
+    module Mmtrix
+      module Agent
+        module Instrumentation
+          module ResqueInstrumentationInstaller
+            def payload_class
+              klass = super
+              klass.instance_eval do
+                extend ::Resque::Plugins::MmtrixInstrumentation
+              end
+            end
+          end
+        end
+      end
+    end
+
+    ::Resque::Job.class_eval do
+      def self.new(*args)
+        super(*args).extend Mmtrix::Agent::Instrumentation::ResqueInstrumentationInstaller
+      end
+    end
+
+    if Mmtrix::LanguageSupport.can_fork?
+      ::Resque.before_first_fork do
+        Mmtrix::Agent.manual_start(:dispatcher   => :resque,
+                                     :sync_startup => true,
+                                     :start_channel_listener => true)
+      end
+
+      ::Resque.before_fork do |job|
+        if ENV['FORK_PER_JOB'] != 'false'
+          Mmtrix::Agent.register_report_channel(job.object_id)
+        end
+      end
+
+      ::Resque.after_fork do |job|
+        # Only suppress reporting Instance/Busy for forked children
+        # Traced errors UI relies on having the parent process report that metric
+        Mmtrix::Agent.after_fork(:report_to_channel => job.object_id,
+                                   :report_instance_busy => false)
+      end
+    end
+  end
+end
+
+# call this now so it is memoized before potentially forking worker processes
+Mmtrix::LanguageSupport.can_fork?

data/lib/mmtrix/agent/instrumentation/rubyprof.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+DependencyDetection.defer do
+  named :rubyprof
+
+  depends_on do
+    defined?(::RubyProf) && defined?(::Mmtrix::Rack::DeveloperMode) && ::Mmtrix::Agent.config[:developer_mode]
+  end
+
+  executes do
+    Mmtrix::Agent.instance.events.subscribe(:start_transaction) do
+      if Mmtrix::Rack::DeveloperMode.profiling_enabled?
+        ::RubyProf.start
+      end
+    end
+
+    Mmtrix::Agent.instance.events.subscribe(:transaction_finished) do
+      if Mmtrix::Rack::DeveloperMode.profiling_enabled?
+        trace = Mmtrix::Agent::Transaction.tl_current.transaction_trace
+        trace.profile = ::RubyProf.stop
+      end
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/sequel.rb

@@ -0,0 +1,51 @@
+# -*- ruby -*-
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+DependencyDetection.defer do
+  @name = :sequel
+
+  depends_on do
+    defined?(::Sequel)
+  end
+
+  depends_on do
+    !Mmtrix::Agent.config[:disable_sequel_instrumentation] &&
+    !Mmtrix::Agent.config[:disable_database_instrumentation]
+  end
+
+  def supported_sequel_version?
+    Sequel.const_defined?( :MAJOR ) &&
+      ( Sequel::MAJOR > 3 ||
+        Sequel::MAJOR == 3 && Sequel::MINOR >= 37 )
+  end
+
+  executes do
+    if supported_sequel_version?
+
+      ::Mmtrix::Agent.logger.info 'Installing Sequel instrumentation'
+
+      if Sequel::Database.respond_to?( :extension )
+        Sequel::Database.extension :mmtrix_instrumentation
+      else
+        Mmtrix::Agent.logger.info "Detected Sequel version %s." % [ Sequel::VERSION ]
+        Mmtrix::Agent.logger.info "Please see additional documentation: " +
+          "https://mmtrix.com/docs/ruby/sequel-instrumentation"
+      end
+
+      Sequel.synchronize{Sequel::DATABASES.dup}.each do |db|
+        db.extension :mmtrix_instrumentation
+      end
+
+      Sequel::Model.plugin :mmtrix_instrumentation
+
+    else
+
+      Mmtrix::Agent.logger.info "Sequel instrumentation requires at least version 3.37.0."
+
+    end
+
+  end
+
+end

data/lib/mmtrix/agent/instrumentation/sequel_helper.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+module Mmtrix
+  module Agent
+    module Instrumentation
+      module SequelHelper
+        extend self
+
+        # Fallback if the product cannot be determined
+        DEFAULT_PRODUCT_NAME = "Sequel".freeze
+
+        # A Sequel adapter is called an "adapter_scheme" and can be accessed from
+        # the database:
+        #
+        #   DB.adapter_scheme
+        PRODUCT_NAMES = {
+          :ibmdb => "IBMDB2",
+          :firebird => "Firebird",
+          :informix => "Informix",
+          :jdbc => "JDBC",
+          :mysql => "MySQL",
+          :mysql2 => "MySQL",
+          :oracle => "Oracle",
+          :postgres => "Postgres",
+          :sqlite => "SQLite"
+        }.freeze
+
+        def product_name_from_adapter(adapter)
+          PRODUCT_NAMES.fetch(adapter, DEFAULT_PRODUCT_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/sidekiq.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+DependencyDetection.defer do
+  @name = :sidekiq
+
+  depends_on do
+    defined?(::Sidekiq) && !Mmtrix::Agent.config[:disable_sidekiq]
+  end
+
+  executes do
+    ::Mmtrix::Agent.logger.info 'Installing Sidekiq instrumentation'
+  end
+
+  executes do
+    class Mmtrix::SidekiqInstrumentation
+      include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+
+      # Client middleware has additional parameters, and our tests use the
+      # middleware client-side to work inline.
+      def call(worker, msg, queue, *_)
+        trace_args = if worker.respond_to?(:mmtrix_trace_args)
+          worker.mmtrix_trace_args(msg, queue)
+        else
+          self.class.default_trace_args(msg)
+        end
+
+        perform_action_with_mmtrix_trace(trace_args) do
+          Mmtrix::Agent::Transaction.merge_untrusted_agent_attributes(msg['args'], :'job.sidekiq.args',
+            Mmtrix::Agent::AttributeFilter::DST_NONE)
+
+          yield
+        end
+      end
+
+      def self.default_trace_args(msg)
+        {
+          :name => 'perform',
+          :class_name => msg['class'],
+          :category => 'OtherTransaction/SidekiqJob'
+        }
+      end
+    end
+
+    class Sidekiq::Extensions::DelayedClass
+      def mmtrix_trace_args(msg, queue)
+        (target, method_name, _args) = YAML.load(msg['args'][0])
+        {
+          :name => method_name,
+          :class_name => target.name,
+          :category => 'OtherTransaction/SidekiqJob'
+        }
+      rescue => e
+        Mmtrix::Agent.logger.error("Failure during deserializing YAML for Sidekiq::Extensions::DelayedClass", e)
+        Mmtrix::SidekiqInstrumentation.default_trace_args(msg)
+      end
+    end
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Mmtrix::SidekiqInstrumentation
+      end
+
+      if config.respond_to?(:error_handlers)
+        config.error_handlers << Proc.new do |error, *_|
+          Mmtrix::Agent.notice_error(error)
+        end
+      end
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/sinatra/ignorer.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+module Mmtrix
+  module Agent
+    module Instrumentation
+      module Sinatra
+        module Ignorer
+
+          def self.should_ignore?(app, type)
+            return false if !app.settings.respond_to?(:mmtrix_ignores)
+
+            app.settings.mmtrix_ignores[type].any? do |pattern|
+              pattern.match(app.request.path_info)
+            end
+          end
+
+          def mmtrix_ignore(*routes)
+            set_mmtrix_ignore(:routes, *routes)
+          end
+
+          def mmtrix_ignore_apdex(*routes)
+            set_mmtrix_ignore(:apdex, *routes)
+          end
+
+          def mmtrix_ignore_enduser(*routes)
+            set_mmtrix_ignore(:enduser, *routes)
+          end
+
+          private
+
+          def set_mmtrix_ignore(type, *routes)
+            # Important to default this in the context of the actual app
+            # If it's done at register time, ignores end up shared between apps.
+            set :mmtrix_ignores, Hash.new([]) if !respond_to?(:mmtrix_ignores)
+
+            # If we call an ignore without a route, it applies to the whole app
+            routes = ["*"] if routes.empty?
+
+            settings.mmtrix_ignores[type] += routes.map do |r|
+              # Ugly sending to private Base#compile, but we want to mimic
+              # exactly Sinatra's mapping of route text to regex
+              send(:compile, r).first
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/mmtrix/agent/instrumentation/sinatra/transaction_namer.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+module Mmtrix
+  module Agent
+    module Instrumentation
+      module Sinatra
+        module TransactionNamer
+          extend self
+
+          def transaction_name_for_route(env, request)
+            name = route_for_sinatra(env)
+            name = route_name_for_padrino(request) if name.nil?
+
+            transaction_name(name, request) unless name.nil?
+          end
+
+          def initial_transaction_name(request)
+            transaction_name(::Mmtrix::Agent::UNKNOWN_METRIC, request)
+          end
+
+          def transaction_name(route_text, request)
+            verb = http_verb(request)
+
+            route_text = route_text.source if route_text.is_a?(Regexp)
+            name = route_text.gsub(%r{^[/^\\A]*(.*?)[/\$\?\\z]*$}, '\1')
+            name = "#{verb} #{name}" unless verb.nil?
+            name
+          rescue => e
+            ::Mmtrix::Agent.logger.debug("#{e.class} : #{e.message} - Error encountered trying to identify Sinatra transaction name")
+            ::Mmtrix::Agent::UNKNOWN_METRIC
+          end
+
+          def http_verb(request)
+            request.request_method if request.respond_to?(:request_method)
+          end
+
+          # For bare Sinatra, our override on process_route captures the last
+          # route into the environment for us to use later on
+          def route_for_sinatra(env)
+            env["mmtrix.last_route"]
+          end
+
+          # For Padrino, the request object has a copy of the matched route
+          # on it when we go to evaluating, so we can just retrieve that
+          def route_name_for_padrino(request)
+            request.route_obj.original_path
+          rescue
+            nil
+          end
+        end
+      end
+    end
+  end
+end