appsignal 3.4.4 → 3.7.0

data/lib/appsignal/integrations/railtie.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Appsignal.logger.debug("Loading Rails (#{Rails.version}) integration")
+Appsignal.internal_logger.debug("Loading Rails (#{Rails.version}) integration")
 
 require "appsignal/utils/rails_helper"
 require "appsignal/rack/rails_instrumentation"
@@ -36,9 +36,14 @@ module Appsignal
 
         Appsignal.start
 
-        if Appsignal.config[:enable_rails_error_reporter] && Rails.respond_to?(:error) # rubocop:disable Style/GuardClause
-          Rails.error.subscribe(Appsignal::Integrations::RailsErrorReporterSubscriber)
-        end
+        initialize_error_reporter
+      end
+
+      def self.initialize_error_reporter
+        return unless Appsignal.config[:enable_rails_error_reporter]
+        return unless Rails.respond_to?(:error)
+
+        Rails.error.subscribe(Appsignal::Integrations::RailsErrorReporterSubscriber)
       end
     end
 
@@ -55,9 +60,14 @@ module Appsignal
           return unless handled
 
           Appsignal.send_error(error) do |transaction|
-            namespace, action_name, tags = context_for(context.dup)
+            namespace, action_name, path, method, params, tags, custom_data =
+              context_for(context.dup)
             transaction.set_namespace(namespace) if namespace
             transaction.set_action(action_name) if action_name
+            transaction.set_metadata("path", path)
+            transaction.set_metadata("method", method)
+            transaction.params = params
+            transaction.set_sample_data("custom_data", custom_data) if custom_data
 
             tags[:severity] = severity
             tags[:source] = source.to_s if source
@@ -69,14 +79,23 @@ module Appsignal
 
         def context_for(context)
           tags = {}
+          custom_data = nil
 
           appsignal_context = context.delete(:appsignal)
           # Fetch the namespace and action name based on the Rails execution
           # context.
           controller = context.delete(:controller)
+          path = nil
+          method = nil
+          params = nil
           if controller
             namespace = Appsignal::Transaction::HTTP_REQUEST
             action_name = "#{controller.class.name}##{controller.action_name}"
+            unless controller.request.nil?
+              path = controller.request.path
+              method = controller.request.method
+              params = controller.request.filtered_parameters
+            end
           end
           # ActiveJob transaction naming relies on the current AppSignal
           # transaction namespace and action name copying done after this.
@@ -102,10 +121,13 @@ module Appsignal
 
             context_action_name = appsignal_context[:action]
             action_name = context_action_name if context_action_name
+
+            context_custom_data = appsignal_context[:custom_data]
+            custom_data = context_custom_data if context_custom_data
           end
           tags.merge!(context)
 
-          [namespace, action_name, tags]
+          [namespace, action_name, path, method, params, tags, custom_data]
         end
       end
     end

data/lib/appsignal/integrations/redis_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    module RedisClientIntegration
+      def write(command)
+        sanitized_command =
+          if command[0] == :eval
+            "#{command[1]}#{" ?" * (command.size - 3)}"
+          else
+            "#{command[0]}#{" ?" * (command.size - 1)}"
+          end
+
+        Appsignal.instrument "query.redis", @config.id, sanitized_command do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/sidekiq.rb

@@ -9,7 +9,7 @@ module Appsignal
     #
     # @api private
     class SidekiqErrorHandler
-      def call(exception, sidekiq_context)
+      def call(exception, sidekiq_context, _sidekiq_config = nil)
         transaction =
           if Appsignal::Transaction.current?
             Appsignal::Transaction.current
@@ -168,7 +168,7 @@ module Appsignal
         # 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}"
+        Appsignal.internal_logger.warn "Unable to load YAML: #{error.message}"
         default
       end
     end

data/lib/appsignal/integrations/sinatra.rb

@@ -3,7 +3,7 @@
 require "appsignal"
 require "appsignal/rack/sinatra_instrumentation"
 
-Appsignal.logger.debug("Loading Sinatra (#{Sinatra::VERSION}) integration")
+Appsignal.internal_logger.debug("Loading Sinatra (#{Sinatra::VERSION}) integration")
 
 app_settings = ::Sinatra::Application.settings
 Appsignal.config = Appsignal::Config.new(

data/lib/appsignal/logger.rb

@@ -17,6 +17,8 @@ module Appsignal
       FATAL => 7
     }.freeze
 
+    attr_reader :level
+
     # Create a new logger instance
     #
     # @param group Name of the group for this logger.
@@ -62,7 +64,7 @@ module Appsignal
     alias log add
 
     # Log a debug level message
-    # @param message Mesage to log
+    # @param message Message to log
     # @param attributes Attributes to tag the log with
     # @return [void]
     def debug(message = nil, attributes = {})
@@ -75,7 +77,7 @@ module Appsignal
     end
 
     # Log an info level message
-    # @param message Mesage to log
+    # @param message Message to log
     # @param attributes Attributes to tag the log with
     # @return [void]
     def info(message = nil, attributes = {})
@@ -88,7 +90,7 @@ module Appsignal
     end
 
     # Log a warn level message
-    # @param message Mesage to log
+    # @param message Message to log
     # @param attributes Attributes to tag the log with
     # @return [void]
     def warn(message = nil, attributes = {})
@@ -101,7 +103,7 @@ module Appsignal
     end
 
     # Log an error level message
-    # @param message Mesage to log
+    # @param message Message to log
     # @param attributes Attributes to tag the log with
     # @return [void]
     def error(message = nil, attributes = {})
@@ -114,7 +116,7 @@ module Appsignal
     end
 
     # Log a fatal level message
-    # @param message Mesage to log
+    # @param message Message to log
     # @param attributes Attributes to tag the log with
     # @return [void]
     def fatal(message = nil, attributes = {})

data/lib/appsignal/minutely.rb

@@ -108,7 +108,7 @@ module Appsignal
       attr_reader :probes
 
       def logger
-        Appsignal.logger
+        Appsignal.internal_logger
       end
     end
 
@@ -132,7 +132,7 @@ module Appsignal
           sleep initial_wait_time
           initialize_probes
           loop do
-            logger = Appsignal.logger
+            logger = Appsignal.internal_logger
             logger.debug("Gathering minutely metrics with #{probe_instances.count} probes")
             probe_instances.each do |name, probe|
               logger.debug("Gathering minutely metrics with '#{name}' probe")
@@ -181,13 +181,13 @@ module Appsignal
           klass = instance.class
         end
         unless dependencies_present?(klass)
-          Appsignal.logger.debug "Skipping '#{name}' probe, " \
+          Appsignal.internal_logger.debug "Skipping '#{name}' probe, " \
             "#{klass}.dependency_present? returned falsy"
           return
         end
         probe_instances[name] = instance
       rescue => error
-        logger = Appsignal.logger
+        logger = Appsignal.internal_logger
         logger.error "Error while initializing minutely probe '#{name}': #{error}"
         logger.debug error.backtrace.join("\n")
       end

data/lib/appsignal/probes/gvl.rb

@@ -22,7 +22,7 @@ module Appsignal
       end
 
       def initialize(appsignal: Appsignal, gvl_tools: ::GVLTools)
-        Appsignal.logger.debug("Initializing GVL probe")
+        Appsignal.internal_logger.debug("Initializing GVL probe")
         @appsignal = appsignal
         @gvl_tools = gvl_tools
       end

data/lib/appsignal/probes/helpers.rb

@@ -47,7 +47,7 @@ module Appsignal
         # Auto detect hostname as fallback. May be inaccurate.
         @hostname =
           config[:hostname] || Socket.gethostname
-        Appsignal.logger.debug "Probe helper: Using hostname config " \
+        Appsignal.internal_logger.debug "Probe helper: Using hostname config " \
           "option '#{@hostname.inspect}' as hostname"
 
         @hostname

data/lib/appsignal/probes/mri.rb

@@ -11,7 +11,7 @@ module Appsignal
       end
 
       def initialize(appsignal: Appsignal, gc_profiler: Appsignal::GarbageCollection.profiler)
-        Appsignal.logger.debug("Initializing VM probe")
+        Appsignal.internal_logger.debug("Initializing VM probe")
         @appsignal = appsignal
         @gc_profiler = gc_profiler
       end

data/lib/appsignal/probes/sidekiq.rb

@@ -59,7 +59,7 @@ module Appsignal
         @adapter = is_sidekiq7 ? Sidekiq7Adapter : Sidekiq6Adapter
 
         config_string = " with config: #{config}" unless config.empty?
-        Appsignal.logger.debug("Initializing Sidekiq probe#{config_string}")
+        Appsignal.internal_logger.debug("Initializing Sidekiq probe#{config_string}")
         require "sidekiq/api"
       end
 
@@ -78,9 +78,9 @@ module Appsignal
         redis_info = adapter.redis_info
         return unless redis_info
 
-        gauge "connection_count", redis_info.fetch("connected_clients")
-        gauge "memory_usage", redis_info.fetch("used_memory")
-        gauge "memory_usage_rss", redis_info.fetch("used_memory_rss")
+        gauge "connection_count", redis_info["connected_clients"]
+        gauge "memory_usage", redis_info["used_memory"]
+        gauge "memory_usage_rss", redis_info["used_memory_rss"]
       end
 
       def track_stats
@@ -112,6 +112,8 @@ module Appsignal
 
       # Track a gauge metric with the `sidekiq_` prefix
       def gauge(key, value, tags = {})
+        return if value.nil?
+
         tags[:hostname] = hostname if hostname
         Appsignal.set_gauge "sidekiq_#{key}", value, tags
       end
@@ -121,14 +123,14 @@ module Appsignal
 
         if config.key?(:hostname)
           @hostname = config[:hostname]
-          Appsignal.logger.debug "Sidekiq probe: Using hostname config " \
-            "option #{@hostname.inspect} as hostname"
+          Appsignal.internal_logger.debug "Sidekiq probe: Using hostname " \
+            "config option #{@hostname.inspect} as hostname"
           return @hostname
         end
 
         host = adapter.hostname
-        Appsignal.logger.debug "Sidekiq probe: Using Redis server hostname " \
-          "#{host.inspect} as hostname"
+        Appsignal.internal_logger.debug "Sidekiq probe: Using Redis server " \
+          "hostname #{host.inspect} as hostname"
         @hostname = host
       end
     end

data/lib/appsignal/rack/generic_instrumentation.rb

@@ -7,7 +7,7 @@ module Appsignal
   module Rack
     class GenericInstrumentation
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::GenericInstrumentation"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::GenericInstrumentation"
         @app = app
         @options = options
       end

data/lib/appsignal/rack/rails_instrumentation.rb

@@ -7,7 +7,7 @@ module Appsignal
   module Rack
     class RailsInstrumentation
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::RailsInstrumentation"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::RailsInstrumentation"
         @app = app
         @options = options
       end
@@ -43,7 +43,7 @@ module Appsignal
           begin
             transaction.set_metadata("method", request.request_method)
           rescue => error
-            Appsignal.logger.error("Unable to report HTTP request method: '#{error}'")
+            Appsignal.internal_logger.error("Unable to report HTTP request method: '#{error}'")
           end
           Appsignal::Transaction.complete_current!
         end

data/lib/appsignal/rack/sinatra_instrumentation.rb

@@ -15,7 +15,7 @@ module Appsignal
       def initialize(app, options = {})
         @app = app
         @options = options
-        Appsignal.logger.warn "Please remove Appsignal::Rack::SinatraInstrumentation " \
+        Appsignal.internal_logger.warn "Please remove Appsignal::Rack::SinatraInstrumentation " \
           "from your Sinatra::Base class. This is no longer needed."
       end
 
@@ -32,7 +32,7 @@ module Appsignal
       attr_reader :raise_errors_on
 
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::SinatraBaseInstrumentation"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::SinatraBaseInstrumentation"
         @app = app
         @options = options
         @raise_errors_on = raise_errors?(@app)
@@ -47,13 +47,14 @@ module Appsignal
       end
 
       def call_with_appsignal_monitoring(env)
-        env[:params_method] = @options[:params_method] if @options[:params_method]
+        options = { :force => @options.include?(:force) && @options[:force] }
+        options.merge!(:params_method => @options[:params_method]) if @options[:params_method]
         request = @options.fetch(:request_class, Sinatra::Request).new(env)
         transaction = Appsignal::Transaction.create(
           SecureRandom.uuid,
           Appsignal::Transaction::HTTP_REQUEST,
           request,
-          :force => @options.include?(:force) && @options[:force]
+          options
         )
         begin
           Appsignal.instrument("process_action.sinatra") do

data/lib/appsignal/rack/streaming_listener.rb

@@ -7,7 +7,7 @@ module Appsignal
     # @api private
     class StreamingListener
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::StreamingListener"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::StreamingListener"
         @app = app
         @options = options
       end

data/lib/appsignal/span.rb

@@ -16,8 +16,8 @@ module Appsignal
 
     def add_error(error)
       unless error.is_a?(Exception)
-        Appsignal.logger.error "Appsignal::Span#add_error: Cannot add error. " \
-          "The given value is not an exception: #{error.inspect}"
+        Appsignal.internal_logger.error "Appsignal::Span#add_error: Cannot " \
+          "add error. The given value is not an exception: #{error.inspect}"
         return
       end
       return unless error

data/lib/appsignal/transaction.rb

@@ -12,6 +12,7 @@ module Appsignal
     ALLOWED_TAG_KEY_TYPES = [Symbol, String].freeze
     ALLOWED_TAG_VALUE_TYPES = [Symbol, String, Integer].freeze
     BREADCRUMB_LIMIT = 20
+    ERROR_CAUSES_LIMIT = 10
 
     class << self
       def create(id, namespace, request, options = {})
@@ -25,7 +26,7 @@ module Appsignal
             Appsignal::Transaction.new(id, namespace, request, options)
         else
           # Otherwise, log the issue about trying to start another transaction
-          Appsignal.logger.warn_once_then_debug(
+          Appsignal.internal_logger.warn_once_then_debug(
             :transaction_id,
             "Trying to start new transaction with id " \
               "'#{id}', but a transaction with id '#{current.transaction_id}' " \
@@ -58,7 +59,7 @@ module Appsignal
       def complete_current!
         current.complete
       rescue => e
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Failed to complete transaction ##{current.transaction_id}. #{e.message}"
         )
       ensure
@@ -113,7 +114,7 @@ module Appsignal
 
     def complete
       if discarded?
-        Appsignal.logger.debug "Skipping transaction '#{transaction_id}' " \
+        Appsignal.internal_logger.debug "Skipping transaction '#{transaction_id}' " \
           "because it was manually discarded."
         return
       end
@@ -186,6 +187,12 @@ module Appsignal
     # @see https://docs.appsignal.com/ruby/instrumentation/breadcrumbs.html
     #   Breadcrumb reference
     def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
+      unless metadata.is_a? Hash
+        Appsignal.internal_logger.error "add_breadcrumb: Cannot add breadcrumb. " \
+          "The given metadata argument is not a Hash."
+        return
+      end
+
       @breadcrumbs.push(
         :time => time.to_i,
         :category => category,
@@ -280,7 +287,7 @@ module Appsignal
 
       @ext.set_queue_start(start)
     rescue RangeError
-      Appsignal.logger.warn("Queue start value #{start} is too big")
+      Appsignal.internal_logger.warn("Queue start value #{start} is too big")
     end
 
     # Set the queue time based on the HTTP header or `:queue_start` env key
@@ -308,12 +315,20 @@ module Appsignal
 
     def set_metadata(key, value)
       return unless key && value
+      return if Appsignal.config[:filter_metadata].include?(key.to_s)
 
       @ext.set_metadata(key, value)
     end
 
     def set_sample_data(key, data)
-      return unless key && data && (data.is_a?(Array) || data.is_a?(Hash))
+      return unless key && data
+
+      if !data.is_a?(Array) && !data.is_a?(Hash)
+        Appsignal.internal_logger.error(
+          "Invalid sample data for '#{key}'. Value is not an Array or Hash: '#{data.inspect}'"
+        )
+        return
+      end
 
       @ext.set_sample_data(
         key.to_s,
@@ -322,11 +337,11 @@ module Appsignal
     rescue RuntimeError => e
       begin
         inspected_data = data.inspect
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Error generating data (#{e.class}: #{e.message}) for '#{inspected_data}'"
         )
       rescue => e
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Error generating data (#{e.class}: #{e.message}). Can't inspect data."
         )
       end
@@ -337,7 +352,7 @@ module Appsignal
         :params => sanitized_params,
         :environment => sanitized_environment,
         :session_data => sanitized_session_data,
-        :metadata => metadata,
+        :metadata => sanitized_metadata,
         :tags => sanitized_tags,
         :breadcrumbs => breadcrumbs
       }.each do |key, data|
@@ -347,7 +362,7 @@ module Appsignal
 
     def set_error(error)
       unless error.is_a?(Exception)
-        Appsignal.logger.error "Appsignal::Transaction#set_error: Cannot set error. " \
+        Appsignal.internal_logger.error "Appsignal::Transaction#set_error: Cannot set error. " \
           "The given value is not an exception: #{error.inspect}"
         return
       end
@@ -360,6 +375,41 @@ module Appsignal
         cleaned_error_message(error),
         backtrace ? Appsignal::Utils::Data.generate(backtrace) : Appsignal::Extension.data_array_new
       )
+
+      root_cause_missing = false
+
+      causes = []
+      while error
+        error = error.cause
+
+        break unless error
+
+        if causes.length >= ERROR_CAUSES_LIMIT
+          Appsignal.internal_logger.debug "Appsignal::Transaction#set_error: Error has more " \
+            "than #{ERROR_CAUSES_LIMIT} error causes. Only the first #{ERROR_CAUSES_LIMIT} " \
+            "will be reported."
+          root_cause_missing = true
+          break
+        end
+
+        causes << error
+      end
+
+      return if causes.empty?
+
+      causes_sample_data = causes.map do |e|
+        {
+          :name => e.class.name,
+          :message => cleaned_error_message(e)
+        }
+      end
+
+      causes_sample_data.last[:is_root_cause] = false if root_cause_missing
+
+      set_sample_data(
+        "error_causes",
+        causes_sample_data
+      )
     end
     alias_method :add_exception, :set_error
 
@@ -479,7 +529,7 @@ module Appsignal
         request.send options[:params_method]
       rescue => e
         # Getting params from the request has been know to fail.
-        Appsignal.logger.debug "Exception while getting params: #{e}"
+        Appsignal.internal_logger.debug "Exception while getting params: #{e}"
         nil
       end
     end
@@ -522,12 +572,17 @@ module Appsignal
       )
     end
 
-    # Returns metadata from the environment.
+    # Returns sanitized metadata set by {#set_metadata} and from the
+    # {#environment}.
     #
-    # @return [nil] if no `:metadata` key is present in the {#environment}.
     # @return [Hash<String, Object>]
-    def metadata
-      environment[:metadata]
+    def sanitized_metadata
+      metadata = environment[:metadata]
+      return unless metadata
+
+      metadata
+        .transform_keys(&:to_s)
+        .reject { |key, _value| Appsignal.config[:filter_metadata].include?(key) }
     end
 
     # Returns the environment for a transaction.

data/lib/appsignal/utils/deprecation_message.rb

@@ -3,12 +3,12 @@
 module Appsignal
   module Utils
     module DeprecationMessage
-      def self.message(message, logger = Appsignal.logger)
+      def self.message(message, logger = Appsignal.internal_logger)
         Kernel.warn "appsignal WARNING: #{message}"
         logger.warn message
       end
 
-      def deprecation_message(message, logger = Appsignal.logger)
+      def deprecation_message(message, logger = Appsignal.internal_logger)
         Appsignal::Utils::DeprecationMessage.message(message, logger)
       end
     end

data/lib/appsignal/utils/hash_sanitizer.rb

@@ -5,20 +5,21 @@ module Appsignal
     # @api private
     class HashSanitizer
       FILTERED = "[FILTERED]"
+      RECURSIVE = "[RECURSIVE VALUE]"
 
       class << self
         def sanitize(value, filter_keys = [])
-          sanitize_value(value, filter_keys)
+          sanitize_value(value, filter_keys, [])
         end
 
         private
 
-        def sanitize_value(value, filter_keys)
+        def sanitize_value(value, filter_keys, seen)
           case value
           when Hash
-            sanitize_hash(value, filter_keys)
+            sanitize_hash(value, filter_keys, seen)
           when Array
-            sanitize_array(value, filter_keys)
+            sanitize_array(value, filter_keys, seen)
           when TrueClass, FalseClass, NilClass, Integer, String, Symbol, Float
             unmodified(value)
           else
@@ -26,23 +27,34 @@ module Appsignal
           end
         end
 
-        def sanitize_hash(source, filter_keys)
+        def sanitize_hash(source, filter_keys, seen)
+          seen = seen.clone << source.object_id
+
           {}.tap do |hash|
             source.each_pair do |key, value|
               hash[key] =
-                if filter_keys.include?(key.to_s)
+                if seen.include?(value.object_id)
+                  RECURSIVE
+                elsif filter_keys.include?(key.to_s)
                   FILTERED
                 else
-                  sanitize_value(value, filter_keys)
+                  sanitize_value(value, filter_keys, seen)
                 end
             end
           end
         end
 
-        def sanitize_array(source, filter_keys)
+        def sanitize_array(source, filter_keys, seen)
+          seen = seen.clone << source.object_id
+
           [].tap do |array|
             source.each_with_index do |item, index|
-              array[index] = sanitize_value(item, filter_keys)
+              array[index] =
+                if seen.include?(item.object_id)
+                  RECURSIVE
+                else
+                  sanitize_value(item, filter_keys, seen)
+                end
             end
           end
         end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.4.4"
+  VERSION = "3.7.0"
 end