appsignal 2.11.1-java → 3.0.0.beta.1-java

data/ext/base.rb

@@ -119,30 +119,33 @@ def download_archive(type)
 
   version = AGENT_CONFIG["version"]
   filename = ARCH_CONFIG[type]["filename"]
-  attempted_mirror_urls = []
+  download_errors = []
 
   AGENT_CONFIG["mirrors"].each do |mirror|
     download_url = [mirror, version, filename].join("/")
-    attempted_mirror_urls << download_url
     report["download"]["download_url"] = download_url
 
     begin
-      return open(
+      args = [
         download_url,
         :ssl_ca_cert => CA_CERT_PATH,
         :proxy => http_proxy
-      )
-    rescue
+      ]
+      if URI.respond_to?(:open) # rubocop:disable Style/GuardClause
+        return URI.open(*args)
+      else
+        return open(*args)
+      end
+    rescue => error
+      download_errors << "- URL: #{download_url}\n  Error: #{error.class}: #{error.message}"
       next
     end
   end
 
-  attempted_mirror_urls_mapped = attempted_mirror_urls.map { |mirror| "- #{mirror}" }
   abort_installation(
     "Could not download archive from any of our mirrors. " \
-      "Attempted to download the archive from the following urls:\n" \
-      "#{attempted_mirror_urls_mapped.join("\n")}\n" \
-      "Please make sure your network allows access to any of these mirrors."
+      "Please make sure your network allows access to any of these mirrors.\n" \
+      "Attempted to download the archive from the following urls:\n#{download_errors.join("\n")}"
   )
 end
 

data/gemfiles/no_dependencies.gemfile

@@ -2,4 +2,11 @@ source 'https://rubygems.org'
 
 gem 'rack', '~> 1.6'
 
+ruby_version = Gem::Version.new(RUBY_VERSION)
+if ruby_version < Gem::Version.new("2.0.0")
+  # Newer versions of this gem have rexml as a dependency which doesn't work on
+  # Ruby 1.9
+  gem "crack", "0.4.4"
+end
+
 gemspec :path => '../'

data/gemfiles/resque-2.gemfile

@@ -2,7 +2,6 @@ source 'https://rubygems.org'
 
 gem 'resque', "~> 2.0"
 gem 'sinatra'
-gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'
 

data/gemfiles/webmachine.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'webmachine'
+gem 'webrick'
 
 gemspec :path => '../'

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/cli/diagnose/utils.rb

@@ -34,20 +34,17 @@ module Appsignal
         end
 
         def self.parse_yaml(contents)
-          arguments = [contents]
           if YAML.respond_to? :safe_load
-            method = :safe_load
-            arguments << \
-              if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
-                # Use keyword params for Ruby 2.6 and up
-                { :permitted_classes => [Time] }
-              else
-                [Time]
-              end
+            if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
+              # Use keyword params for Ruby 2.6 and up
+              YAML.safe_load(contents, :permitted_classes => [Time])
+            else
+              YAML.safe_load(contents, [Time])
+            end
           else
-            method = :load
+            # Support for Ruby versions without YAML.safe_load
+            YAML.load(contents) # rubocop:disable Security/YAMLLoad
           end
-          YAML.send(method, *arguments)
         end
       end
     end

data/lib/appsignal/cli/install.rb

@@ -278,14 +278,11 @@ module Appsignal
             "../../../resources/appsignal.yml.erb"
           )
           file_contents = File.read(filename)
-          arguments = [file_contents]
-          if ruby_2_6_or_up?
-            arguments << { :trim_mode => "-" }
-          else
-            arguments << nil
-            arguments << "-"
-          end
-          template = ERB.new(*arguments)
+          template = if ruby_2_6_or_up?
+                       ERB.new(file_contents, :trim_mode => "-")
+                     else
+                       ERB.new(file_contents, nil, "-")
+                     end
           config = template.result(OpenStruct.new(data).instance_eval { binding })
 
           FileUtils.mkdir_p(File.join(Dir.pwd, "config"))

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/helpers/instrumentation.rb

@@ -380,6 +380,38 @@ module Appsignal
       end
       alias :tag_job :tag_request
 
+      # Add breadcrumbs to the transaction.
+      #
+      # Breadcrumbs can be used to trace what path a user has taken
+      # before encounterin an error.
+      #
+      # Only the last 20 added breadcrumbs will be saved.
+      #
+      # @example
+      #   Appsignal.add_breadcrumb("Navigation", "http://blablabla.com", "", { :response => 200 }, Time.now.utc)
+      #   Appsignal.add_breadcrumb("Network", "[GET] http://blablabla.com", "", { :response => 500 })
+      #   Appsignal.add_breadcrumb("UI", "closed modal(change_password)", "User closed modal without actions")
+      #
+      # @param category [String] category of breadcrumb
+      #   e.g. "UI", "Network", "Navigation", "Console".
+      # @param action [String] name of breadcrumb
+      #   e.g "The user clicked a button", "HTTP 500 from http://blablabla.com"
+      # @option message [String]  optional message in string format
+      # @option metadata [Hash<String,String>]  key/value metadata in <string, string> format
+      # @option time [Time] time of breadcrumb, should respond to `.to_i` defaults to `Time.now.utc`
+      # @return [void]
+      #
+      # @see Transaction#add_breadcrumb
+      # @see http://docs.appsignal.com/ruby/instrumentation/breadcrumbs.html
+      #   Breadcrumb reference
+      # @since 2.12.0
+      def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
+        return unless active?
+        transaction = Appsignal::Transaction.current
+        return false unless transaction
+        transaction.add_breadcrumb(category, action, message, metadata, time)
+      end
+
       # Instrument helper for AppSignal.
       #
       # For more help, read our custom instrumentation guide, listed under "See

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