Install Atatus Ruby APM agent in Grape

Supported Versions

• We currently support all versions of Grape since 1.2.

Installation steps

1. Add the Atatus agent gem to your Gemfile.

   copy

   gem 'atatus'
   

2. Install the Atatus Ruby agent.

   copy

   bundle install
   

   The Ruby bundle install will automatically require Atatus.

3. Create a config/atatus.yml file and add your license key and application name.

   copy

   license_key: 'YOUR_LICENSE_KEY'
   app_name: 'YOUR_RUBY_APP_NAME'
   

   Example:

   config/atatus.yml

   license key: 'lic_apm_1e8c9f02ad421c8ffecd95f6cc12fe22'
   app_name: 'Rails Backend'
   

4. Add middleware to start (and stop) Atatus when booting your app.

   # Example config.ru
   
   require 'grape'
   
   module MyModule
     class API < Grape::API
       use Atatus::Middleware
   
     # ...
     end
   end
   
   Atatus::Grape.start(MyModule::API)
   run MyModule::API
   

5. Restart your Grape ruby server to view your performance data within minutes.