appsignal 2.11.0.beta.4 → 2.11.2

data/gemfiles/webmachine.gemfile

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

data/lib/appsignal.rb

@@ -339,6 +339,7 @@ require "appsignal/auth_check"
 require "appsignal/config"
 require "appsignal/event_formatter"
 require "appsignal/hooks"
+require "appsignal/probes"
 require "appsignal/marker"
 require "appsignal/minutely"
 require "appsignal/garbage_collection_profiler"

data/lib/appsignal/auth_check.rb

@@ -25,8 +25,10 @@ module Appsignal
     def initialize(config, logger = nil)
       @config = config
       if logger # rubocop:disable Style/GuardClause
-        warn "Deprecated: `logger` argument will be removed in the next " \
-          "major version."
+        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
 

data/lib/appsignal/cli/diagnose.rb

@@ -371,7 +371,7 @@ module Appsignal
         end
 
         def print_installation_result_report(report)
-          report = report.fetch("download", {})
+          report = report.fetch("result", {})
           puts "  Installation result"
           puts "    Status: #{report["status"]}"
           puts "    Message: #{report["message"]}" if report["message"]

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

@@ -81,6 +81,50 @@ module Appsignal
       "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APP_REVISION"                             => :revision
     }.freeze
+    # @api private
+    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
+      APPSIGNAL_LOG_PATH
+      APPSIGNAL_PUSH_API_ENDPOINT
+      APPSIGNAL_PUSH_API_KEY
+      APPSIGNAL_WORKING_DIRECTORY_PATH
+      APPSIGNAL_WORKING_DIR_PATH
+      APP_REVISION
+    ].freeze
+    # @api private
+    ENV_BOOLEAN_KEYS = %w[
+      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
+      APPSIGNAL_FILES_WORLD_ACCESSIBLE
+      APPSIGNAL_INSTRUMENT_NET_HTTP
+      APPSIGNAL_INSTRUMENT_REDIS
+      APPSIGNAL_INSTRUMENT_SEQUEL
+      APPSIGNAL_RUNNING_IN_CONTAINER
+      APPSIGNAL_SEND_ENVIRONMENT_METADATA
+      APPSIGNAL_SEND_PARAMS
+      APPSIGNAL_SKIP_SESSION_DATA
+      APPSIGNAL_TRANSACTION_DEBUG_MODE
+    ].freeze
+    # @api private
+    ENV_ARRAY_KEYS = %w[
+      APPSIGNAL_FILTER_PARAMETERS
+      APPSIGNAL_FILTER_SESSION_DATA
+      APPSIGNAL_IGNORE_ACTIONS
+      APPSIGNAL_IGNORE_ERRORS
+      APPSIGNAL_IGNORE_NAMESPACES
+      APPSIGNAL_REQUEST_HEADERS
+    ].freeze
 
     # Mapping of old and deprecated AppSignal configuration keys
     DEPRECATED_CONFIG_KEY_MAPPING = {
@@ -121,8 +165,41 @@ module Appsignal
       :initial_config, :file_config, :env_config
     attr_accessor :logger
 
-    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger)
+    # Initialize a new configuration object for AppSignal.
+    #
+    # If this is manually initialized, and not by {Appsignal.start}, it needs
+    # to be assigned to the {Appsignal.config} attribute.
+    #
+    # @example
+    #   require "appsignal"
+    #   Appsignal.config = Appsignal::Config.new(
+    #     app_path,
+    #     "production"
+    #   )
+    #   Appsignal.start
+    #
+    # @param root_path [String] Root path of the app.
+    # @param env [String] The environment to load when AppSignal is started. It
+    #   will look for an environment with this name in the `config/appsignal.yml`
+    #   config file.
+    # @param initial_config [Hash<String, Object>] The initial configuration to
+    #   use. This will be overwritten by the file config and environment
+    #   variables config.
+    # @param logger [Logger] The logger to use for the AppSignal gem. This is
+    #   used by the configuration class only. Default: {Appsignal.logger}. See
+    #   also {Appsignal.start_logger}.
+    # @param config_file [String] Custom config file location. Default
+    #   `config/appsignal.yml`.
+    #
+    # @see https://docs.appsignal.com/ruby/configuration/
+    #   Configuration documentation
+    # @see https://docs.appsignal.com/ruby/configuration/load-order.html
+    #   Configuration load order
+    # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
+    #   How to integrate AppSignal manually
+    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger, config_file = nil)
       @root_path      = root_path
+      @config_file    = config_file
       @logger         = logger
       @valid          = false
       @config_hash    = Hash[DEFAULT_CONFIG]
@@ -288,7 +365,7 @@ module Appsignal
         " Skipping file config.\n" \
         "File: #{config_file.inspect}\n" \
         "#{e.class.name}: #{e}"
-      $stderr.puts "appsignal: #{message}"
+      Kernel.warn "appsignal: #{message}"
       logger.error "#{message}\n#{e.backtrace.join("\n")}"
       nil
     end
@@ -325,33 +402,21 @@ module Appsignal
       config = {}
 
       # Configuration with string type
-      %w[APPSIGNAL_PUSH_API_KEY APPSIGNAL_APP_NAME APPSIGNAL_PUSH_API_ENDPOINT
-         APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY
-         APPSIGNAL_LOG APPSIGNAL_LOG_PATH APPSIGNAL_WORKING_DIR_PATH
-         APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH APP_REVISION].each do |var|
+      ENV_STRING_KEYS.each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var
       end
 
       # Configuration with boolean type
-      %w[APPSIGNAL_ACTIVE APPSIGNAL_DEBUG APPSIGNAL_INSTRUMENT_NET_HTTP
-         APPSIGNAL_INSTRUMENT_REDIS APPSIGNAL_INSTRUMENT_SEQUEL
-         APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
-         APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION
-         APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS
-         APPSIGNAL_SEND_ENVIRONMENT_METADATA APPSIGNAL_SEND_PARAMS
-         APPSIGNAL_ENABLE_MINUTELY_PROBES APPSIGNAL_FILES_WORLD_ACCESSIBLE
-         APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
+      ENV_BOOLEAN_KEYS.each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?
       end
 
       # Configuration with array of strings type
-      %w[APPSIGNAL_IGNORE_ACTIONS APPSIGNAL_IGNORE_ERRORS
-         APPSIGNAL_IGNORE_NAMESPACES APPSIGNAL_FILTER_PARAMETERS
-         APPSIGNAL_FILTER_SESSION_DATA APPSIGNAL_REQUEST_HEADERS].each do |var|
+      ENV_ARRAY_KEYS.each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")

data/lib/appsignal/extension.rb

@@ -10,11 +10,12 @@ begin
     require "appsignal_extension"
     Appsignal.extension_loaded = true
   end
-rescue LoadError => err
-  Appsignal.logger.error(
-    "Failed to load extension (#{err}), please run `appsignal diagnose` " \
-      "and email us at support@appsignal.com"
-  )
+rescue LoadError => error
+  error_message = "ERROR: AppSignal failed to load extension. " \
+    "Please run `appsignal diagnose` and email us at support@appsignal.com\n" \
+    "#{error.class}: #{error.message}"
+  Appsignal.logger.error(error_message)
+  Kernel.warn error_message
   Appsignal.extension_loaded = false
 end
 

data/lib/appsignal/extension/jruby.rb

@@ -179,11 +179,12 @@ module Appsignal
           :appsignal_string
 
         Appsignal.extension_loaded = true
-      rescue LoadError => err
-        Appsignal.logger.error(
-          "Failed to load extension (#{err}), please email us at " \
-          "support@appsignal.com"
-        )
+      rescue LoadError => error
+        error_message = "ERROR: AppSignal failed to load extension. " \
+          "Please run `appsignal diagnose` and email us at support@appsignal.com\n" \
+          "#{error.class}: #{error.message}"
+        Appsignal.logger.error(error_message)
+        Kernel.warn error_message
         Appsignal.extension_loaded = false
       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,10 +69,34 @@ 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
 
 require "appsignal/hooks/action_cable"
+require "appsignal/hooks/action_mailer"
 require "appsignal/hooks/active_job"
 require "appsignal/hooks/active_support_notifications"
 require "appsignal/hooks/celluloid"

data/lib/appsignal/hooks/action_mailer.rb

@@ -0,0 +1,22 @@
+module Appsignal
+  class Hooks
+    class ActionMailerHook < Appsignal::Hooks::Hook
+      register :action_mailer
+
+      def dependencies_present?
+        defined?(::ActionMailer)
+      end
+
+      def install
+        ActiveSupport::Notifications
+          .subscribe("process.action_mailer") do |_, _, _, _, payload|
+          Appsignal.increment_counter(
+            :action_mailer_process,
+            1,
+            :mailer => payload[:mailer], :action => payload[:action]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/active_job.rb

@@ -41,8 +41,6 @@ module Appsignal
           transaction.set_error(exception)
           raise exception
         ensure
-          tags = ActiveJobHelpers.tags_for_job(job)
-
           if transaction
             transaction.params =
               Appsignal::Utils::HashSanitizer.sanitize(
@@ -50,7 +48,7 @@ module Appsignal
                 Appsignal.config[:filter_parameters]
               )
 
-            transaction_tags = tags.dup
+            transaction_tags = ActiveJobHelpers.transaction_tags_for(job)
             transaction_tags["active_job_id"] = job["job_id"]
             provider_job_id = job["provider_job_id"]
             if provider_job_id
@@ -71,12 +69,15 @@ module Appsignal
             end
           end
 
-          if job_status
-            ActiveJobHelpers.increment_counter "queue_job_count", 1,
-              tags.merge(:status => job_status)
+          metrics = ActiveJobHelpers.metrics_for(job)
+          metrics.each do |(metric_name, tags)|
+            if job_status
+              ActiveJobHelpers.increment_counter metric_name, 1,
+                tags.merge(:status => job_status)
+            end
+            ActiveJobHelpers.increment_counter metric_name, 1,
+              tags.merge(:status => :processed)
           end
-          ActiveJobHelpers.increment_counter "queue_job_count", 1,
-            tags.merge(:status => :processed)
         end
       end
 
@@ -96,7 +97,29 @@ module Appsignal
           end
         end
 
-        def self.tags_for_job(job)
+        # Returns an array of metrics with tags used to report the job metrics
+        #
+        # If job ONLY has a queue, it will return `queue_job_count` with tags.
+        # If job has a queue AND priority, it will ALSO return
+        # `queue_priority_job_count` with tags.
+        #
+        # @return [Array] Array of metrics with tags to report.
+        def self.metrics_for(job)
+          tags = { :queue => job["queue_name"] }
+          metrics = [["queue_job_count", tags]]
+
+          priority = job["priority"]
+          if priority
+            metrics << [
+              "queue_priority_job_count",
+              tags.merge(:priority => priority)
+            ]
+          end
+
+          metrics
+        end
+
+        def self.transaction_tags_for(job)
           tags = {}
           queue = job["queue_name"]
           tags[:queue] = queue if queue

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -23,6 +23,21 @@ module Appsignal
           end
         end
 
+        instrumenter = ::ActiveSupport::Notifications::Instrumenter
+
+        if instrumenter.method_defined?(:start) && instrumenter.method_defined?(:finish)
+          install_start_finish
+        else
+          install_instrument
+        end
+
+        # rubocop:disable Style/GuardClause
+        if instrumenter.method_defined?(:finish_with_state)
+          install_finish_with_state
+        end
+      end
+
+      def install_instrument
         ::ActiveSupport::Notifications::Instrumenter.class_eval do
           alias instrument_without_appsignal instrument
 
@@ -46,6 +61,63 @@ module Appsignal
           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
+      end
     end
   end
 end