Configuring JBoss monitoring

The Monitoring Agent for JBoss monitors the resources of JBoss application servers and the JBoss Enterprise Application platform. Use the dashboards that are provided with the JBoss agent to identify the slowest applications, slowest requests, thread pool bottlenecks, JVM heap memory and garbage collection issues, busiest sessions, and other bottlenecks on the JBoss application server.

Before you begin

The directions here are for the most current release of the agent, except as indicated. For more information about how to check the version of an agent in your environment, see Agent version command.
Make sure that the system requirements for the JBoss agent are met in your environment. For the up-to-date system requirement information, see the Software Product Compatibility Reports (SPCR) for the JBoss agent.
Before you configure the JBoss agent, the JBoss server first must be configured by completing the following tasks.
1. Enable JMX MBean server connections.
2. Add a JBoss server management user.
3. Enabling Web/HTTP Statistic Collection. This procedure is for JBoss EAP version 7.x and WildFly versions 8.x, 9.x and 10.x.

About this task

The Managed System Name includes the instance name that you specify, for example, instance_name:host_name:pc, where pc is your two character product code. The Managed System Name is limited to 32 characters.

The instance name that you specify is limited to 28 characters minus the length of your host name. For example, if you specify JBoss as your instance name, your managed system name is JBoss:hostname:JE.

Note: If you specify a long instance name, the Managed System name is truncated and the agent code does not display correctly.

The JBoss agent is a multiple-instance agent. You must create an agent instance for each JBoss server you monitor, and start each agent instance manually.

Transaction tracking capability is available for the JBoss agent in the Cloud APM, Advanced offering.

To enable transaction tracking for a new agent instance, complete step 1 or step 2 of this procedure, then follow the procedure to Setup the JBoss agent transaction tracking or diagnostics data collector.
To enable transaction tracking for an agent instance that is already configured for basic monitoring, follow the procedure to Setup the JBoss agent transaction tracking or diagnostics data collector.
To disable transaction tracking for an agent instance, follow the procedure to Disable the JBoss agent transaction tracking data collector.
To uninstall transaction tracking for all agent instances and remove the transaction tracking toolkit, follow the procedure to Uninstall all JBoss agent transaction tracking.

Procedure

Configure the agent on Windows systems by using the IBM Performance Management window or by using the silent response file.
- Configuring the agent on Windows systems.
- Configuring the agent by using the silent response file.
Configure the agent on Linux® systems by running command line script and responding to prompts, or by using the silent response file.
- Configuring the agent by responding to prompts.
- Configuring the agent by using the silent response file.
Optional: Configure transaction tracking by configuring individual agent instances to provide transaction tracking data and configuring your Application Performance Dashboard to display transaction tracking data.
1. Follow the procedure to Setup the JBoss agent transaction tracking or diagnostics data collector.
2. Enable the transaction tracking data in the Application Performance Dashboard for the JBoss agent.
  1. From the navigation bar, click System Configuration > Agent Configuration. The Agent Configuration page is displayed.
  2. Select the JBoss tab.
  3. Select the check boxes for the JBoss server agent instances that you want to monitor and take one of the following actions from the Actions list:
    - To enable transaction tracking, click Set Transaction Tracking > Enabled. The status in the Transaction Tracking column is updated to Enabled.
    - To disable transaction tracking, click Set Transaction Tracking > Disabled. The status in the Transaction Tracking column is updated to Disabled.
3. View the JBoss agent transaction tracking data dashboards by adding the JBoss agent instance to an application in your Application Performance Dashboard.
  For more information about using the Applications editor, see Managing applications.
4. Ensure that user accounts are assigned to a role that includes the Diagnostic Dashboard permission to have access to the following JBoss agent transaction tracking Application Dashboard buttons.
  Otherwise, these buttons are disabled for that user in the Application Dashboard.
  1. The Diagnose drill-down button on the Slowest 5 Response Time widget.
  2. The Inflight Requests button on the Applications widget.
Note: Transaction tracking capability is available for the JBoss agent in the Cloud APM, Advanced offering. For the JBoss agent with basic resource monitoring capability, which is in the Cloud APM, Base offering, skip this step.

What to do next

In the Cloud APM console, go to your Application Performance Dashboard to view the data that was collected. For more information about using the Cloud APM console, see Starting the Cloud APM console.

If you are unable to view the data in the agent dashboards, first check the server connection logs and then the data provider logs. The default paths to these logs are as follows.

/opt/ibm/apm/agent/logs
C:\IBM\APM\TMAITM6_x64\logs

For help with troubleshooting, see the Cloud Application Performance Management Forum.