> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AppSignal for Ruby

<Note>
  **New in AppSignal for Ruby 5.0**: AppSignal for Ruby now supports [distributed tracing](/distributed-tracing).

  Distributed tracing is only available when using [collector mode](/ruby/configuration/collector) to send data to the AppSignal hosted collector.

  Collector mode is in beta. Upgrading from 4.x requires no changes unless you enable collector mode.
</Note>

AppSignal supports the [Ruby language][ruby-lang] with a [Ruby gem][appsignal-gem]. The gem supports many frameworks and gems out-of-the-box, but some gems and frameworks might require custom instrumentation.

It's also possible to add custom instrumentation to your application to gain even more insights into the performance of your code.

<h2 id="configuration">
  Configuration
</h2>

In this topic, we'll explain how to configure AppSignal. You'll learn what can be configured in the Ruby gem, what's the minimal configuration needed, and how the configuration is loaded.

See our [configuration](/ruby/configuration) documentation for the complete configuration documentation of the AppSignal gem.

<h2 id="integrations">
  Integrations
</h2>

The AppSignal Ruby gem integrates with many frameworks, including Rails, Sinatra, Padrino, Grape, and more:

* [Action Cable](/ruby/integrations/action-cable)
* [Active Job](/ruby/integrations/active-job)
* [Capistrano](/ruby/integrations/capistrano)
* [DataMapper](/ruby/integrations/datamapper)
* [Delayed::Job](/ruby/integrations/delayed-job)
* [Elasticsearch](/ruby/integrations/elasticsearch)
* [Excon](/ruby/integrations/excon)
* [Faraday](/ruby/integrations/faraday)
* [Garbage Collection](/ruby/integrations/garbage-collection)
* [Global VM Lock](/ruby/integrations/global-vm-lock)
* [Grape](/ruby/integrations/grape)
* [GraphQL](/ruby/integrations/graphql)
* [Hanami](/ruby/integrations/hanami)
* [HTTP.rb](/ruby/integrations/http)
* [MongoDB](/ruby/integrations/mongodb)
* [Multiple Rack libraries](/ruby/integrations/rack-libraries)
* [Net::HTTP](/ruby/integrations/net-http)
* [Padrino](/ruby/integrations/padrino)
* [Puma](/ruby/integrations/puma)
* [Que](/ruby/integrations/que)
* [Rack](/ruby/integrations/rack)
* [Rake](/ruby/integrations/rake)
* [Redis](/ruby/integrations/redis)
* [Resque](/ruby/integrations/resque)
* [ROM](/ruby/integrations/rom)
* [Ruby on Rails](/ruby/integrations/rails)
* [Ruby VM](/ruby/integrations/ruby-vm)
* [Sequel](/ruby/integrations/sequel)
* [Shoryuken](/ruby/integrations/shoryuken)
* [Sidekiq](/ruby/integrations/sidekiq)
* [Solid Queue](/ruby/integrations/solidqueue)
* [Sinatra](/ruby/integrations/sinatra)
* [ViewComponent](/ruby/integrations/view-component)
* [Webmachine](/ruby/integrations/webmachine)

<h2 id="custom-instrumentation">
  Custom instrumentation
</h2>

Add custom instrumentation to your application, or create your own integrations with AppSignal. See the [instrumentation](/ruby/instrumentation) topic for more details.

<h2 id="command-line-tools">
  Command line tools
</h2>

The AppSignal Ruby gem ships with several command line tools. These tools make it easier to install AppSignal in an application, send deploy notifications, and diagnose any problems with the installation.

See our [command line tools](/ruby/command-line) documentation for a full list of all the available commands.

<h2 id="ruby-and-rails-tutorials">
  Ruby and Rails tutorials
</h2>

We publish [Ruby and Rails tutorials](/tutorials) with [GoRails](https://gorails.com). Each tutorial pairs a screencast with a written walkthrough. They cover background jobs, debugging, parameters, authentication, Markdown, and local CI, with links to the related AppSignal features.

<h2 id="ruby-implementation-support">
  Ruby implementation support
</h2>

<h3 id="ruby-mri">
  Ruby (MRI)
</h3>

We currently support [Ruby `2.7.0+` and higher](/support/maintenance-policy).

If you require support for older versions of Ruby, you can use an older version of the AppSignal gem. However, note that we do not provide full support for older versions of the gem. For help upgrading, see [planning an upgrade from an older version](/support/maintenance-policy#planning-an-upgrade-from-an-older-version).

<h3 id="jruby">
  JRuby
</h3>

JRuby support is [available](https://blog.appsignal.com/2018/02/14/ruby-gem-2-5.html) in version `2.5.0` and higher of the AppSignal Ruby gem.

To use JRuby on Alpine Linux, make sure to upgrade to Ruby gem `2.8.0` or newer. Also, check if your [Operating System is supported](/support/operating-systems) in combination with JRuby.

[ruby-lang]: https://www.ruby-lang.org/

[appsignal-gem]: https://rubygems.org/gems/appsignal


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.