appsignal 3.4.13 → 3.6.1

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)
@@ -42,7 +42,9 @@ module Appsignal
         if Appsignal.active?
           call_with_appsignal_monitoring(env)
         else
-          @app.call(env)
+          nil_transaction = Appsignal::Transaction::NilTransaction.new
+          status, headers, obody = @app.call(env)
+          [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, nil_transaction)]
         end
       end
 
@@ -56,12 +58,19 @@ module Appsignal
           request,
           options
         )
+        # We need to complete the transaction if there is an exception exception inside the `call`
+        # of the app. If there isn't one and the app returns us a Rack response triplet, we let
+        # the BodyWrapper complete the transaction when #close gets called on it
+        # (guaranteed by the webserver)
+        complete_transaction_without_body = false
         begin
           Appsignal.instrument("process_action.sinatra") do
-            @app.call(env)
+            status, headers, obody = @app.call(env)
+            [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, transaction)]
           end
         rescue Exception => error # rubocop:disable Lint/RescueException
           transaction.set_error(error)
+          complete_transaction_without_body = true
           raise error
         ensure
           # If raise_error is off versions of Sinatra don't raise errors, but store
@@ -73,7 +82,10 @@ module Appsignal
           transaction.set_metadata("path", request.path)
           transaction.set_metadata("method", request.request_method)
           transaction.set_http_or_background_queue_start
-          Appsignal::Transaction.complete_current!
+
+          # Transaction gets completed when the body gets read out, except in cases when
+          # the app failed before returning us the Rack response triplet.
+          Appsignal::Transaction.complete_current! if complete_transaction_without_body
         end
       end
 

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
@@ -16,7 +16,9 @@ module Appsignal
         if Appsignal.active?
           call_with_appsignal_monitoring(env)
         else
-          @app.call(env)
+          nil_transaction = Appsignal::Transaction::NilTransaction.new
+          status, headers, obody = @app.call(env)
+          [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, nil_transaction)]
         end
       end
 
@@ -28,46 +30,35 @@ module Appsignal
           request
         )
 
+        # We need to complete the transaction if there is an exception exception inside the `call`
+        # of the app. If there isn't one and the app returns us a Rack response triplet, we let
+        # the BodyWrapper complete the transaction when #close gets called on it
+        # (guaranteed by the webserver)
+        complete_transaction_without_body = false
+
         # Instrument a `process_action`, to set params/action name
-        status, headers, body =
+        begin
           Appsignal.instrument("process_action.rack") do
-            @app.call(env)
-          rescue Exception => e # rubocop:disable Lint/RescueException
-            transaction.set_error(e)
-            raise e
-          ensure
-            transaction.set_action_if_nil(env["appsignal.action"])
-            transaction.set_metadata("path", request.path)
-            transaction.set_metadata("method", request.request_method)
-            transaction.set_http_or_background_queue_start
+            status, headers, obody = @app.call(env)
+            [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, transaction)]
           end
+        rescue Exception => error # rubocop:disable Lint/RescueException
+          transaction.set_error(error)
+          complete_transaction_without_body = true
+          raise error
+        ensure
+          transaction.set_action_if_nil(env["appsignal.action"])
+          transaction.set_metadata("path", request.path)
+          transaction.set_metadata("method", request.request_method)
+          transaction.set_http_or_background_queue_start
 
-        # Wrap the result body with our StreamWrapper
-        [status, headers, StreamWrapper.new(body, transaction)]
+          # Transaction gets completed when the body gets read out, except in cases when
+          # the app failed before returning us the Rack response triplet.
+          Appsignal::Transaction.complete_current! if complete_transaction_without_body
+        end
       end
     end
   end
 
-  class StreamWrapper
-    def initialize(stream, transaction)
-      @stream = stream
-      @transaction = transaction
-    end
-
-    def each(&block)
-      @stream.each(&block)
-    rescue Exception => e # rubocop:disable Lint/RescueException
-      @transaction.set_error(e)
-      raise e
-    end
-
-    def close
-      @stream.close if @stream.respond_to?(:close)
-    rescue Exception => e # rubocop:disable Lint/RescueException
-      @transaction.set_error(e)
-      raise e
-    ensure
-      Appsignal::Transaction.complete_current!
-    end
-  end
+  StreamWrapper = Rack::EnumerableBodyWrapper
 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
@@ -187,7 +188,7 @@ module Appsignal
     #   Breadcrumb reference
     def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
       unless metadata.is_a? Hash
-        Appsignal.logger.error "add_breadcrumb: Cannot add breadcrumb. " \
+        Appsignal.internal_logger.error "add_breadcrumb: Cannot add breadcrumb. " \
           "The given metadata argument is not a Hash."
         return
       end
@@ -286,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
@@ -323,7 +324,7 @@ module Appsignal
       return unless key && data
 
       if !data.is_a?(Array) && !data.is_a?(Hash)
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Invalid sample data for '#{key}'. Value is not an Array or Hash: '#{data.inspect}'"
         )
         return
@@ -336,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
@@ -361,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
@@ -374,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
 
@@ -493,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

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/version.rb

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

data/lib/appsignal.rb

@@ -46,7 +46,11 @@ module Appsignal
     # @see extension_loaded?
     attr_accessor :extension_loaded
     # @!attribute [rw] logger
-    #   Accessor for the AppSignal logger.
+    #   Accessor for the internal AppSignal logger.
+    #
+    #   Not to be confused with our logging feature.
+    #   This is part of our private internal API. Do not call this method
+    #   directly.
     #
     #   If no logger has been set, it will return a "in memory logger", using
     #   `in_memory_log`. Once AppSignal is started (using {.start}) the
@@ -57,7 +61,7 @@ module Appsignal
     #   @api private
     #   @return [Logger]
     #   @see start_logger
-    attr_writer :logger
+    attr_writer :internal_logger
 
     # @api private
     def testing?
@@ -91,11 +95,11 @@ module Appsignal
     # @since 0.7.0
     def start
       unless extension_loaded?
-        logger.info("Not starting appsignal, extension is not loaded")
+        internal_logger.info("Not starting appsignal, extension is not loaded")
         return
       end
 
-      logger.debug("Starting appsignal")
+      internal_logger.debug("Starting appsignal")
 
       @config ||= Config.new(
         Dir.pwd,
@@ -103,9 +107,9 @@ module Appsignal
       )
 
       if config.valid?
-        logger.level = config.log_level
+        internal_logger.level = config.log_level
         if config.active?
-          logger.info "Starting AppSignal #{Appsignal::VERSION} " \
+          internal_logger.info "Starting AppSignal #{Appsignal::VERSION} " \
             "(#{$PROGRAM_NAME}, Ruby #{RUBY_VERSION}, #{RUBY_PLATFORM})"
           config.write_to_environment
           Appsignal::Extension.start
@@ -120,10 +124,10 @@ module Appsignal
 
           collect_environment_metadata
         else
-          logger.info("Not starting, not active for #{config.env}")
+          internal_logger.info("Not starting, not active for #{config.env}")
         end
       else
-        logger.error("Not starting, no valid config for this environment")
+        internal_logger.error("Not starting, no valid config for this environment")
       end
     end
 
@@ -143,9 +147,9 @@ module Appsignal
     # @since 1.0.0
     def stop(called_by = nil)
       if called_by
-        logger.debug("Stopping appsignal (#{called_by})")
+        internal_logger.debug("Stopping appsignal (#{called_by})")
       else
-        logger.debug("Stopping appsignal")
+        internal_logger.debug("Stopping appsignal")
       end
       Appsignal::Extension.stop
     end
@@ -154,7 +158,7 @@ module Appsignal
       return unless active?
 
       Appsignal.start_logger
-      logger.debug("Forked process, resubscribing and restarting extension")
+      internal_logger.debug("Forked process, resubscribing and restarting extension")
       Appsignal::Extension.start
     end
 
@@ -162,7 +166,8 @@ module Appsignal
       Appsignal::Extension.get_server_state(key)
     end
 
-    # In memory logger used before any logger is started with {.start_logger}.
+    # In memory internal logger used before any internal logger is started with
+    # {.start_logger}.
     #
     # The contents of this logger are flushed to the logger in {.start_logger}.
     #
@@ -176,11 +181,12 @@ module Appsignal
       end
     end
 
-    def logger
-      @logger ||= Appsignal::Utils::IntegrationLogger.new(in_memory_log).tap do |l|
-        l.level = ::Logger::INFO
-        l.formatter = log_formatter("appsignal")
-      end
+    def internal_logger
+      @internal_logger ||=
+        Appsignal::Utils::IntegrationLogger.new(in_memory_log).tap do |l|
+          l.level = ::Logger::INFO
+          l.formatter = log_formatter("appsignal")
+        end
     end
 
     # @api private
@@ -192,7 +198,7 @@ module Appsignal
       end
     end
 
-    # Start the AppSignal logger.
+    # Start the AppSignal internal logger.
     #
     # Sets the log level and sets the logger. Uses a file-based logger or the
     # STDOUT-based logger. See the `:log` configuration option.
@@ -201,18 +207,18 @@ module Appsignal
     # @since 0.7.0
     def start_logger
       if config && config[:log] == "file" && config.log_file_path
-        start_file_logger(config.log_file_path)
+        start_internal_file_logger(config.log_file_path)
       else
-        start_stdout_logger
+        start_internal_stdout_logger
       end
 
-      logger.level =
+      internal_logger.level =
         if config
           config.log_level
         else
           Appsignal::Config::DEFAULT_LOG_LEVEL
         end
-      logger << @in_memory_log.string if @in_memory_log
+      internal_logger << @in_memory_log.string if @in_memory_log
     end
 
     # Returns if the C-extension was loaded properly.
@@ -255,18 +261,18 @@ module Appsignal
 
     private
 
-    def start_stdout_logger
-      @logger = Appsignal::Utils::IntegrationLogger.new($stdout)
-      logger.formatter = log_formatter("appsignal")
+    def start_internal_stdout_logger
+      @internal_logger = Appsignal::Utils::IntegrationLogger.new($stdout)
+      internal_logger.formatter = log_formatter("appsignal")
     end
 
-    def start_file_logger(path)
-      @logger = Appsignal::Utils::IntegrationLogger.new(path)
-      logger.formatter = log_formatter
+    def start_internal_file_logger(path)
+      @internal_logger = Appsignal::Utils::IntegrationLogger.new(path)
+      internal_logger.formatter = log_formatter
     rescue SystemCallError => error
-      start_stdout_logger
-      logger.warn "Unable to start logger with log path '#{path}'."
-      logger.warn error
+      start_internal_stdout_logger
+      internal_logger.warn "Unable to start internal logger with log path '#{path}'."
+      internal_logger.warn error
     end
 
     def collect_environment_metadata
@@ -299,5 +305,6 @@ require "appsignal/garbage_collection"
 require "appsignal/integrations/railtie" if defined?(::Rails)
 require "appsignal/transaction"
 require "appsignal/version"
+require "appsignal/rack/body_wrapper"
 require "appsignal/rack/generic_instrumentation"
 require "appsignal/transmitter"