The JBoss agent 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. This
agent is a multiple instance agent; you must create the instance first
and then start the agent manually.
Before you begin
Before you use the JBoss agent to
monitor the JBoss Application Server 5.1 and 6.0, you must enable
the Java™ Management Extensions
(JMX) service on the server. You must also add the following parameter
to the JBOSS_HOME/bin/run.sh script:
"JAVA_OPTS="-Djboss.platform.mbeanserver
$JAVA_OPTS"".
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.
Important: If you specify a long instance name, the Managed
System name is truncated and the agent code does not display correctly.
You
can run the configuration script to create an instance and change
any configuration settings. You can edit the agent silent response
file before you run the script to bypass the prompts and responses
that are required.
Procedure
- To configure the agent by editing the silent response file
and running the script with no interaction, complete the following
steps:
- Open install_dir/samples/jboss_silent_config.txt in
a text editor.
- Enter the following Java parameters:
- Server Name
- The name of the JBoss Application Server. For example, KJE_SERVER=jboss1.
- Java Home
- The path to where Java is
installed. The default path is: JAVA_HOME=/opt/ibm/apm/agent/JRE/lx8266/jre.
- JMX user ID
- The user id to connect to the MBean server.
For example, KQZ_JMX_JSR160_JSR160_USER_ID= Admin.
Note: This
setting is required if JMX authorization is enabled in JBoss.
- JMX Password
- The password to connect to the MBean server.
For example, KQZ_JMX_JSR160_JSR160_PASSWORD = password.
Note: This
setting is required if JMX authorization is enabled in JBoss.
- JMX service URL
- The service URL to connect to the MBean server.
- For JBoss EAP 6, you specify the URL as KQZ_JMX_JSR160_JSR160_SERVICE_URL = service:jmx:remoting-jmx://ip:9999.
- For JBoss AS 5.1 and JBoss AS 6.0, you specify the URL as KQZ_JMX_JSR160_JSR160_SERVICE_URL = service:jmx:rmi://ip/jndi/rmi://ip:1090/jmxconnector.
Important: You must substitute the ip address
provided with the real ip address.
- JMX class path
- For JBoss EAP 6.0 or later, the JAR files that are
searched to find information about a Java class
or Java resource, for example, KQZ_JMX_JSR160_JSR160_JAR_FILES =/opt/EAP-6.3.0/jboss-eap-6.3/bin/client/jboss-cli-client.jar.
Important: For JBoss AS 5.1 and AS 6.0, you must leave this
parameter blank.
- Save and close the jboss_silent_config.txt file,
and enter the following command where instance_name is
the name that you want to give to the instance:
- install_dir/bin/jboss-agent.sh
config instance_name install_dir/samples/
jboss_silent_config.txt
Important: Ensure that you include the absolute path
to the silent response file. Otherwise, agent data is not shown in
the dashboards.
- Enter the following command to start the agent:
- install_dir/bin/jboss-agent.sh
start instance_name
- To configure the agent by
running the script and responding to prompts, complete the following
steps:
- Enter the following command where instance_name is
the name that you want to give to the instance:
install_dir/bin/jboss-agent.sh config instance_name
- Respond to the prompts by using the descriptions of
the parameters that are provided in step 2 of the
To configure
the agent by editing the silent response file and running the script
with no interaction
procedure.
- Enter the following command to start the agent:
install_dir/bin/jboss-agent.sh start instance_name