appsignal 0.12.rc.7 → 0.12.rc.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a531aa7d19fc95984cdd43be2973189fd4c346ce
-  data.tar.gz: af4743469d11f853cbc36b9db65febc1266e89f5
+  metadata.gz: 638229bbdb0e216279fb2f10390b72bf7f030f8b
+  data.tar.gz: 59785b7e222a6eefb6173c113d3b3bf03b74a3f7
 SHA512:
-  metadata.gz: c1a9902fcceb5d376b9759aede9bc9bdd64cb7df27ca9bbc4ab3186dc099eccd6bf7bff28cc6d42aa3ee0f96f5a7c4f5ccdb086df3c36659b4faa623d8b75872
-  data.tar.gz: 8a53db6b00208926547f3326fff4257d9d58cf8bf521f0abe6425be6f8ad49107d7dbc13731aa759bdd2676d01c6f0ad1706036d6928b400136ccc76ffa4ffe9
+  metadata.gz: 70b9b08911109dba74572017b040cfcacb7f8ea0b42f73304a24bba61a5a49a8c48f9065b839cf4d40e02cdb6fa513c220bce54c2b461b8fc49f30076ee13ee2
+  data.tar.gz: 09d494df6ba6f0abd07e2a00ac7f52c56e740e64fe682550d7cd6df45c05736fe99b8f1c70ac66809c54aefa74d5e4fa2ce4f52781b5001edba39d38428b5b6a

data/ext/agent.yml

@@ -1,15 +1,15 @@
 ---
-:version: e249c63
+:version: 4bf99f0
 :triples:
   x86_64-linux:
-    :checksum: 444b04b39e98c3071bed05e337d17503ff736b1a830f3952868963cef7c36902
-    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/e249c63/appsignal-agent-x86_64-linux-static.tar.gz
+    :checksum: 7f02d2f36ff715254d9ec7b99c243ad3a2849ed05c79d0e7e11e4c7140aae576
+    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/4bf99f0/appsignal-agent-x86_64-linux-static.tar.gz
     :lib_filename: libappsignal.a
   i686-linux:
-    :checksum: bd2fbb0f4185c0035b82b7a9a657b27b540696aa8a07bdbcac3a5651952957d7
-    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/e249c63/appsignal-agent-i686-linux-static.tar.gz
+    :checksum: 8103f83f4cf7d9bf22ebafb40216aede836d9d368cdf0f15d0d9644f3d9b4cf7
+    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/4bf99f0/appsignal-agent-i686-linux-static.tar.gz
     :lib_filename: libappsignal.a
   x86_64-darwin:
-    :checksum: 957340856e0b5ac3f6e0bd2d5f70679218caf6cecc47f998c27b661cdad750df
-    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/e249c63/appsignal-agent-x86_64-darwin-static.tar.gz
+    :checksum: 22937f34d26ea1dce722b102946a2f3daf3c30755d9f451c6440f580e3dc3eeb
+    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/4bf99f0/appsignal-agent-x86_64-darwin-static.tar.gz
     :lib_filename: libappsignal.a

data/lib/appsignal.rb

@@ -12,12 +12,6 @@ module Appsignal
   class << self
     attr_accessor :config, :subscriber, :logger, :agent, :in_memory_log, :extension_loaded
 
-    def load_instrumentations
-      require 'appsignal/instrumentations/net_http' if config[:instrument_net_http]
-      require 'appsignal/instrumentations/redis' if config[:instrument_redis]
-      require 'appsignal/instrumentations/sequel' if config[:instrument_sequel]
-    end
-
     def extensions
       @extensions ||= []
     end
@@ -50,7 +44,7 @@ module Appsignal
           logger.info("Starting AppSignal #{Appsignal::VERSION} on #{RUBY_VERSION}/#{RUBY_PLATFORM}")
           config.write_to_environment
           Appsignal::Extension.start
-          load_instrumentations
+          Appsignal::Hooks.load_hooks
           Appsignal::EventFormatter.initialize_formatters
           initialize_extensions
           Appsignal::Extension.install_allocation_event_hook if config[:enable_allocation_tracking]
@@ -251,19 +245,13 @@ require 'appsignal/extension'
 require 'appsignal/auth_check'
 require 'appsignal/config'
 require 'appsignal/event_formatter'
+require 'appsignal/hooks'
 require 'appsignal/marker'
 require 'appsignal/params_sanitizer'
+require 'appsignal/integrations/railtie' if defined?(::Rails)
 require 'appsignal/subscriber'
 require 'appsignal/transaction'
 require 'appsignal/version'
 require 'appsignal/rack/js_exception_catcher'
 require 'appsignal/js_exception_transaction'
 require 'appsignal/transmitter'
-require 'appsignal/integrations/celluloid'
-require 'appsignal/integrations/delayed_job'
-require 'appsignal/integrations/passenger'
-require 'appsignal/integrations/puma'
-require 'appsignal/integrations/sidekiq'
-require 'appsignal/integrations/rails'
-require 'appsignal/integrations/resque'
-require 'appsignal/integrations/unicorn'

data/lib/appsignal/hooks.rb

@@ -0,0 +1,61 @@
+module Appsignal
+  class Hooks
+    class << self
+      def register(name, hook)
+        hooks[name] = hook
+      end
+
+      def load_hooks
+        hooks.each do |name, hook|
+          hook.try_to_install(name)
+        end
+      end
+
+      def hooks
+        @hooks ||= {}
+      end
+    end
+
+    class Hook
+      def self.register(name, hook=self)
+        Appsignal::Hooks.register(name, hook.new)
+      end
+
+      def try_to_install(name)
+        if dependencies_present? && !installed?
+          Appsignal.logger.info("Installing #{name} hook")
+          begin
+            install
+            @installed = true
+          rescue => ex
+            Appsignal.logger.error("Error while installing #{name} hook: #{ex}")
+          end
+        end
+      end
+
+      def installed?
+        !! @installed
+      end
+
+      def dependencies_present?
+        raise NotImplementedError
+      end
+
+      def install
+        raise NotImplementedError
+      end
+    end
+  end
+end
+
+require 'appsignal/hooks/celluloid'
+require 'appsignal/hooks/delayed_job'
+require 'appsignal/hooks/net_http'
+require 'appsignal/hooks/passenger'
+require 'appsignal/hooks/puma'
+require 'appsignal/hooks/rake'
+require 'appsignal/hooks/redis'
+require 'appsignal/hooks/resque'
+require 'appsignal/hooks/sequel'
+require 'appsignal/hooks/sidekiq'
+require 'appsignal/hooks/unicorn'

data/lib/appsignal/hooks/celluloid.rb

@@ -0,0 +1,29 @@
+module Appsignal
+  class Hooks
+    class CelluloidHook < Appsignal::Hooks::Hook
+      register :celluloid
+
+      def dependencies_present?
+        defined?(::Celluloid)
+      end
+
+      def install
+        # Some versions of Celluloid have race conditions while exiting
+        # that can result in a dead lock. We stop appsignal before shutting
+        # down Celluloid so we're sure our thread does not aggravate this situation.
+        # This way we also make sure any outstanding transactions get flushed.
+
+        ::Celluloid.class_eval do
+          class << self
+            alias shutdown_without_appsignal shutdown
+
+            def shutdown
+              Appsignal.stop
+              shutdown_without_appsignal
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/delayed_job.rb

@@ -0,0 +1,18 @@
+module Appsignal
+  class Hooks
+    class DelayedJobHook < Appsignal::Hooks::Hook
+      register :delayed_job
+
+      def dependencies_present?
+        defined?(::Delayed::Plugin)
+      end
+
+      def install
+        # The DJ plugin is a subclass of Delayed::Plugin, so we can only
+        # require this code if we're actually installing.
+        require 'appsignal/integrations/delayed_job_plugin'
+        ::Delayed::Worker.plugins << Appsignal::Hooks::DelayedJobPlugin
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/net_http.rb

@@ -0,0 +1,31 @@
+require 'net/http'
+
+module Appsignal
+  class Hooks
+    class NetHttpHook < Appsignal::Hooks::Hook
+      register :net_http
+
+      def dependencies_present?
+        Appsignal.config[:instrument_net_http]
+      end
+
+      def install
+        Net::HTTP.class_eval do
+          alias request_without_appsignal request
+
+          def request(request, body=nil, &block)
+            ActiveSupport::Notifications.instrument(
+              'request.net_http',
+              :protocol => use_ssl? ? 'https' : 'http',
+              :domain   => request['host'] || self.address,
+              :path     => request.path,
+              :method   => request.method
+            ) do
+              request_without_appsignal(request, body, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/passenger.rb

@@ -0,0 +1,21 @@
+module Appsignal
+  class Hooks
+    class PassengerHook < Appsignal::Hooks::Hook
+      register :passenger
+
+      def dependencies_present?
+        defined?(::PhusionPassenger)
+      end
+
+      def install
+        ::PhusionPassenger.on_event(:starting_worker_process) do |forked|
+          Appsignal.forked
+        end
+
+        ::PhusionPassenger.on_event(:stopping_worker_process) do
+          Appsignal.stop
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/puma.rb

@@ -0,0 +1,20 @@
+module Appsignal
+  class Hooks
+    class PumaHook < Appsignal::Hooks::Hook
+      register :puma
+
+      def dependencies_present?
+        defined?(::Puma) &&
+          ::Puma.respond_to?(:cli_config) &&
+          ::Puma.cli_config
+      end
+
+      def install
+        ::Puma.cli_config.options[:before_worker_shutdown] ||= []
+        ::Puma.cli_config.options[:before_worker_shutdown] << Proc.new do |id|
+          Appsignal.stop
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/rake.rb

@@ -0,0 +1,42 @@
+module Appsignal
+  class Hooks
+    class RakeHook < Appsignal::Hooks::Hook
+      register :rake
+
+      def dependencies_present?
+        defined?(::Rake::Task)
+      end
+
+      def install
+        ::Rake::Task.class_eval do
+          alias :invoke_without_appsignal :invoke
+
+          def invoke(*args)
+            if Appsignal.active?
+              invoke_with_appsignal(*args)
+            else
+              invoke_without_appsignal(*args)
+            end
+          end
+
+          def invoke_with_appsignal(*args)
+            invoke_without_appsignal(*args)
+          rescue => error
+            transaction = Appsignal::Transaction.create(
+              SecureRandom.uuid,
+              Appsignal::Transaction::BACKGROUND_JOB,
+              Appsignal::Transaction::GenericRequest.new(
+                :params => args
+              )
+            )
+            transaction.set_action(name)
+            transaction.set_error(error)
+            transaction.complete!
+            Appsignal.stop
+            raise error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/redis.rb

@@ -0,0 +1,24 @@
+module Appsignal
+  class Hooks
+    class RedisHook < Appsignal::Hooks::Hook
+      register :redis
+
+      def dependencies_present?
+        defined?(::Redis) &&
+          Appsignal.config[:instrument_redis]
+      end
+
+      def install
+        ::Redis::Client.class_eval do
+          alias process_without_appsignal process
+
+          def process(commands, &block)
+            ActiveSupport::Notifications.instrument('query.redis') do
+              process_without_appsignal(commands, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/resque.rb

@@ -0,0 +1,28 @@
+module Appsignal
+  class Hooks
+    module ResquePlugin
+      def around_perform_resque_plugin(*args)
+        Appsignal.monitor_single_transaction(
+          'perform_job.resque',
+          :class => self.to_s,
+          :method => 'perform'
+        ) do
+          yield
+        end
+      end
+    end
+
+    class ResqueHook < Appsignal::Hooks::Hook
+      register :resque
+
+      def dependencies_present?
+        defined?(::Resque)
+      end
+
+      def install
+        # Extend the default job class with AppSignal instrumentation
+        ::Resque::Job.send(:extend, Appsignal::Hooks::ResquePlugin)
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/sequel.rb

@@ -0,0 +1,38 @@
+module Appsignal
+  class Hooks
+    module SequelExtension
+      # Add query instrumentation
+      def log_yield(sql, args = nil)
+
+        # We'd like to get full sql queries in the payloads as well. To do
+        # that we need to find out a way to ask Sequel which quoting strategy
+        # is used by the adapter. We can then do something similar to the AR
+        # formatter.
+
+        ActiveSupport::Notifications.instrument('sql.sequel') do
+          yield
+        end
+      end
+    end
+
+    class SequelHook < Appsignal::Hooks::Hook
+      register :sequel
+
+      def dependencies_present?
+        defined?(::Sequel::Database) &&
+          Appsignal.config[:instrument_sequel]
+      end
+
+      def install
+        # Register the extension...
+        ::Sequel::Database.register_extension(
+          :appsignal_integration,
+          Appsignal::Hooks::SequelExtension
+        )
+
+        # ... and automatically add it to future instances.
+        ::Sequel::Database.extension(:appsignal_integration)
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/sidekiq.rb

@@ -0,0 +1,68 @@
+module Appsignal
+  class Hooks
+    class SidekiqPlugin
+      def job_keys
+        @job_keys ||= Set.new(%w(
+            class args retried_at failed_at
+            error_message error_class backtrace
+            error_backtrace enqueued_at retry
+        ))
+      end
+
+      def call(worker, item, queue)
+        Appsignal.monitor_transaction(
+          'perform_job.sidekiq',
+          :class       => item['wrapped'] || item['class'],
+          :method      => 'perform',
+          :metadata    => formatted_metadata(item),
+          :params      => format_args(item['args']),
+          :queue_start => item['enqueued_at']
+        ) do
+          yield
+        end
+      end
+
+      def formatted_metadata(item)
+        {}.tap do |hsh|
+          item.each do |key, val|
+            hsh[key] = truncate(string_or_inspect(val)) unless job_keys.include?(key)
+          end
+        end
+      end
+
+      def string_or_inspect(string_or_other)
+        if string_or_other.is_a?(String)
+          string_or_other
+        else
+          string_or_other.inspect
+        end
+      end
+
+      def format_args(args)
+        args.map do |arg|
+          truncate(string_or_inspect(arg))
+        end
+      end
+
+      def truncate(text)
+        text.size > 200 ? "#{text[0...197]}..." : text
+      end
+    end
+
+    class SidekiqHook < Appsignal::Hooks::Hook
+      register :sidekiq
+
+      def dependencies_present?
+        defined?(::Sidekiq)
+      end
+
+      def install
+        ::Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add Appsignal::Hooks::SidekiqPlugin
+          end
+        end
+      end
+    end
+  end
+end