appsignal 2.11.9-java → 3.0.2-java

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+# 3.0.2
+- Fix error on Rails boot when `enable_frontend_error_catching` is `true`.
+  PR #711
+
+# 3.0.1
+- Fix error occurring on APPSIGNAL_DNS_SERVER environment variable option
+  parsing. PR #709
+
+# 3.0.0
+
+Please read our [upgrade from version 2 to 3 guide][upgrade3] before upgrading.
+
+[upgrade3]: https://docs.appsignal.com/ruby/installation/upgrade-from-2-to-3.html
+
+- 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, #686
+- 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

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
@@ -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"
@@ -111,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"
@@ -138,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:
@@ -170,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.
@@ -129,7 +128,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 +220,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 +277,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 +321,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,
@@ -85,8 +81,6 @@ module Appsignal
     ENV_STRING_KEYS = %w[
       APPSIGNAL_APP_NAME
       APPSIGNAL_CA_FILE_PATH
-      APPSIGNAL_DNS_SERVERS
-      APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH
       APPSIGNAL_HOSTNAME
       APPSIGNAL_HTTP_PROXY
       APPSIGNAL_LOG
@@ -102,7 +96,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
@@ -118,6 +111,7 @@ module Appsignal
     ].freeze
     # @api private
     ENV_ARRAY_KEYS = %w[
+      APPSIGNAL_DNS_SERVERS
       APPSIGNAL_FILTER_PARAMETERS
       APPSIGNAL_FILTER_SESSION_DATA
       APPSIGNAL_IGNORE_ACTIONS
@@ -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/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