Configuring Ruby monitoring

You can monitor both on-premises and IBM® Cloud Ruby applications. To monitor on-premises Ruby applications, configure the Ruby agent. To monitor IBM Cloud Ruby applications, configure the Ruby data collector.

About this task

The directions are for the most current release of the agent, except as indicated. For information about how to check the version of an agent in your environment, see Agent version.

The following procedure is a roadmap for configuring the Ruby agent and the Ruby data collector, which includes both required and optional steps. Complete the configuration steps according to your needs.

Procedure

To monitor on-premises Ruby applications, complete the following steps to configure the Ruby agent:
1. Configure agent instances to monitor Ruby applications. See Configuring the Ruby agent to monitor Ruby applications.
2. Install the data collector for monitoring data to display in Cloud APM console. See Installing the data collector.
3. Optional: If you are a Cloud APM, Advanced user, you can complete the following tasks according to your needs:
  - To configure the data collector to collect diagnostics data, see Configuring the diagnostics data collector.
  - To enable method trace for requests and adjust the length for the file path parameter that is displayed in the Request Stack Trace widget, see Enabling method trace and adjusting the path display.
  - To increase the JVM heap size to avoid the out of memory error, see Increasing the JVM heap size.
  - To disable diagnostics, see Disabling or enabling diagnostics data for Ruby applications.
To monitor IBM Cloud Ruby applications, complete the following tasks to configure the Ruby data collector:
1. Configure the Ruby data collector for IBM Cloud applications. For instructions, see Configuring the Ruby data collector for IBM Cloud applications.
2. Optional: To change the behavior of the Ruby data collector, see Customizing the Ruby data collector for IBM Cloud applications.