AppSignal works with most popular Ruby frameworks and gems such as:
- Delayed Job
- Rack / Other
- Ruby on Rails
We try to make most integrations work out-of-the-box, but some might require some manual configuration steps.
It's always possible to integrate AppSignal manually in any system.
For a more detailed examples on how to integrate AppSignal, visit our examples repository.
The AppSignal gem has a few requirements for it to work properly.
The gem needs the following information:
- A Push API key.
- Application details:
- root path
- Middleware that receives instrumentation
You can configure AppSignal with either a
file or using environment variables. For more information, see the
An example application:
1 2 3 4 5 6 7 8 9 10 11 12
require 'appsignal' root_path = File.expand_path('../', __FILE__) # Application root path Appsignal.config = Appsignal::Config.new( root_path, 'development', # Application environment name: 'logbrowser' # Application name ) Appsignal.start_logger # Start logger Appsignal.start # Start the AppSignal agent use Appsignal::Rack::GenericInstrumentation # Listener middleware
By default all actions are grouped under 'unknown'. You can override this for every action by setting the route in the environment.
env['appsignal.route'] = '/homepage'
Want to help us improve this documentation page? Create a pull request