APM Insight Ruby on Rails Agent


Applications Manager's 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.

Applications Manager 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 Applications Manager 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 apminsight

    (OR)

  • Download the apminsight.gem file directly from our website or the RubyGems website and run the command gem install apminsight.gem.

Configuration

After installation of the gem:

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

    (OR)

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

A copy of the configuration file apminsight.conf will be available in the <Gem Installed folder>/apminsight/conf/ directory. Configure the class name in the configuration file (include.packages), so that the methods in that class can be instrumented and details will be reported in tracedata.

Open the apminsight.conf file in any text editor and include the following keys:

license.key=[LICENSE KEY]
apm.host=https://[HOST]:[PORT]/

Example:

license.key=APMI_74447444b666d7ab5174cc3021a9b68dd4b3364d50f99c2969360810313e8fac
apm.host=https://app-w8-test:8447/

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 Applications Manager.
  • license.key - The license key displayed in the APM Insight tab of Applications Manager.
  • apm.host - The host URL where Applications Manager is running.
  • apm.port - The HTTPS port of Applications Manager.
  • behind.proxy - The proxy network under which the agent is installed
  • 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 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, go to our Support Portal.