Manually configure the data collector if the configuration utilities fail

If you cannot use the provided configuration utility to configure the data collector for WebSphere® Applications agent, you can manually configure the data collector in the WebSphere Administrative Console.

Before you begin

  • Install the WebSphere Applications agent.
  • Get to know the data collector home directory, which is required by the data collector configuration. The default is /opt/ibm/apm/agent/yndchome/7.3.0.14.08 on Linux® and UNIX systems or C:\IBM\APM\dchome\7.3.0.14.08 on Windows systems.
  • If you want to configure the data collector for a Liberty server, get to know the Liberty server home directory. For example, /opt/ibm/was/liberty/usr/servers/defaultServer.
  • Make sure that a file named itcam_wsBundleMetaData.xml exists in the dc_home/runtime/wsBundleMetaData folder and it contains the following content. If the folder or the file does not exist, manually create it.
    Remember: The plugins_dir_within_dc_home value must be set to the absolute path of the plugins folder within the data collector home directory. The default is /opt/ibm/apm/agent/yndchome/7.3.0.14.08/plugins on Linux and UNIX systems or C:\IBM\APM\dchome\7.3.0.14.08\plugins on Windows systems.
    <bundles>
  <directory path="plugins_dir_within_dc_home">
      <bundle>com.ibm.tivoli.itcam.bundlemanager_7.2.0.jar</bundle>
  </directory>
  <directory path="plugins_dir_within_dc_home">
      <bundle>com.ibm.tivoli.itcam.classicsca_7.2.0.jar</bundle>
  </directory>
  <directory path="plugins_dir_within_dc_home">
      <bundle>com.ibm.tivoli.itcam.toolkitsca.classicsca_7.2.0.jar</bundle>
  </directory>
</bundles>

About this task

Important:
  • You must make manual changes to the WebSphere Application Server configuration for data collectors as the WebSphere administrative user.
  • You must be an experienced WebSphere administrator to make manual changes to the WebSphere Application Server for data collection. Any error in the manual configuration change can result in the application server not starting.
  • After you manually configure the data collector to monitor application server instances, you cannot use the unconfiguration utility to unconfigure the data collector. You must manually unconfigure the data collector instead.

Procedure

Manually configuring data collector for WebSphere Application Server traditional

Procedure

  1. Log in to the WebSphere Administrative Console as the administrator.
  2. In the navigation pane, click Servers, expand Server Types and click WebSphere application servers.
  3. Under the Server Infrastructure section in the Configuration tab, expand Java and Process Management and click Process Definition.
  4. Under the Additional Properties section, click Java Virtual Machine.
  5. In the Generic JVM arguments field, add the following entries. 
    -agentlib:am_ibm_16=${WAS_SERVER_NAME} -Xbootclasspath/p:${ITCAMDCHOME}/toolkit/lib/bcm-bootstrap.jar -Djava.security.policy=${ITCAMDCHOME}/itcamdc/etc/datacollector.policy -verbosegc

    When you add the entries, take note of the following:

    • All entries must be on a single line.
    • Separate different arguments by spaces before the minus sign (-), and do not use spaces anywhere else.
  6. Click Apply and then save the changes to the master configuration.
    • If you are not under a Network Deployment environment, click Save.
    • If you are under a Network Deployment environment, ensure that Synchronize changes with Nodes is selected in the Console preferencesoptions and then click Save.
  7. In the navigation pane, click Servers, expand Server Types, click WebSphere application servers and then click the server name.
  8. In the Configuration tab, go to Server Infrastructure > Java and Process Management > Process Definition > Environment Entries.
  9. Depending on the operating system, the hardware platform, and the application server JVM, set the following environment entry.
    Table 1. Environment entry
    Platform Environment entry name Environment entry value
    AIX® R6.1 (64-bit JVM) LIBPATH /lib:${ITCAMDCHOME}/toolkit/lib/aix536
    AIX R7.1 (64-bit JVM) LIBPATH /lib:${ITCAMDCHOME}/toolkit/lib/aix536
    Solaris 10 (64-bit JVM) LIBPATH /lib:${ITCAMDCHOME}/toolkit/lib/sol296
    Solaris 11 (64-bit JVM) LIBPATH /lib:${ITCAMDCHOME}/toolkit/lib/sol296
    Linux Intel R2.6 (32-bit JVM) LD_LIBRARY_PATH /lib:${ITCAMDCHOME}/toolkit/lib/li6263
    Linux x86_64 R2.6 (64-bit JVM) LD_LIBRARY_PATH /lib:${ITCAMDCHOME}/toolkit/lib/lx8266
    Linux on Power® Little Endian (64-bit JVM) LD_LIBRARY_PATH /lib:${ITCAMDCHOME}/toolkit/lib/lpl266
    Linux on System z® (32-bit JVM) LD_LIBRARY_PATH /lib:${ITCAMDCHOME}/toolkit/lib/ls3263
    Linux on System z (64-bit JVM) LD_LIBRARY_PATH /lib:${ITCAMDCHOME}/toolkit/lib/ls3266
    Windows (32-bit JVM) PATH /lib;${ITCAMDCHOME}/toolkit/lib/win32
    Windows (64-bit JVM) PATH /lib;${ITCAMDCHOME}/toolkit/lib/win64
  10. Click Apply and then save the changes to the master configuration.
    • If you are not under a Network Deployment environment, click Save.
    • If you are under a Network Deployment environment, ensure that Synchronize changes with Nodes is selected in the Console preferencesoptions and then click Save.
  11. In the navigation pane, click Environment > WebSphere Variables.
  12. Specify the scope to appropriate server level and add the ITCAMDCHOME variable. Set the ITCAMDCHOME variable value to the data collector home directory. For example, /opt/ibm/apm/agent/yndchome/7.3.0.14.08.
  13. Click Apply and then save the changes to the master configuration.
    • If you are not under a Network Deployment environment, click Save.
    • If you are under a Network Deployment environment, ensure that Synchronize changes with Nodes is selected in the Console preferencesoptions and then click Save.
  14. Restart the application server.

Results

Now you can check the WebSphere Applications agent data in the Cloud APM console after you add this application component to your applications. For instructions on how to start the Cloud APM console, see Starting the Cloud APM console. For instructions on how to add or edit an application, see Managing applications.

What to do next

After you manually configure the data collector, you cannot use the provided unconfig utility to unconfigure the data collector. Manually unconfigure the data collector instead. For instructions, see Manually unconfigure the data collector.

Manually configuring the data collector for WebSphere Application Server Liberty

Procedure

  1. Navigate to the Liberty server home directory. For example, /opt/ibm/wlp/usr/servers/defaultServer.
  2. Edit the jvm.options file by adding the following parameters, where dc_home is the data collector home directory and server_name is the Liberty server name.. If the jvm.options file does not exist, create it with a text editor. 
    -agentlib:am_ibm_16=server_name
–Xbootclasspath/p:dc_home/toolkit/lib/bcm-bootstrap.jar
-Djava.security.policy=dc_home/itcamdc/etc/datacollector.policy
-verbosegc

    When you add the entries, take note of the following things:

    • Each entry must be on a single line.
    • Replace server_name with the actual Liberty server name. For example, defaultServer.
    • Replace dc_home with the actual data collector home directory. For example, /opt/ibm/apm/agent/yndchome/7.3.0.14.08.
  3. Open the server.env file in the same directory and add the following path to the environment entry according to the operating system, where dc_home is the data collector home directory. If the server.env file does not exist, create it with a text editor.
    Table 2. Environment entry
    Platform Environment entry name Environment entry value
    AIX R6.1 (64-bit JVM) LIBPATH /lib:dc_home/toolkit/lib/aix536
    AIX R7.1 (64 bit JVM) LIBPATH /lib:dc_home/toolkit/lib/aix536
    Solaris 10 (64-bit JVM) LIBPATH /lib:dc_home/toolkit/lib/sol296
    Solaris 11 (64-bit JVM) LIBPATH /lib:dc_home/toolkit/lib/sol296
    Linux x86_64 R2.6 (64-bit JVM) LD_LIBRARY_PATH /lib:dc_home/toolkit/lib/lx8266
    Linux Intel R2.6 (32-bit JVM) LD_LIBRARY_PATH /lib:dc_home/toolkit/lib/li6263
    Windows (32-bit JVM) PATH /lib;dc_home/toolkit/lib/win32
    Windows (64-bit JVM) PATH /lib;dc_home/toolkit/lib/win64
  4. Open the server.xml file in the same directory and add the following lines to enable the monitoring feature: 
    <featureManager>
              <feature>webProfile-7.0</feature>
              <feature>monitor-1.0</feature>
              <feature>usr:itcam-730.140</feature>
   </featureManager>
  5. Restart the Liberty server.

Results

Now you can check the WebSphere Applications agent data in the Cloud APM console after you add this application component to your applications. For instructions on how to start the Cloud APM console, see Starting the Cloud APM console. For instructions on how to add or edit an application, see Managing applications.

What to do next

After you manually configure the data collector, you cannot use the provided unconfig utility to unconfigure the data collector. Manually unconfigure the data collector instead. For instructions, see Manually unconfigure the data collector.