appsignal 2.11.5 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a1afbb4368ec09f887494853f55dab5940173a2285d7e185f80aea503c56b66
-  data.tar.gz: 185a18d44f4e082553e0405666723c499752b1e40441c6755fbbc977fb137aea
+  metadata.gz: 936166fae7d72db514778fce44512e528f36cbfa0a94f7c3fe8ea383754c47c2
+  data.tar.gz: cbfeb15ecec3d152c34a1759273de14cabe086a11782d441bd5aae6114fc0ac2
 SHA512:
-  metadata.gz: bb12831c0941b79ddd1598e080cecc355e9277efcc3f77a5c9e167ac832f43c494447d75fc3193525a4a130ba5b3895a48c927c7e7d7ac3591f5511466ab044b
-  data.tar.gz: 4fd833ac978bea386315ed0dec8223f751910b2c4596778d4e16c7f5596cd01e093887a9e3448303429f680e68fac6f4290d1b9e3b05a690a3f8060b13cb85d9
+  metadata.gz: 4b125b9378be2ac1445e94f924dc5fbb70e4f5eb5b886673c6748482988eaa2cb29bef61fe87fd05d7e75954139dd57abf2a5c5605e479e5a6c68893b3739ea8
+  data.tar.gz: 28d5212905fefffdddc077619a8f57d1f92b23bbb4237cb8c28847ce5215e9f2b12790d20c25115d9735f19d1fb4d592699601c476f13398882a9c65a3c187e1

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 1.9
+  TargetRubyVersion: 2.0
   Include:
     - "**/*.cap"
     - "Gemfile"
@@ -80,5 +80,8 @@ Metrics/BlockLength:
 Style/FrozenStringLiteralComment:
   Enabled: true
 
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
 # Metrics/LineLength:
 #   Max: 80

data/.semaphore/semaphore.yml

@@ -79,29 +79,6 @@ blocks:
         value: gemfiles/no_dependencies.gemfile
       commands:
       - "./support/bundler_wrapper exec rubocop"
-- name: Ruby 1.9.3-p551
-  dependencies:
-  - Validation
-  task:
-    prologue:
-      commands:
-      - "./support/bundler_wrapper exec rake extension:install"
-    jobs:
-    - name: Ruby 1.9.3-p551 for no_dependencies
-      env_vars:
-      - name: RUBY_VERSION
-        value: 1.9.3-p551
-      - name: GEMSET
-        value: no_dependencies
-      - name: BUNDLE_GEMFILE
-        value: gemfiles/no_dependencies.gemfile
-      - name: _RUBYGEMS_VERSION
-        value: 2.7.8
-      - name: _BUNDLER_VERSION
-        value: 1.17.3
-      commands:
-      - "./support/bundler_wrapper exec rake test"
-      - "./support/bundler_wrapper exec rake test:failure"
 - name: Ruby 2.0.0-p648
   dependencies:
   - Validation

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# 3.0.0
+- Drop Ruby 1.9 support. PR #683, #682, #688, #694
+- 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
+
 # 2.11.5
 - Add more detailed logging to finish_event calls when the event is unknown, so
   we know what event is being tried to finish. Commit

data/build_matrix.yml

@@ -94,10 +94,6 @@ matrix:
       - "rails-6.0"
 
   ruby:
-    - ruby: "1.9.3-p551"
-      rubygems: "2.7.8"
-      bundler: "1.17.3"
-      gems: "none"
     - ruby: "2.0.0-p648"
       rubygems: "2.7.8"
       bundler: "1.17.3"

data/lib/appsignal.rb

@@ -129,7 +129,6 @@ module Appsignal
           config.write_to_environment
           Appsignal::Extension.start
           Appsignal::Hooks.load_hooks
-          Appsignal::EventFormatter.initialize_deprecated_formatters
           initialize_extensions
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?
@@ -222,15 +221,9 @@ module Appsignal
     # Sets the log level and sets the logger. Uses a file-based logger or the
     # STDOUT-based logger. See the `:log` configuration option.
     #
-    # @param path_arg [nil] Deprecated param. Use the `:log_path`
-    #   configuration option instead.
     # @return [void]
     # @since 0.7.0
-    def start_logger(path_arg = nil)
-      if path_arg
-        logger.info("Setting the path in start_logger has no effect anymore, set it in the config instead")
-      end
-
+    def start_logger
       if config && config[:log] == "file" && config.log_file_path
         start_file_logger(config.log_file_path)
       else
@@ -285,21 +278,6 @@ module Appsignal
       config && config.active? && extension_loaded?
     end
 
-    # @deprecated No replacement
-    def is_ignored_error?(error) # rubocop:disable Naming/PredicateName
-      deprecation_message "Appsignal.is_ignored_error? is deprecated " \
-        "with no replacement and will be removed in version 3.0."
-      Appsignal.config[:ignore_errors].include?(error.class.name)
-    end
-    alias :is_ignored_exception? :is_ignored_error?
-
-    # @deprecated No replacement
-    def is_ignored_action?(action) # rubocop:disable Naming/PredicateName
-      deprecation_message "Appsignal.is_ignored_action? is deprecated " \
-        "with no replacement and will be removed in version 3.0."
-      Appsignal.config[:ignore_actions].include?(action)
-    end
-
     private
 
     def start_stdout_logger
@@ -344,11 +322,7 @@ require "appsignal/marker"
 require "appsignal/minutely"
 require "appsignal/garbage_collection_profiler"
 require "appsignal/integrations/railtie" if defined?(::Rails)
-require "appsignal/integrations/resque"
-require "appsignal/integrations/resque_active_job"
 require "appsignal/transaction"
 require "appsignal/version"
 require "appsignal/rack/generic_instrumentation"
-require "appsignal/rack/js_exception_catcher"
-require "appsignal/js_exception_transaction"
 require "appsignal/transmitter"

data/lib/appsignal/auth_check.rb

@@ -20,16 +20,10 @@ module Appsignal
     # https://push.appsignal.com/1/auth
     ACTION = "auth".freeze
 
-    attr_reader :config, :logger
+    attr_reader :config
 
-    def initialize(config, logger = nil)
+    def initialize(config)
       @config = config
-      if logger # rubocop:disable Style/GuardClause
-        Appsignal::Utils::DeprecationMessage.message \
-          "`Appsignal::AuthCheck.new`'s `logger` argument will be removed " \
-          "in the next major version. Please configure the logger " \
-          "using `Appsignal.logger`."
-      end
     end
 
     # Perform push api validation request and return response status code.

data/lib/appsignal/cli.rb

@@ -7,12 +7,11 @@ require "appsignal/cli/helpers"
 require "appsignal/cli/demo"
 require "appsignal/cli/diagnose"
 require "appsignal/cli/install"
-require "appsignal/cli/notify_of_deploy"
 
 module Appsignal
   # @api private
   class CLI
-    AVAILABLE_COMMANDS = %w[demo diagnose install notify_of_deploy].freeze
+    AVAILABLE_COMMANDS = %w[demo diagnose install].freeze
 
     class << self
       attr_accessor :options
@@ -33,8 +32,6 @@ module Appsignal
               Appsignal::CLI::Diagnose.run(options)
             when :install
               Appsignal::CLI::Install.run(argv.shift, options)
-            when :notify_of_deploy
-              Appsignal::CLI::NotifyOfDeploy.run(options)
             end
           else
             puts "Command '#{command}' does not exist, run appsignal -h to "\
@@ -93,25 +90,6 @@ module Appsignal
             o.on "--[no-]color", "Colorize the output of the diagnose command" do |arg|
               options[:color] = arg
             end
-          end,
-          "notify_of_deploy" => OptionParser.new do |o|
-            o.banner = "Usage: appsignal notify_of_deploy [options]"
-
-            o.on "--revision=<revision>", "The revision you're deploying" do |arg|
-              options[:revision] = arg
-            end
-
-            o.on "--user=<user>", "The name of the user that's deploying" do |arg|
-              options[:user] = arg
-            end
-
-            o.on "--environment=<app_env>", "The environment you're deploying to" do |arg|
-              options[:environment] = arg
-            end
-
-            o.on "--name=<name>", "The name of the app (optional)" do |arg|
-              options[:name] = arg
-            end
           end
         }
       end

data/lib/appsignal/config.rb

@@ -32,8 +32,6 @@ module Appsignal
       :instrument_redis               => true,
       :instrument_sequel              => true,
       :skip_session_data              => false,
-      :enable_frontend_error_catching => false,
-      :frontend_error_catching_path   => "/appsignal_error_catcher",
       :enable_allocation_tracking     => true,
       :enable_gc_instrumentation      => false,
       :enable_host_metrics            => true,
@@ -49,7 +47,6 @@ module Appsignal
       "APPSIGNAL_PUSH_API_KEY"                   => :push_api_key,
       "APPSIGNAL_APP_NAME"                       => :name,
       "APPSIGNAL_PUSH_API_ENDPOINT"              => :endpoint,
-      "APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH"   => :frontend_error_catching_path,
       "APPSIGNAL_DEBUG"                          => :debug,
       "APPSIGNAL_LOG"                            => :log,
       "APPSIGNAL_LOG_PATH"                       => :log_path,
@@ -57,7 +54,6 @@ module Appsignal
       "APPSIGNAL_INSTRUMENT_REDIS"               => :instrument_redis,
       "APPSIGNAL_INSTRUMENT_SEQUEL"              => :instrument_sequel,
       "APPSIGNAL_SKIP_SESSION_DATA"              => :skip_session_data,
-      "APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING" => :enable_frontend_error_catching,
       "APPSIGNAL_IGNORE_ACTIONS"                 => :ignore_actions,
       "APPSIGNAL_IGNORE_ERRORS"                  => :ignore_errors,
       "APPSIGNAL_IGNORE_NAMESPACES"              => :ignore_namespaces,
@@ -86,7 +82,6 @@ module Appsignal
       APPSIGNAL_APP_NAME
       APPSIGNAL_CA_FILE_PATH
       APPSIGNAL_DNS_SERVERS
-      APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH
       APPSIGNAL_HOSTNAME
       APPSIGNAL_HTTP_PROXY
       APPSIGNAL_LOG
@@ -102,7 +97,6 @@ module Appsignal
       APPSIGNAL_ACTIVE
       APPSIGNAL_DEBUG
       APPSIGNAL_ENABLE_ALLOCATION_TRACKING
-      APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
       APPSIGNAL_ENABLE_GC_INSTRUMENTATION
       APPSIGNAL_ENABLE_HOST_METRICS
       APPSIGNAL_ENABLE_MINUTELY_PROBES
@@ -126,12 +120,6 @@ module Appsignal
       APPSIGNAL_REQUEST_HEADERS
     ].freeze
 
-    # Mapping of old and deprecated AppSignal configuration keys
-    DEPRECATED_CONFIG_KEY_MAPPING = {
-      :api_key => :push_api_key,
-      :ignore_exceptions => :ignore_errors
-    }.freeze
-
     # @attribute [r] system_config
     #   Config detected on the system level.
     #   Used in diagnose report.
@@ -376,18 +364,6 @@ module Appsignal
     # Used by {#load_from_disk}. No compatibility for env variables or initial config currently.
     def maintain_backwards_compatibility(configuration)
       configuration.tap do |config|
-        DEPRECATED_CONFIG_KEY_MAPPING.each do |old_key, new_key|
-          old_config_value = config.delete(old_key)
-          next unless old_config_value
-          deprecation_message \
-            "Old configuration key found. Please update the "\
-            "'#{old_key}' to '#{new_key}'.",
-            logger
-
-          next if config[new_key] # Skip if new key is already in use
-          config[new_key] = old_config_value
-        end
-
         if config.include?(:working_dir_path)
           deprecation_message \
             "'working_dir_path' is deprecated, please use " \

data/lib/appsignal/event_formatter.rb

@@ -20,20 +20,11 @@ module Appsignal
         @formatters ||= {}
       end
 
-      def deprecated_formatter_classes
-        @deprecated_formatter_classes ||= {}
-      end
-
       def formatter_classes
         @formatter_classes ||= {}
       end
 
       def register(name, formatter = nil)
-        unless formatter
-          register_deprecated_formatter(name)
-          return
-        end
-
         if registered?(name, formatter)
           logger.warn(
             "Formatter for '#{name}' already registered, not registering "\
@@ -45,12 +36,6 @@ module Appsignal
         initialize_formatter name, formatter
       end
 
-      def initialize_deprecated_formatters
-        deprecated_formatter_classes.each do |name, formatter|
-          register(name, formatter)
-        end
-      end
-
       def unregister(name, formatter = self)
         return unless formatter_classes[name] == formatter
 
@@ -86,16 +71,6 @@ module Appsignal
         logger.error("'#{ex.message}' when initializing #{name} event formatter")
       end
 
-      def register_deprecated_formatter(name)
-        deprecation_message \
-          "Formatter for '#{name}' is using a deprecated registration " \
-          "method. This event formatter will not be loaded. " \
-          "Please update the formatter according to the documentation at: " \
-          "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html"
-
-        EventFormatter.deprecated_formatter_classes[name] = self
-      end
-
       def logger
         Appsignal.logger
       end

data/lib/appsignal/hooks.rb

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

data/lib/appsignal/hooks/action_cable.rb

@@ -14,45 +14,14 @@ module Appsignal
       end
 
       def install
-        patch_perform_action
+        require "appsignal/integrations/action_cable"
+        ActionCable::Channel::Base.send(:prepend, Appsignal::Integrations::ActionCableIntegration)
+
         install_callbacks
       end
 
       private
 
-      def patch_perform_action
-        ActionCable::Channel::Base.class_eval do
-          alias_method :original_perform_action, :perform_action
-
-          def perform_action(*args, &block)
-            # The request is only the original websocket request
-            env = connection.env
-            request = ActionDispatch::Request.new(env)
-            env[Appsignal::Hooks::ActionCableHook::REQUEST_ID] ||=
-              request.request_id || SecureRandom.uuid
-
-            transaction = Appsignal::Transaction.create(
-              env[Appsignal::Hooks::ActionCableHook::REQUEST_ID],
-              Appsignal::Transaction::ACTION_CABLE,
-              request
-            )
-
-            begin
-              original_perform_action(*args, &block)
-            rescue Exception => exception # rubocop:disable Lint/RescueException
-              transaction.set_error(exception)
-              raise exception
-            ensure
-              transaction.params = args.first
-              transaction.set_action_if_nil("#{self.class}##{args.first["action"]}")
-              transaction.set_metadata("path", request.path)
-              transaction.set_metadata("method", "websocket")
-              Appsignal::Transaction.complete_current!
-            end
-          end
-        end
-      end
-
       def install_callbacks
         ActionCable::Channel::Base.set_callback :subscribe, :around, :prepend => true do |channel, inner|
           # The request is only the original websocket request

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -6,8 +6,6 @@ module Appsignal
     class ActiveSupportNotificationsHook < Appsignal::Hooks::Hook
       register :active_support_notifications
 
-      BANG = "!".freeze
-
       def dependencies_present?
         defined?(::ActiveSupport::Notifications::Instrumenter)
       end
@@ -23,100 +21,23 @@ module Appsignal
           end
         end
 
+        require "appsignal/integrations/active_support_notifications"
         instrumenter = ::ActiveSupport::Notifications::Instrumenter
-
+        parent_integration_module = Appsignal::Integrations::ActiveSupportNotificationsIntegration
         if instrumenter.method_defined?(:start) && instrumenter.method_defined?(:finish)
-          install_start_finish
+          install_module(parent_integration_module::StartFinishIntegration)
         else
-          install_instrument
+          install_module(parent_integration_module::InstrumentIntegration)
         end
 
         # rubocop:disable Style/GuardClause
         if instrumenter.method_defined?(:finish_with_state)
-          install_finish_with_state
+          install_module(parent_integration_module::FinishStateIntegration)
         end
       end
 
-      def install_instrument
-        ::ActiveSupport::Notifications::Instrumenter.class_eval do
-          alias instrument_without_appsignal instrument
-
-          def instrument(name, payload = {}, &block)
-            # Events that start with a bang are internal to Rails
-            instrument_this = name[0] != BANG
-
-            Appsignal::Transaction.current.start_event if instrument_this
-
-            instrument_without_appsignal(name, payload, &block)
-          ensure
-            if instrument_this
-              title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-              Appsignal::Transaction.current.finish_event(
-                name.to_s,
-                title,
-                body,
-                body_format
-              )
-            end
-          end
-        end
-      end
-
-      def install_start_finish
-        ::ActiveSupport::Notifications::Instrumenter.class_eval do
-          alias start_without_appsignal start
-
-          def start(name, payload = {})
-            # Events that start with a bang are internal to Rails
-            instrument_this = name[0] != BANG
-
-            Appsignal::Transaction.current.start_event if instrument_this
-
-            start_without_appsignal(name, payload)
-          end
-
-          alias finish_without_appsignal finish
-
-          def finish(name, payload = {})
-            # Events that start with a bang are internal to Rails
-            instrument_this = name[0] != BANG
-
-            if instrument_this
-              title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-              Appsignal::Transaction.current.finish_event(
-                name.to_s,
-                title,
-                body,
-                body_format
-              )
-            end
-
-            finish_without_appsignal(name, payload)
-          end
-        end
-      end
-
-      def install_finish_with_state
-        ::ActiveSupport::Notifications::Instrumenter.class_eval do
-          alias finish_with_state_without_appsignal finish_with_state
-
-          def finish_with_state(listeners_state, name, payload = {})
-            # Events that start with a bang are internal to Rails
-            instrument_this = name[0] != BANG
-
-            if instrument_this
-              title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-              Appsignal::Transaction.current.finish_event(
-                name.to_s,
-                title,
-                body,
-                body_format
-              )
-            end
-
-            finish_with_state_without_appsignal(listeners_state, name, payload)
-          end
-        end
+      def install_module(mod)
+        ::ActiveSupport::Notifications::Instrumenter.send(:prepend, mod)
       end
     end
   end