Ruby gem v4.8.0

Added

• Report events from Rails 8.1's Structured Event Reporting (ActiveSupport::EventReporter) as logs.

Fixed

• Fix ActiveSupport::Notifications event instrumentation on Rails 8.1 when no listeners are registered.

View the Ruby gem v4.8.0 changelog for more information.

Improvements to our internal logger

Fixed

• Fix an issue with loggers not supporting a formatter on Rails boot. This will prevent the AppSignal logger config from running into an error if the logger configuration is added to config/application.rb or one of the environments in config/environments/.
• Do not log long (error) messages to the internal AppSignal log. If an error like ActionController::BadRequest occurred and the error message contained the entire file upload, this would grow the appsignal.log file quickly if the error happens often. Internal log messages are now truncated by default.

View the Ruby gem v4.7.5 changelog for more information.

Fix transaction handling in `CodeOwnership` integration

Fixed

• Handle transactions without errors in CodeOwnership integration. AppSignal will not emit an error log line if a transaction has no error.

  Thanks @fatkodima for your contribution!

View the Ruby gem v4.7.4 changelog for more information.

Detect log format automatically and CodeOwnership instrumentation fixes

Changed

• Detect the log format automatically. We now detect if a log line is in the JSON, Logfmt or plaintext formats. No further config needed when calling our logger, like so:

  Shell

  logger = Appsignal::Logger.new("gruop")
  logger.info("message")
  

Fixed

• Handle unowned files in CodeOwnership gem integration. AppSignal will not emit an error log line if no Team can be found for a backtrace.

  Thanks @fatkodima for your contribution!

View the Ruby gem v4.7.3 changelog for more information.

Fix data sampling for jRuby

Fixed

• Fix sample data not being reported for JRuby applications. Data like tags, parameters, session data, etc. would not be set if a transaction was sampled.

View the Ruby gem v4.7.2 changelog for more information.

Support for CodeOwnership gem and fixed Rails version detection

Added

• Add support for the CodeOwnership gem, which allows engineering teams to declare ownership of specific parts of a codebase.

  When an error is reported, the AppSignal gem will tag the transaction with the owner of the file that caused the error.

  This feature is enabled by default. To disable it, set the instrument_code_ownership configuration option to false.

Changed

• Do not patch Rack::Events when using recent Rack versions. When using versions 3.2.1 and above, which contain a fix for the bug where using Rack::Events breaks requests with streaming bodies, use Rack::Events directly, instead of our patched subclass.

Fixed

• Fix Rails version detection when only one of Rails's gems is present.

  This prevents loading errors when non-Rails code defines a Rails constant without the full Rails framework.

View the Ruby gem v4.7.1 changelog for more information.

Support streaming bodies and other improvements

Added

• Add Sidekiq worker-level job status metric: worker_job_count. This new counter metric's status tag will be processed for each job that's processed and reports another counter with the failure status if the job encountered an error.

Fixed

• Support streaming bodies. AppSignal's Rack instrumentation now supports streaming bodies in responses, such as those produced by Async::Cable. This fixes an issue where AppSignal's Rack instrumentation would cause requests with streaming bodies to crash.

  If you use our Rack instrumentation through a framework that is automatically instrumented by AppSignal, such as Rails, Hanami, Padrino or Sinatra, this fix is applied automatically.

  If your application instruments Rack manually, you must remove the following line from your application's initial setup:

  Shell

  use Rack::Events, [Appsignal::Rack::EventHandler.new]
  

  And replace it with the following line:

  Shell

  use Appsignal::Rack::EventMiddleware
  

• Avoid instrumenting Rails when AppSignal is not active. If AppSignal is configured to start when the Rails application loads, rather than after it has initialised, only add Rails' instrumentation middlewares if AppSignal was actually started.

View the Ruby gem v4.7.0 changelog for more information.

Type signatures and improved Capistrano & Hatchbox deploys

Added

• Add Sorbet and RBS type signatures for the gem's public APIs. If your editor supports showing type signatures, they will now show up in for the AppSignal Ruby gem.
• When a deployment tool (Capistrano, Hatchbox.io) provides the REVISION file in the deployed application, AppSignal will now use that to set the revision config.

Changed

• Improve the YARD documentation for public APIs. This will make the documentation clearer and more useful for developers using the Ruby gem. Private APIs have been hidden from the generated output.
• When an error occurs while initializing AppSignal or when running a probe, use the error log level to log the error's backtrace.

Fixed

• When a Hash-like value (such as ActiveSupport::HashWithIndifferentAccess or Sinatra::IndifferentHash) is passed to a transaction helper (such as add_params, add_session_data, ...) it is now converted to a Ruby Hash before setting it as the value or merging it with the existing value. This allows Hash-like objects to be merged, instead of logging a warning and only storing the new value.

  Shell

  # Example scenario
  Appsignal.add_params(:key1 => { :abc => "value" })
  Appsignal.add_params(ActiveSupport::HashWithIndifferentAccess.new(:key2 => { :def => "value" }))
  
  # Params
  {
    :key1 => { :abc => "value" },
    # Keys from HashWithIndifferentAccess are stored as Strings
    "key2" => { "def" => "value" }
  }
  

View the Ruby gem v4.6.0 changelog for more information.

Improve logger and ignore Rack connection errors

Fixed

• When an Appsignal::Logger uses .broadcast_to to broadcast messages to other loggers, broadcast those messages even if the log level of those messages is lower than the logger's threshold. This allows other loggers to set their own logging thresholds.

  When the logger is silenced, messages below the silencing threshold are not broadcasted to other loggers.

• When an Appsignal::Logger uses .broadcast_to to broadcast messages to other loggers, broadcast the original message received by the logger, without formatting it or converting it to a string.

• Call the Appsignal::Logger formatter with the original message object given, rather than converting it to a string before calling the formatter.

• When an error is passed to an Appsignal::Logger as the message, format it regardless of the logging level. Previously it would only be formatted when passed to #error.

• Ignore Errno::ECONNRESET errors in the Rack wrapper.

View the Ruby gem v4.5.17 changelog for more information.

Fix non-canonical rendering event paths for events

Changed

• Log the error's backtrace on extension download failure. This will help us debug issues related to downloading the extension.

Fixed

• Fix non-canonical rendering event paths for Capistrano deployments

View the Ruby gem v4.5.16 changelog for more information.

Add NGINX port configuration option

Added

• Add nginx_port configuration option. This configuration option can be used to customize the port on which the AppSignal integration exposes the NGINX metrics server.

View the Ruby gem v4.5.15 changelog for more information.

Ruby gem v4.5.14

Fixed

• Resolve problems with transactions not being properly closed when using libraries that change Fibers during the transactions. Previously, completed transactions would be attempted to be reused when creating a transaction, when the Fiber would be switched during a transaction.
• Fix a config error log message when the config is not active and should not validate the config.

View the Ruby gem v4.5.14 changelog for more information.

Report Active Job queue time

Added

• Report the Active Job queue time as the active_job_queue_time metric. This metric can be used to track the queue time per Active Job queue.

View the Ruby gem v4.5.12 changelog for more information.

Fix extension installation issue

Fixed

• Fix the C extension function definitions. On install, the Ruby gem extension would print warnings or fail to compile.

View the Ruby gem v4.5.13 changelog for more information.

Log a debug message when ignoring an error

Changed

• Log a debug message when the reported error is ignored by the ignore_errors config option.

View the Ruby gem v4.5.11 changelog for more information.

Remove redundant cron check-in pairs

Changed

• Remove redundant cron check-in pairs. When more than one pair of start and finish cron check-in events is reported for the same identifier in the same period, only one of them will be reported to AppSignal.

View the Ruby gem v4.5.10 changelog for more information.

Handle Fiber changes in web requests better

Fixed

• Ensure request transactions are always closed in the Rack::EventHandler. A problem with Fibers changing during a request would cause transactions transactions to be left open and the data from requests to not be sent to our servers.

View the Ruby gem v4.5.9 changelog for more information.

Improvements for AppSignal shutdown behavior

Added

• Add the enable_at_exit_hook option to configure if Appsignal.stop is called when the Ruby application exits. Calling Appsignal.stop will stop the application for a moment to flush all the data to our agent before shutting down.

  This option has three possible values:

  • always: Always call Appsignal.stop when the program exits. On (Docker) containers it's automatically set to this value.
  • never: Never call Appsignal.stop when the program exits. The default value when the program doesn't run on a (Docker) container.
  • on_error: Call Appsignal.stop when the program exits with an error.

Deprecated

• Deprecate the Appsignal.monitor_and_stop helper.

  We instead recommend using the Appsignal.monitor helper and configuring the enable_at_exit_hook config option to always.

View the Ruby gem v4.5.8 changelog for more information.

Support more logger methods and small changes

Added

• Add the Logger << method. This improves our compatibility with Ruby's Logger class implementation, making it usable in more scenarios.

Changed

• Explicitly return nil from public methods with no usable return value. We want to avoid the situation where Appsignal.start happens to return true and it is thought to mean that the gem started successfully.

  Methods updated:

  • Appsignal.start
  • Appsignal.stop
  • Appsignal.configure
  • Appsignal.forked
  • Appsignal.load

• Differentiate between process_request.rack events. Add the callback that triggered the event in the event title for debugging purposes.

• Improve the log message for the uneven timestack error. This will help the AppSignal team debug issues where events get closed when all events are already closed.

View the Ruby gem v4.5.6 changelog for more information.

Add method to raise error if AppSignal is not started

Added

• Add the Appsignal.config_error and Appsignal.config_error? methods. This method contains any error that may have occurred while loading the config/appsignal.rb file. If it is nil no error occurred or Appsignal.start hasn't been called yet. The Appsignal.config_error? method is an alias for syntax sugar.

• Add the check_if_started! method. This method will raise an error if the AppSignal Ruby gem failed to start.

  Call this method in your CI or on app boot if you wish to verify that AppSignal has started when your application does, and want the application to fail to start if AppSignal hasn't started.

  For example, in this Rails initializer:

  Shell

  # config/initializers/appsignal.rb
  
  Appsignal.check_if_started!
  

View the Ruby gem v4.5.7 changelog for more information.