If you configured the data collector to monitor one or more application server instances,
you can reconfigure the data collector by using the reconfiguration utility
(reconfig.sh or reconfig.bat).
Before you begin
If you will configure the data collector to monitor WebSphere® Application Server Liberty, set the
JAVA_HOME system environment variable to the same JVM as the one used for the
application server. For example, on a Windows system, set
JAVA_HOME value to C:\Program Files\IBM\java. Or on a Linux® system, run export
JAVA_HOME=/opt/IBM/java
.
About this task
Use the following full reconfiguration utility to configure the data collector:
- install_dir\dchome\7.3.0.14.08\bin\reconfig.bat
- install_dir/yndchome/7.3.0.14.08/bin/reconfig.sh
Remember: The
reconfig utility is not applicable in the following
cases. Use the
config configuration utility instead. Although the
config utility warns that the server is already configured, but it still can make
any required changes.
- The data collector is already configured for resource monitoring only and you want to
reconfigure the data collector.
- You want to reconfigure the data collector for WebSphere Portal Server.
Tip: In the prompts asking for agent configuration settings, the reconfiguration utility
offers the currently configured values as defaults.
Procedure
To reconfigure the data collector by responding to prompts, complete these
steps:
-
Log in to the system with the user ID that is used to install the application server.
-
Go to the bin directory within the
dc_home data collector home directory.
-
Start the reconfiguration utility by issuing the following command:
- reconfig.bat
- ./reconfig.sh
Tip: Running this reconfiguration utility has the same effect as running the
config.bat script with the -reconfig argument on Windows systems or the config.sh script
with the -reconfig argument on Linux
or AIX® systems.
The reconfiguration utility displays the IP addresses of all network cards that are
found on the local computer system.
-
Enter the number that corresponds to the IP address to use.
The reconfiguration utility displays all application server instances for which the data
collector is configured on this host, and prompts you to select one or more application server
instances from the list.
-
Select one or more application server instances from the list. Enter the number that
corresponds to the application server instance to reconfigure for data collection or enter an
asterisk (*) to reconfigure all application server instances for data
collection. To specify a subset of servers, enter the numbers, separated by commas, that represent
the servers. For example: 1,2,3.
Remember:
- For a stand-alone environment, application server instances must be running during the
configuration. (A WebSphere Application Server Liberty
instance does not need to be running).
- For a Network Deployment environment, the Deployment Manager must be running.
- Ensure that the application server instances that you select are the actual servers that host
the applications or services that you want to monitor.
-
In the Integration with Agent for WebSphere Applications section,
specify that you want to integrate the data collector with the WebSphere Applications agent. You must enter
1 to select this integration option, and then press Enter.
-
If you are configuring the data collector for traditional WebSphere Application Server, specify whether you want to configure the data collector within the application server instance.
- Enter 1 to configure the data collector within the application
server. With this option, the data collector is integrated with the application server, which is
required for the full range of operational monitoring and diagnostics data collection. However,
configuring the data collector within the application server requires restarting the application
server. Also, the data collector might affect server performance.
- Enter 2 to not to configure the data collector within the application
server and process to Step 9. With this
option, the data collector runs as a stand-alone process and only PMI resource monitoring can be
enabled.
-
When prompted, specify whether to enable diagnostics data collection for the data collector.
Enter 1 for yes, or enter 2 for no.
-
When you are prompted for the host name, enter the host name or IP address of the WebSphere Applications agent or press Enter to accept the default.
The default value corresponds to your choice in Step 4.
-
When you are prompted for the port number, enter the port number of the monitoring agent or
press Enter to accept the default. The default is
63335
.
-
When you are asked whether to configure V6 monitoring agent for WebSphere Applications, press Enter to accept the default for No.
The V6 monitoring agent refers to the ITCAM Agent for WebSphere Applications, which is installed in the old IBM®® Tivoli®® Monitoring infrastructure. Configuring V6 monitoring agent is required only for agent coexistence environment.
-
When you are prompted for the server alias, press Enter to accept the default or enter another
alias. If you are configuring several application server instances, the configuration utility
prompts you for an alias for every instance.
Important: The alias can contain only the following characters:
A-Z
, a-z
, underbar (_
), dash
(-
), and period (.
). Do not use other characters in the
alias.
The server alias is the first qualifier of the agent instance name (also
known as MSN) that is displayed on the Cloud APM console. The default is the node name combined with the server name. For example, the node1server1
alias indicates the server named server1 in the node named node1.
-
When you are prompted for a port number for PMI resource monitoring, press Enter to accept the
default or enter a new number. The default port is
63355
.
This port is used for internal communication between components that are running on the same
host. If the default is in use, you can set a different number.
-
In the Support for transaction tracking section, specify whether to
enable transaction tracking. Enter
1
to enable support for transaction tracking.
Otherwise, enter 2 and skip to Step 17.
-
When you are prompted for host name or IP address of the Transaction Framework Extension,
press Enter to accept the default or enter another host name or IP address.
Transaction Framework Extension is an internal component of the WebSphere Applications agent that gathers metrics from the data
collector.
-
When you are prompted for the port number that the data collector uses to connect to the
Transaction Framework Extension, press Enter to accept the default or enter another port number. The
default is
5457
.
-
Specify whether to integrate the data collector with Application Performance Diagnostics Lite.
Press Enter to accept the default for No.
-
In the Advanced settings section, specify whether to change the garbage
collection log path.
Enter
1 to select a garbage collection log path. Otherwise, enter
2 and skip to Step
20. To
use the log path that is already specified in the JVM argument of the application server, enter
2.
-
Specify the garbage collection log path. Enter a file name with its full
path. For WebSphere Application Server Liberty, do not
use variables in the path. The data collector automatically modifies the log file name, adding the
server instance information to it.
For example, if you specify gc.log as the file name, the actual name is set
to
profile_name.cell_name.node_name.server_name.gc.log
for every configured application server instance.
Important: In the garbage collection log path, you can use WebSphere variables such as ${SERVER_LOG_ROOT}
. However,
do not use templates, such as %pid
.
-
Review the summary of the data collector configuration that is to be applied to the specified
application server instances. Reconfigure parts of the data collector configuration before you apply
the changes, if required.
-
Enter a to accept your changes.
-
When prompted, specify whether you want to create a backup of your current configuration. Enter
1 to create a backup of the current configuration. Otherwise, enter
2.
The configuration utility applies the changes and presents a status message to indicate
that the configuration of the data collector for the profile is completed.
-
If you are configuring the data collector for traditional WebSphere Application Server, restart the application server instances or restart the agent, depending on your choice in Step 7.
- If you have enabled the data collector within the application server, restart the
application server instances as indicated by the configuration utility.
- If you have enabled PMI resource monitoring without enabling the data collector within the
application server, restart the WebSphere Applications agent by running the following commands:
The data collector configuration takes effect after the application server or agent
restart.
What to do next
-
Changing the server alias changes the agent instance name that is registered with
the
Cloud APM console. If you changed the server alias
during the reconfiguration procedure, you must clear some cache files by completing the following
steps:
- Stop the monitoring agent if it is running.
- Open the hostname_yn.xml file in the following directory
with a text editor, where hostname is the name of the host where the WebSphere Applications agent is installed.
- install_dir\TMAITM6_x64 (Default is
C:\IBM\APM\TMAITM6_x64)
- install_dir/config (Default is
/opt/ibm/apm/agent/config)
- Locate the line that starts with the following string and contains the previous server name. For
example, was85.win4net01Cell02.win4net01Node02.AppSrv01.server1, where
server1 is previous name of the application
server.
<!ENTITY was_product_code.cellname.nodename.profilename.servername
where
was_product_code is the product code of WebSphere Application Server; cellname is the name of the cell;
nodename is the node name; profilename is the name of the
application server profile; servername is the previous name of the application
server.
- Locate the .XML file that is indicated in the line within the current
directory and delete the file.
- Remove the line that you located in Step 3 from the
hostname_yn.xml file.
- At the end of the hostname_yn.xml file, remove the line
that contains the previous server names.
- Save and close the file.
- Restart the monitoring agent.