Configuring the agent on Windows systems

You can use the IBM® Cloud Application Performance Management window to configure the agent on Windows systems.

Before you begin

Before you start configuring the Db2® agent for local and remote monitoring, ensure that following task is completed for remote monitoring.

Procedure

  1. Click Start > All Programs > IBM Monitoring agents > IBM Cloud Application Performance Management.
  2. In the IBM Cloud Application Performance Management window, right-click Monitoring Agent for DB2, and then click Configure agent.
  3. In the Enter a unique instance name field, type the agent instance name and click OK.
    Important: For local monitoring, the agent instance name must match the name of the Db2 instance that is being monitored.

    For remote monitoring, the agent instance name must be the unique catalog node name.

  4. In the Monitoring Agent for DB2 window, complete these steps:
    1. In the Username, enter the user name of Db2 instance.

      For Local Db2, enter the name of Db2 instance owner.

      For Remote Db2, enter Actual Db2 instance owner name from remote Db2 machine.

      Important: This parameter is mandatory for monitoring remote Db2 instance.
    2. In the Password, enter the password of Db2 instance.

      For Local Db2, enter the password of Db2 instance owner.

      For Remote Db2, enter Actual Db2 instance owner password from remote Db2 machine.

      Important: This parameter is mandatory for monitoring remote Db2 instance.
    3. In the DB2Customized SQL Definition File field, enter the full file path name for the SQL definition file. If the SQL definition file is in the default directory, leave this field blank. Otherwise, enter the full file path name of the file. The default file name with path is as follows:
      • Linux or AIXCANDLEHOME/config/kudcussql.properties
      • WindowsCANDLEHOME\TMAITM6_x64\kudcussql.properties
    4. In the db2diag Log File Path field, enter the directory path for the db2diag log file. If the db2diag log file is in the default directory, leave this field blank. Otherwise, enter the path of the directory. The default directory path is as follows:
      • Linux or AIX/home/DB2owner_home_dir/sqllib/db2dump
      • WindowsC:\ProgramData\IBM\DB2\DB2COPY\DB2INSTANCENAME
      Note: This parameter is not applicable for remote monitoring.
    5. In the MSGID Filter in Regular Expression field, enter the MSGID to filter the diagnostic log. The MSGID is a combination of the message type, message number, and severity level. Use a regular expression to filter the log based on message type, message number, or severity level, for example, ADM1\d*1E|ADM222\d2W.
    6. From the Enable Monitoring for Partitions in Remote Hosts list, select Yes to specify that the Db2 agent can monitor partitions in remote hosts.
    7. From the Enable Monitoring All Databases list, select Yes to specify that the Db2 agent can monitor all databases.
    8. Click OK.
      The agent instance is displayed in the IBM Cloud Application Performance Management window.
  5. Run following steps to configure remote monitoring.
    1. Open install_dir\TMAITM6_x64\KUDENV_<instanceName>.
    2. Set KUD_DB2_CLIENT_INST to Db2 client instance name under which remote Db2 server instance is cataloged.
  6. Right-click the Monitoring Agent for DB2 instance, and click Start.

What to do next

  • Grant privileges to the Db2 user to view data for some attributes of the Db2 agent. For information about granting these privileges, see Granting privileges for viewing Db2 metrics.
  • Log in to the Cloud APM console to view the data that is collected by the agent in the dashboards. For information about using the Cloud APM console, see Starting the Cloud APM console.