APM Insight Ruby on Rails Agent

Site24x7 APM Insight Ruby agent deployed on a Rails platform gives you end-to-end web-transaction awareness enabling you to isolate performance issues and resolve them quickly.

Site24x7 requires a monitoring agent (ruby gem) to be deployed in your application server to monitor Ruby application performance. Download the latest Ruby Agent and deploy it in your application server. The agent collects application performance metrics and sends it to the central Site24x7 server at fixed intervals i.e. every 60 seconds.

 

Installing APM Insight Ruby on Rails Agent

Ruby Agent installation can be done in two ways:

• Install from RubyGems by using the following command in the system where Ruby is installed : gem install site24x7_apminsight

  OR

• Download the site24x7_apminsight.gem file from your user account in Site24x7 after sign in or from the RubyGem website and run the command gem install site24x7_apminsight.gem.

Configuration

After installation of the gem:

• For each of your applications, add the following line to the application gemfile:

  gem 'site24x7_apminsight'

   OR 

• For each of your applications, add the following line to the application initializer block:

  require 'site24x7_apminsight'
  

A copy of the configuration file apminsight.conf will be available in the <Gem Installed folder> /site24x7_apminsight/conf/. Copy the file into your application home 

The following configuration options are mandatory and should be provided for the agent to be initialized:

• application.name - The application's name to be displayed in Site24x7.

• license.key - license api key from Site24x7 APM Insight home page after successful login
  

• agent.server.port - The HTTP listening port of the Application Server.

More configuration options of APM Insight Ruby Agent can be found here.

 

Note:
To check if the agent is installed correctly, use the command gem list. This command will list all the installed gem in the machine. Check if the site24x7_apminsight gem file is included in the list.

 

Supported Environments :

• Ruby - 1.8.7 and higher

• Rails - 3.0 and higher

Troubleshooting:

For troubleshooting tips, refer this page.