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.
   gem 'atatus'
   
2. Install the Atatus Ruby agent.
   bundle install
   
   The Ruby bundle install will automatically require Atatus.
3. Config File Structure: The Ruby agent’s atatus.yml is a YAML configuration file comprising a common section followed by environment-specific sections like development, testing, and production. Environment Detection: The agent selects the config section based on environment variables like RUBY_ENV, RAILS_ENV, or RACK_ENV. If none are set, it defaults to the development environment. Failure to indent correctly may result in the agent throwing an error during startup, indicating “Unable to parse configuration file”.
   development:
     license_key: 'YOUR_LICENSE_KEY'
     app_name: "grape app (Development)"
     notify_host: "YOUR_ON_PREMISE_URL"
     analytics_notify_host: "YOUR_ON_PREMISE_URL"
   production:
     license_key: 'YOUR_LICENSE_KEY'
     app_name: "grape app (Production)"
     notify_host: "YOUR_ON_PREMISE_URL"
     analytics_notify_host: "YOUR_ON_PREMISE_URL"
   
   Example: config/atatus.yml
   development:
     license_key: 'lic_apm_******'
     app_name: "grape app (Development)"
     notify_host: "YOUR_ON_PREMISE_URL"
     analytics_notify_host: "YOUR_ON_PREMISE_URL"
   production:
     license_key: 'lic_apm_******'
     app_name: "grape app (Production)"
     notify_host: "YOUR_ON_PREMISE_URL"
     analytics_notify_host: "YOUR_ON_PREMISE_URL"
   
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