appsignal 4.5.17 → 4.6.0

data/lib/appsignal/hooks/redis.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class RedisHook < Appsignal::Hooks::Hook
       register :redis
 

data/lib/appsignal/hooks/redis_client.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class RedisClientHook < Appsignal::Hooks::Hook
       register :redis_client
 

data/lib/appsignal/hooks/resque.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class ResqueHook < Appsignal::Hooks::Hook
       register :resque
 

data/lib/appsignal/hooks/sequel.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     module SequelLogExtension
       # Add query instrumentation
       def log_yield(sql, args = nil)
@@ -19,6 +19,7 @@ module Appsignal
 
     module SequelLogConnectionExtension
       # Add query instrumentation
+      # @!visibility private
       def log_connection_yield(sql, conn, args = nil)
         Appsignal.instrument(
           "sql.sequel",

data/lib/appsignal/hooks/shoryuken.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class ShoryukenHook < Appsignal::Hooks::Hook
       register :shoryuken
 

data/lib/appsignal/hooks/sidekiq.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   class Hooks
+    # @!visibility private
     class SidekiqHook < Appsignal::Hooks::Hook
       register :sidekiq
 

data/lib/appsignal/hooks/unicorn.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class UnicornHook < Appsignal::Hooks::Hook
       register :unicorn
 

data/lib/appsignal/hooks/webmachine.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class WebmachineHook < Appsignal::Hooks::Hook
       register :webmachine
 

data/lib/appsignal/hooks.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Appsignal
-  # @api private
+  # @!visibility private
   class Hooks
     class << self
       def register(name, hook)
@@ -38,8 +38,10 @@ module Appsignal
           @installed = true
         rescue => ex
           logger = Appsignal.internal_logger
-          logger.error("Error while installing #{name} hook: #{ex}")
-          logger.debug ex.backtrace.join("\n")
+          logger.error(
+            "Error while installing #{name} hook: #{ex.class}: #{ex.message}\n" \
+              "#{ex.backtrace.join("\n")}"
+          )
         end
       end
 

data/lib/appsignal/integrations/action_cable.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module ActionCableIntegration
       def perform_action(*args, &block)
         # The request is only the original websocket request

data/lib/appsignal/integrations/active_support_notifications.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module ActiveSupportNotificationsIntegration
       BANG = "!"
 

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     class Capistrano
       def self.tasks(config)
         config.load do

data/lib/appsignal/integrations/data_mapper.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     module DataMapperLogListener
       SQL_CLASSES = [
         "DataObjects::SqlServer::Connection",

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     class DelayedJobPlugin < ::Delayed::Plugin
       extend Appsignal::Hooks::Helpers
 

data/lib/appsignal/integrations/dry_monitor.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module DryMonitorIntegration
       def instrument(event_id, payload = {}, &block)
         Appsignal::Transaction.current.start_event

data/lib/appsignal/integrations/excon.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module ExconIntegration
       def self.instrument(name, data, &block)
         namespace, *event = name.split(".")

data/lib/appsignal/integrations/http.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module HttpIntegration
       def request(verb, uri, opts = {})
         uri_module = defined?(HTTP::URI) ? HTTP::URI : URI

data/lib/appsignal/integrations/mongo_ruby_driver.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   class Hooks
-    # @api private
+    # @!visibility private
     class MongoMonitorSubscriber
       # Called by Mongo::Monitor when query starts
       def started(event)

data/lib/appsignal/integrations/net_http.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module NetHttpIntegration
       def request(request, body = nil, &block)
         Appsignal.instrument(

data/lib/appsignal/integrations/object.rb

@@ -2,7 +2,17 @@
 
 Appsignal::Environment.report_enabled("object_instrumentation") if defined?(Appsignal)
 
+# Extensions to Object for AppSignal method instrumentation.
+#
+# @see https://docs.appsignal.com/ruby/instrumentation/method-instrumentation.html
+#   Method instrumentation documentation.
 class Object
+  # Instruments a class method with AppSignal monitoring.
+  #
+  # @param method_name [Symbol] The name of the class method to instrument.
+  # @param options [Hash<Symbol, String>] Options for instrumentation.
+  # @option options [String] :name Custom event name for the instrumentation.
+  # @return [Symbol]
   # @see https://docs.appsignal.com/ruby/instrumentation/method-instrumentation.html
   #   Method instrumentation documentation.
   def self.appsignal_instrument_class_method(method_name, options = {})
@@ -22,6 +32,12 @@ class Object
     end
   end
 
+  # Instruments an instance method with AppSignal monitoring.
+  #
+  # @param method_name [Symbol] The name of the instance method to instrument.
+  # @param options [Hash<Symbol, String>] Options for instrumentation.
+  # @option options [String] :name Custom event name for the instrumentation.
+  # @return [Symbol]
   # @see https://docs.appsignal.com/ruby/instrumentation/method-instrumentation.html
   #   Method instrumentation documentation.
   def self.appsignal_instrument_method(method_name, options = {})
@@ -37,14 +53,14 @@ class Object
     ruby2_keywords method_name if respond_to?(:ruby2_keywords, true)
   end
 
-  # @api private
+  # @!visibility private
   def self.appsignal_reverse_class_name
     return "AnonymousClass" unless name
 
     name.split("::").reverse.join(".")
   end
 
-  # @api private
+  # @!visibility private
   def appsignal_reverse_class_name
     self.class.appsignal_reverse_class_name
   end

data/lib/appsignal/integrations/ownership.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module OwnershipIntegration
       # Implement the `around_change` logic by monkey-patching the reader,
       # instead of by using the `around_change=` writer. This allows customers

data/lib/appsignal/integrations/puma.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module PumaServer
       def lowlevel_error(error, env, response_status = 500)
         response =

data/lib/appsignal/integrations/que.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module QuePlugin
       def _run(*args)
         transaction =

data/lib/appsignal/integrations/railtie.rb

@@ -7,7 +7,7 @@ require "appsignal/rack/rails_instrumentation"
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     class Railtie < ::Rails::Railtie
       config.appsignal = ActiveSupport::OrderedOptions.new
       config.appsignal.start_at = :on_load
@@ -77,7 +77,7 @@ module Appsignal
 
     # Report errors reported by the Rails error reporter using {Appsignal.report_error}.
     #
-    # @api private
+    # @!visibility private
     class RailsErrorReporterSubscriber
       class << self
         def report(error, handled:, severity:, context: {}, source: nil) # rubocop:disable Lint/UnusedMethodArgument

data/lib/appsignal/integrations/rake.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module RakeIntegration
       IGNORED_ERRORS = [
         # Normal exits from the application we do not need to report
@@ -49,7 +49,7 @@ module Appsignal
       end
     end
 
-    # @api private
+    # @!visibility private
     module RakeIntegrationHelper
       # Register an `at_exit` hook when a task is executed. This will stop
       # AppSignal when _all_ tasks are executed and Rake exits.

data/lib/appsignal/integrations/redis.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module RedisIntegration
       def write(command)
         sanitized_command =

data/lib/appsignal/integrations/redis_client.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module RedisClientIntegration
       def write(command)
         sanitized_command =

data/lib/appsignal/integrations/resque.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module ResqueIntegration
       def perform
         transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
@@ -25,7 +25,7 @@ module Appsignal
       end
     end
 
-    # @api private
+    # @!visibility private
     class ResqueHelpers
       def self.arguments(payload)
         case payload["class"]

data/lib/appsignal/integrations/shoryuken.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     class ShoryukenMiddleware
       def call(worker_instance, queue, sqs_msg, body, &block)
         transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)

data/lib/appsignal/integrations/sidekiq.rb

@@ -11,7 +11,7 @@ module Appsignal
     # about completing the transaction.
     #
     # Introduced in Sidekiq 5.1.
-    # @api private
+    # @!visibility private
     class SidekiqDeathHandler
       def call(_job_context, exception)
         return unless Appsignal.config[:sidekiq_report_errors] == "discard"
@@ -24,7 +24,7 @@ module Appsignal
     # Error handler for Sidekiq to report errors from jobs and internal Sidekiq
     # errors.
     #
-    # @api private
+    # @!visibility private
     class SidekiqErrorHandler
       # Sidekiq 7.1.5 introduced the third sidekiq_config argument. It is not
       # given on older Sidekiq versions.
@@ -49,7 +49,7 @@ module Appsignal
       end
     end
 
-    # @api private
+    # @!visibility private
     class SidekiqMiddleware
       include Appsignal::Hooks::Helpers
 

data/lib/appsignal/integrations/unicorn.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module UnicornIntegration
       # Make sure that appsignal is started and the last transaction
       # in a worker gets flushed.

data/lib/appsignal/integrations/webmachine.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Integrations
-    # @api private
+    # @!visibility private
     module WebmachineIntegration
       def run
         has_parent_transaction = Appsignal::Transaction.current?

data/lib/appsignal/internal_errors.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 module Appsignal
-  # @api private
   class InternalError < StandardError; end
 
-  # @api private
   class NotStartedError < InternalError
+    # @!visibility private
     MESSAGE = <<~MESSAGE
       The AppSignal Ruby gem was not started!
 
       This error was raised by calling `Appsignal.check_if_started!`
     MESSAGE
 
+    # @return [String]
     def message
       MESSAGE
     end

data/lib/appsignal/loaders.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Appsignal
-  # @api private
+  # @!visibility private
   module Loaders
     class << self
       def loaders

data/lib/appsignal/logger.rb

@@ -13,6 +13,8 @@ module Appsignal
     # If called again, it will return the result of the first call.
     # This is useful for ensuring that a block is not executed multiple
     # times when it is broadcasted to multiple loggers.
+    #
+    # @!visibility private
     class BlockOnce
       def initialize(&block)
         @block = block
@@ -44,9 +46,13 @@ module Appsignal
       end
     end
 
+    # @!visibility private
     PLAINTEXT = 0
+    # @!visibility private
     LOGFMT = 1
+    # @!visibility private
     JSON = 2
+    # @!visibility private
     SEVERITY_MAP = {
       DEBUG => 2,
       INFO => 3,
@@ -55,14 +61,17 @@ module Appsignal
       FATAL => 7
     }.freeze
 
+    # Logging severity threshold
+    # @return [Integer]
     attr_reader :level
 
     # Create a new logger instance
     #
-    # @param group Name of the group for this logger.
-    # @param level Minimum log level to report. Log lines below this level will be ignored.
-    # @param format Format to use to parse log line attributes.
-    # @param attributes Default attributes for all log lines.
+    # @param group [String] Name of the group for this logger.
+    # @param level [Integer] Minimum log level to report. Log lines below this
+    #   level will be ignored.
+    # @param format [Integer] Format to use to parse log line attributes.
+    # @param attributes [Hash<String, String>] Default attributes for all log lines.
     # @return [void]
     def initialize(group, level: INFO, format: PLAINTEXT, attributes: {})
       raise TypeError, "group must be a string" unless group.is_a? String
@@ -77,9 +86,9 @@ module Appsignal
       @loggers = []
     end
 
-    # When a formatter is set on the logger (e.g. when wrapping the logger in
-    # `ActiveSupport::TaggedLogging`) we want to set that formatter on all the
-    # loggers that are being broadcasted to.
+    # Sets the formatter for this logger and all broadcasted loggers.
+    # @param formatter [Proc] The formatter to use for log messages.
+    # @return [Proc]
     def formatter=(formatter)
       super
       @loggers.each { |logger| logger.formatter = formatter }
@@ -87,7 +96,7 @@ module Appsignal
 
     # We support the various methods in the Ruby
     # logger class by supplying this method.
-    # @api private
+    # @!visibility private
     def add(severity, message = nil, group = nil, &block) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       # If we do not need to broadcast to any loggers and the severity is
       # below the log level, we can return early.
@@ -142,40 +151,40 @@ module Appsignal
     alias log add
 
     # Log a debug level message
-    # @param message Message to log
-    # @param attributes Attributes to tag the log with
+    # @param message [String] Message to log
+    # @param attributes [Hash<String, Object>] Attributes to tag the log with
     # @return [void]
     def debug(message = nil, attributes = {}, &block)
       add_with_attributes(DEBUG, message, @group, attributes, &block)
     end
 
     # Log an info level message
-    # @param message Message to log
-    # @param attributes Attributes to tag the log with
+    # @param message [String] Message to log
+    # @param attributes [Hash<String, Object>] Attributes to tag the log with
     # @return [void]
     def info(message = nil, attributes = {}, &block)
       add_with_attributes(INFO, message, @group, attributes, &block)
     end
 
     # Log a warn level message
-    # @param message Message to log
-    # @param attributes Attributes to tag the log with
+    # @param message [String] Message to log
+    # @param attributes [Hash<String, Object>] Attributes to tag the log with
     # @return [void]
     def warn(message = nil, attributes = {}, &block)
       add_with_attributes(WARN, message, @group, attributes, &block)
     end
 
     # Log an error level message
-    # @param message Message to log
-    # @param attributes Attributes to tag the log with
+    # @param message [String, Exception] Message to log
+    # @param attributes [Hash<String, Object>] Attributes to tag the log with
     # @return [void]
     def error(message = nil, attributes = {}, &block)
       add_with_attributes(ERROR, message, @group, attributes, &block)
     end
 
     # Log a fatal level message
-    # @param message Message to log
-    # @param attributes Attributes to tag the log with
+    # @param message [String, Exception] Message to log
+    # @param attributes [Hash<String, Object>] Attributes to tag the log with
     # @return [void]
     def fatal(message = nil, attributes = {}, &block)
       add_with_attributes(FATAL, message, @group, attributes, &block)
@@ -185,13 +194,15 @@ module Appsignal
     #
     # Returns the number of characters written.
     #
-    # @param message Message to log
+    # @param message [String] Message to log
     # @return [Integer]
     def <<(message)
       info(message)
       message.length
     end
 
+    # Temporarily silences the logger to a specified level while executing a block.
+    #
     # When using ActiveSupport::TaggedLogging without the broadcast feature,
     # the passed logger is required to respond to the `silence` method.
     #
@@ -199,6 +210,9 @@ module Appsignal
     #
     # - https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger.rb#L60-L76
     # - https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger_silence.rb
+    #
+    # @param severity [Integer] The minimum severity level to log during the block.
+    # @return [Object] The return value of the block.
     def silence(severity = ERROR, &block)
       previous_level = @level
       @level = severity
@@ -209,6 +223,9 @@ module Appsignal
       @silenced = false
     end
 
+    # Adds a logger to broadcast log messages to.
+    # @param logger [Logger] The logger to add to the broadcast list.
+    # @return [Array<Logger>]
     def broadcast_to(logger)
       @loggers << logger
     end

data/lib/appsignal/marker.rb

@@ -20,7 +20,7 @@ module Appsignal
   # @see Appsignal::CLI::NotifyOfDeploy
   # @see https://docs.appsignal.com/appsignal/terminology.html#markers
   #   Terminology: Deploy marker
-  # @api private
+  # @!visibility private
   class Marker
     # Path used on the AppSignal Push API
     # https://push.appsignal.com/1/markers

data/lib/appsignal/probes/gvl.rb

@@ -2,21 +2,22 @@
 
 module Appsignal
   module Probes
+    # @!visibility private
     class GvlProbe
       include Helpers
 
-      # @api private
+      # @!visibility private
       def self.dependencies_present?
         defined?(::GVLTools) && gvltools_0_2_or_newer? && ruby_3_2_or_newer? &&
           !Appsignal::System.jruby?
       end
 
-      # @api private
+      # @!visibility private
       def self.gvltools_0_2_or_newer?
         Gem::Version.new(::GVLTools::VERSION) >= Gem::Version.new("0.2.0")
       end
 
-      # @api private
+      # @!visibility private
       def self.ruby_3_2_or_newer?
         Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.2.0")
       end

data/lib/appsignal/probes/helpers.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Probes
-    # @api private
+    # @!visibility private
     module Helpers
       private