appsignal 3.0.0.beta.1 → 3.0.0.rc.1

data/CHANGELOG.md

@@ -2,9 +2,29 @@
 
 # 3.0.0
 - Drop Ruby 1.9 support. PR #683, #682, #688, #694
+- Require Ruby 2.0 or newer for gem. PR #701
 - Use Module.prepend for all gem integrations. Fixes #603 in combination with
   other gems that provide instrumentation for gems. PR #683
 - Remove deprecated integrations, classes, methods and arguments. PR #685
+- Deprecate `set_error` and `send_error` error helpers `tags` and `namespace`
+  arguments. PR #702
+- Add Sidekiq error handler. Report more Sidekiq errors that happen around job
+  execution. PR #699
+
+# 2.11.9
+- Fix and simplify Ruby method delegation for object method instrumentation in
+  the different Ruby versions. PR #706
+
+# 2.11.8
+- Mark minutely probe thread as fork-safe by @pixeltrix. PR #704
+
+# 2.11.7
+- Fix ActionCable integration in test environment using `stub_connection`.
+  PR #705
+
+# 2.11.6
+- Prepend Sidekiq middleware to wrap all Sidekiq middleware. Catches more
+  errors and provide more complete performance measurements. PR #698
 
 # 2.11.5
 - Add more detailed logging to finish_event calls when the event is unknown, so

data/appsignal.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.name                  = "appsignal"
   gem.require_paths         = %w[lib ext]
   gem.version               = Appsignal::VERSION
-  gem.required_ruby_version = ">= 1.9"
+  gem.required_ruby_version = ">= 2.0"
   # Default extension installer. Overridden by JRuby gemspec as defined in
   # `Rakefile`.
   gem.extensions            = %w[ext/extconf.rb]

data/build_matrix.yml

@@ -58,7 +58,7 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         - name: Validate CI setup
           env_vars:
             - name: RUBY_VERSION
-              value: 2.6.5
+              value: 2.6.6
             - name: GEMSET
               value: no_dependencies
             - name: BUNDLE_GEMFILE
@@ -72,7 +72,7 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         - name: RuboCop
           env_vars:
             - name: RUBY_VERSION
-              value: 2.6.5
+              value: 2.6.6
             - name: GEMSET
               value: no_dependencies
             - name: BUNDLE_GEMFILE
@@ -107,12 +107,12 @@ matrix:
       gems: "none"
     - ruby: "2.3.8"
       gems: "none"
-    - ruby: "2.4.9"
+    - ruby: "2.4.10"
       gems: "none"
-    - ruby: "2.5.7"
+    - ruby: "2.5.8"
       gems: "minimal"
-    - ruby: "2.6.5"
-    - ruby: "2.7.1"
+    - ruby: "2.6.6"
+    - ruby: "2.7.2"
     - ruby: "3.0.0"
     - ruby: "jruby-9.1.17.0"
       gems: "minimal"
@@ -134,15 +134,15 @@ matrix:
       bundler: "1.17.3"
       exclude:
         ruby:
-          - "2.6.5"
-          - "2.7.1"
+          - "2.6.6"
+          - "2.7.2"
           - "3.0.0"
     - gem: "rails-4.2"
       bundler: "1.17.3"
       exclude:
         ruby:
-          - "2.6.5"
-          - "2.7.1"
+          - "2.6.6"
+          - "2.7.2"
           - "3.0.0"
     - gem: "rails-5.0"
       exclude:
@@ -166,7 +166,7 @@ matrix:
           - "2.1.10"
           - "2.2.10"
           - "2.3.8"
-          - "2.4.9"
+          - "2.4.10"
           - "jruby-9.1.17.0"
     - gem: "resque-1"
       bundler: "1.17.3"

data/lib/appsignal.rb

@@ -4,9 +4,9 @@ require "json"
 require "securerandom"
 
 require "appsignal/logger"
+require "appsignal/utils/deprecation_message"
 require "appsignal/helpers/instrumentation"
 require "appsignal/helpers/metrics"
-require "appsignal/utils/deprecation_message"
 
 # AppSignal for Ruby gem's main module.
 #
@@ -18,7 +18,6 @@ module Appsignal
   class << self
     include Helpers::Instrumentation
     include Helpers::Metrics
-    include Utils::DeprecationMessage
 
     # Accessor for the AppSignal configuration.
     # Return the current AppSignal configuration.

data/lib/appsignal/helpers/instrumentation.rb

@@ -3,6 +3,8 @@
 module Appsignal
   module Helpers
     module Instrumentation # rubocop:disable Metrics/ModuleLength
+      include Appsignal::Utils::DeprecationMessage
+
       # Creates an AppSignal transaction for the given block.
       #
       # If AppSignal is not {.active?} it will still execute the block, but not
@@ -139,7 +141,10 @@ module Appsignal
       )
         yield
       rescue Exception => error # rubocop:disable Lint/RescueException
-        send_error(error, tags, namespace)
+        send_error(error) do |transaction|
+          transaction.set_tags(tags) if tags
+          transaction.set_namespace(namespace) if namespace
+        end
         raise error
       end
       alias :listen_for_exception :listen_for_error
@@ -164,7 +169,7 @@ module Appsignal
       #     Appsignal.send_error(e)
       #   end
       #
-      # @example Send an exception with tags
+      # @example Send an exception with tags. Deprecated method.
       #   begin
       #     raise "oh no!"
       #   rescue => e
@@ -172,17 +177,20 @@ module Appsignal
       #   end
       #
       # @example Add more metadata to transaction
-      #   Appsignal.send_error(e, :key => "value") do |transaction|
+      #   Appsignal.send_error(e) do |transaction|
       #     transaction.params(:search_query => params[:search_query])
       #     transaction.set_action("my_action_name")
+      #     transaction.set_tags(:key => "value")
       #     transaction.set_namespace("my_namespace")
       #   end
       #
       # @param error [Exception] The error to send to AppSignal.
       # @param tags [Hash{String, Symbol => String, Symbol, Integer}]
       #   Additional tags to add to the error. See also {.tag_request}.
+      #   This parameter is deprecated. Use the block argument instead.
       # @param namespace [String] The namespace in which the error occurred.
       #   See also {.set_namespace}.
+      #   This parameter is deprecated. Use the block argument instead.
       # @yield [transaction] yields block to allow modification of the
       #   transaction before it's send.
       # @yieldparam transaction [Transaction] yields the AppSignal transaction
@@ -197,9 +205,30 @@ module Appsignal
       def send_error(
         error,
         tags = nil,
-        namespace = Appsignal::Transaction::HTTP_REQUEST
+        namespace = nil
       )
+        if tags
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The tags argument for `Appsignal.send_error` is deprecated. " \
+            "Please use the block method to set tags instead.\n\n" \
+            "  Appsignal.send_error(error) do |transaction|\n" \
+            "    transaction.set_tags(#{tags})\n" \
+            "  end\n\n" \
+            "Appsignal.send_error called on location: #{call_location}"
+        end
+        if namespace
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The namespace argument for `Appsignal.send_error` is deprecated. " \
+            "Please use the block method to set the namespace instead.\n\n" \
+            "  Appsignal.send_error(error) do |transaction|\n" \
+            "    transaction.namespace(#{namespace.inspect})\n" \
+            "  end\n\n" \
+            "Appsignal.send_error called on location: #{call_location}"
+        end
         return unless active?
+
         unless error.is_a?(Exception)
           logger.error "Appsignal.send_error: Cannot send error. The given " \
             "value is not an exception: #{error.inspect}"
@@ -207,7 +236,7 @@ module Appsignal
         end
         transaction = Appsignal::Transaction.new(
           SecureRandom.uuid,
-          namespace,
+          namespace || Appsignal::Transaction::HTTP_REQUEST,
           Appsignal::Transaction::GenericRequest.new({})
         )
         transaction.set_tags(tags) if tags
@@ -244,12 +273,26 @@ module Appsignal
       #     end
       #   end
       #
+      # @example Add more metadata to transaction
+      #   Appsignal.set_error(e) do |transaction|
+      #     transaction.params(:search_query => params[:search_query])
+      #     transaction.set_action("my_action_name")
+      #     transaction.set_tags(:key => "value")
+      #     transaction.set_namespace("my_namespace")
+      #   end
+      #
       # @param exception [Exception] The error to add to the current
       #   transaction.
       # @param tags [Hash{String, Symbol => String, Symbol, Integer}]
       #   Additional tags to add to the error. See also {.tag_request}.
+      #   This parameter is deprecated. Use the block argument instead.
       # @param namespace [String] The namespace in which the error occurred.
       #   See also {.set_namespace}.
+      #   This parameter is deprecated. Use the block argument instead.
+      # @yield [transaction] yields block to allow modification of the
+      #   transaction.
+      # @yieldparam transaction [Transaction] yields the AppSignal transaction
+      #   used to store the error.
       # @return [void]
       #
       # @see Transaction#set_error
@@ -257,6 +300,26 @@ module Appsignal
       #   Exception handling guide
       # @since 0.6.6
       def set_error(exception, tags = nil, namespace = nil)
+        if tags
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The tags argument for `Appsignal.set_error` is deprecated. " \
+            "Please use the block method to set tags instead.\n\n" \
+            "  Appsignal.set_error(error) do |transaction|\n" \
+            "    transaction.set_tags(#{tags})\n" \
+            "  end\n\n" \
+            "Appsignal.set_error called on location: #{call_location}"
+        end
+        if namespace
+          call_location = caller(1..1).first
+          deprecation_message \
+            "The namespace argument for `Appsignal.set_error` is deprecated. " \
+            "Please use the block method to set the namespace instead.\n\n" \
+            "  Appsignal.set_error(error) do |transaction|\n" \
+            "    transaction.namespace(#{namespace.inspect})\n" \
+            "  end\n\n" \
+            "Appsignal.set_error called on location: #{call_location}"
+        end
         unless exception.is_a?(Exception)
           logger.error "Appsignal.set_error: Cannot set error. The given " \
             "value is not an exception: #{exception.inspect}"
@@ -267,6 +330,7 @@ module Appsignal
         transaction.set_error(exception)
         transaction.set_tags(tags) if tags
         transaction.set_namespace(namespace) if namespace
+        yield transaction if block_given?
       end
       alias :set_exception :set_error
       alias :add_exception :set_error

data/lib/appsignal/hooks.rb

@@ -69,6 +69,22 @@ module Appsignal
         text.size > 200 ? "#{text[0...197]}..." : text
       end
     end
+
+    # Alias integration constants that have moved to their own module.
+    def self.const_missing(name)
+      case name
+      when :SidekiqPlugin
+        require "appsignal/integrations/sidekiq"
+        callers = caller
+        Appsignal::Utils::DeprecationMessage.message \
+          "The constant Appsignal::Hooks::SidekiqPlugin has been deprecated. " \
+          "Please update the constant name to Appsignal::Integrations::SidekiqMiddleware " \
+          "in the following file to remove this message.\n#{callers.first}"
+        Appsignal::Integrations::SidekiqMiddleware
+      else
+        super
+      end
+    end
   end
 end
 

data/lib/appsignal/hooks/action_cable.rb

@@ -25,7 +25,11 @@ module Appsignal
       def install_callbacks
         ActionCable::Channel::Base.set_callback :subscribe, :around, :prepend => true do |channel, inner|
           # The request is only the original websocket request
-          env = channel.connection.env
+          connection = channel.connection
+          # #env is not available on the Rails ConnectionStub class used in the
+          # Rails app test suite. If we call `#env` it causes an error to occur
+          # in apps' test suites.
+          env = connection.respond_to?(:env) ? connection.env : {}
           request = ActionDispatch::Request.new(env)
           env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
             request.request_id || SecureRandom.uuid
@@ -53,7 +57,11 @@ module Appsignal
 
         ActionCable::Channel::Base.set_callback :unsubscribe, :around, :prepend => true do |channel, inner|
           # The request is only the original websocket request
-          env = channel.connection.env
+          connection = channel.connection
+          # #env is not available on the Rails ConnectionStub class used in the
+          # Rails app test suite. If we call `#env` it causes an error to occur
+          # in apps' test suites.
+          env = connection.respond_to?(:env) ? connection.env : {}
           request = ActionDispatch::Request.new(env)
           env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
             request.request_id || SecureRandom.uuid

data/lib/appsignal/hooks/sidekiq.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "yaml"
-
 module Appsignal
   class Hooks
     class SidekiqHook < Appsignal::Hooks::Hook
@@ -12,153 +10,22 @@ module Appsignal
       end
 
       def install
+        require "appsignal/integrations/sidekiq"
         Appsignal::Minutely.probes.register :sidekiq, Appsignal::Probes::SidekiqProbe
 
         ::Sidekiq.configure_server do |config|
-          config.server_middleware do |chain|
-            chain.add Appsignal::Hooks::SidekiqPlugin
-          end
-        end
-      end
-    end
-
-    # @api private
-    class SidekiqPlugin # rubocop:disable Metrics/ClassLength
-      include Appsignal::Hooks::Helpers
-
-      EXCLUDED_JOB_KEYS = %w[
-        args backtrace class created_at enqueued_at error_backtrace error_class
-        error_message failed_at jid retried_at retry wrapped
-      ].freeze
-
-      def call(_worker, item, _queue)
-        job_status = nil
-        transaction = Appsignal::Transaction.create(
-          item["jid"],
-          Appsignal::Transaction::BACKGROUND_JOB,
-          Appsignal::Transaction::GenericRequest.new(
-            :queue_start => item["enqueued_at"]
-          )
-        )
-
-        Appsignal.instrument "perform_job.sidekiq" do
-          begin
-            yield
-          rescue Exception => exception # rubocop:disable Lint/RescueException
-            job_status = :failed
-            transaction.set_error(exception)
-            raise exception
-          end
-        end
-      ensure
-        if transaction
-          transaction.set_action_if_nil(formatted_action_name(item))
-
-          params = filtered_arguments(item)
-          transaction.params = params if params
-
-          formatted_metadata(item).each do |key, value|
-            transaction.set_metadata key, value
-          end
-          transaction.set_http_or_background_queue_start
-          Appsignal::Transaction.complete_current!
-          queue = item["queue"] || "unknown"
-          if job_status
-            increment_counter "queue_job_count", 1,
-              :queue => queue,
-              :status => job_status
-          end
-          increment_counter "queue_job_count", 1,
-            :queue => queue,
-            :status => :processed
-        end
-      end
-
-      private
-
-      def increment_counter(key, value, tags = {})
-        Appsignal.increment_counter "sidekiq_#{key}", value, tags
-      end
+          config.error_handlers << \
+            Appsignal::Integrations::SidekiqErrorHandler.new
 
-      def formatted_action_name(job)
-        sidekiq_action_name = parse_action_name(job)
-        return unless sidekiq_action_name
-
-        complete_action = sidekiq_action_name =~ /\.|#/
-        return sidekiq_action_name if complete_action
-
-        "#{sidekiq_action_name}#perform"
-      end
-
-      def filtered_arguments(job)
-        arguments = parse_arguments(job)
-        return unless arguments
-
-        Appsignal::Utils::HashSanitizer.sanitize(
-          arguments,
-          Appsignal.config[:filter_parameters]
-        )
-      end
-
-      def formatted_metadata(item)
-        {}.tap do |hash|
-          (item || {}).each do |key, value|
-            next if EXCLUDED_JOB_KEYS.include?(key)
-
-            hash[key] = truncate(string_or_inspect(value))
-          end
-        end
-      end
-
-      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L316-L334
-      def parse_action_name(job)
-        args = job.fetch("args", [])
-        job_class = job["class"]
-        case job_class
-        when "Sidekiq::Extensions::DelayedModel"
-          safe_load(args[0], job_class) do |target, method, _|
-            "#{target.class}##{method}"
-          end
-        when /\ASidekiq::Extensions::Delayed/
-          safe_load(args[0], job_class) do |target, method, _|
-            "#{target}.#{method}"
-          end
-        else
-          job_class
-        end
-      end
-
-      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L336-L358
-      def parse_arguments(job)
-        args = job.fetch("args", [])
-        case job["class"]
-        when /\ASidekiq::Extensions::Delayed/
-          safe_load(args[0], args) do |_, _, arg|
-            arg
-          end
-        when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
-          nil # Set in the ActiveJob integration
-        else
-          # Sidekiq Enterprise argument encryption.
-          # More information: https://github.com/mperham/sidekiq/wiki/Ent-Encryption
-          if job["encrypt".freeze]
-            # No point in showing 150+ bytes of random garbage
-            args[-1] = "[encrypted data]".freeze
+          config.server_middleware do |chain|
+            if chain.respond_to? :prepend
+              chain.prepend Appsignal::Integrations::SidekiqMiddleware
+            else
+              chain.add Appsignal::Integrations::SidekiqMiddleware
+            end
           end
-          args
         end
       end
-
-      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L403-L412
-      def safe_load(content, default)
-        yield(*YAML.load(content))
-      rescue => error
-        # Sidekiq issue #1761: in dev mode, it's possible to have jobs enqueued
-        # which haven't been loaded into memory yet so the YAML can't be
-        # loaded.
-        Appsignal.logger.warn "Unable to load YAML: #{error.message}"
-        default
-      end
     end
   end
 end