This page describes configuration details for IBM DB2 collectors.

Prerequisites

To monitor IBM DB2 with Database Visibility, you must be running DB2 >= 9.x. 

Connection Details

SectionFieldDescription
Create New CollectorDatabase TypeThe database type that you want to monitor.
AgentThe Database Agent that manages the collector.
Collector NameThe name you want to identify the collector by.
Connection DetailsHostname or IP AddressThe hostname or IP address of the machine that your database is running on.
Database

The name of the database instance that you want to monitor.

If the database instance hosts multiple databases, ensure to create separate collector for each database.

Listener PortThe TCP/IP address of the port on which your database communicates with the Database Agent.
Custom JDBC Connection String

The JDBC connection string generated by the database agent, for example, jdbc:db2://. You can also specify a custom connection string, which is useful for setting custom authentication options.

If you are using the connection string for Kerberos authentication, ensure to select the Kerberos option under Advanced Options.

Username and PasswordUsernameThe name of the user who is connecting to and monitoring the database through the Database Agent. The user should have the permissions described in User Permissions for IBM DB2 LUW.
PasswordThe password of the user who is connecting to and monitoring the database through the Database Agent.
CyberarkClick to enable CyberArk for database username and password. When CyberArk is enabled, information about Application, Safe, Folder, and Object is required to fetch the username and password for your database. To use CyberArk with Database Visibility, you must download the JavaPasswordSDK.jar file from the CyberArk web site and rename the file to cyberark-sdk-9.5.jar. Then, you must copy the JAR file to the lib directory of the database agent zip file. 
Advanced OptionsSub-Collectors

Click to monitor multiple database instances in a consolidated view, and aggregate metrics of multiple databases. To monitor a custom cluster, you can add additional hostname or IP address, and port details for each sub-collector. You can add up to a total of 29 sub-collectors. Thereby, 30 databases can be monitored in a custom cluster. In addition to the licenses consumed by the main collector, each sub-collector consumes one or more licenses, depending on the database type.

Note

  • All connection parameters other than the hostname or IP address, and port details of the sub-collector are the same as the main collector. If you want to specify different parameters for the sub–collectors, while creating or editing the collector configuration, you can do that only through the Create Collector API.

  • You cannot convert a custom cluster collector to a standalone collector. If you want to monitor a standalone database, delete the entire custom cluster collector and create a fresh standalone collector. However, note that deleting the custom cluster collector will delete all its historical data.
Connection Properties

Click to add a new JDBC connection property or edit an existing property for relational databases.

For monitoring the database using Kerberos authentication, follow the instructions mentioned at Monitor IBM DB2 Databases Using Kerberos Authentication.

KerberosClick to use Kerberos authentication to manage the database user and host user passwords.
Monitor Operating SystemSee Configure the Database Agent to Monitor Server Hardware.

User Permissions for IBM DB2 LUW

The monitoring user needs SYSMON authority and connection privileges to monitor. This user must be a part of the sysmon_group.

To generate an execution plan, you must create the associated EXPLAIN tables in the schema.

DB2 >= 9.7

For complete Database Visibility functionality, the following monitoring switches of the DB2 server need to be enabled: "TIMESTAMP".

To enable the "TIMESTAMP" monitoring switch, enter:

update dbm cfg using dft_mon_timestamp on;
update db cfg using mon_act_metrics BASE
CODE

Privileges

grant select on SYSIBMADM.MON_CURRENT_SQL to user DBMon_Agent_User
grant select on SYSIBMADM.MON_LOCKWAITS to user DBMon_Agent_User
grant execute on function SYSPROC.MON_GET_CONNECTION to user DBMon_Agent_User
grant execute on function SYSPROC.MON_GET_PKG_CACHE_STMT to user DBMon_Agent_User
(version 10.5 and above) grant execute on function SYSPROC.MON_GET_TRANSACTION_LOG to DBMon_Agent_User
(version 10.5 and above) grant execute on function SYSPROC.MON_GET_DATABASE to DBMon_Agent_User
CODE

Replace DBMon_Agent_User with the user name under which you run the Database Visibility Agent.

DB2 9.5

For complete Database Visibility functionality, the following monitoring switches of the DB2 server need to be enabled: "STATEMENT", and "TIMESTAMP".

To enable these monitoring switches, enter:

update dbm cfg using dft_mon_stmt on;
update dbm cfg using dft_mon_timestamp on;
CODE

Privileges

grant select on SYSIBMADM.SNAPSTMT to user DBMon_Agent_User 
grant select on SYSIBMADM.SNAPAPPL_INFO to user DBMon_Agent_User 
grant select on table SYSIBMADM.ENV_PROD_INFO to user DBMon_Agent_User
CODE

where DBMon_Agent_User is the user name under which you run the Database Visibility Agent.

User Permissions When restrict_access is Set to YES

If your database has the restrict_access parameter set to YES, you must grant these privileges:

grant select on SYSIBMADM.MON_CURRENT_SQL to user DBMon_Agent_User;
grant select on SYSIBMADM.MON_LOCKWAITS to user DBMon_Agent_User;
grant execute on function SYSPROC.MON_GET_CONNECTION to user DBMon_Agent_User;
grant select on SYSIBMADM.SNAPAPPL_INFO to user DBMon_Agent_User;
grant EXECUTE on function SYSPROC.MON_GET_PKG_CACHE_STMT to user DBMon_Agent_User;
grant execute on function SYSPROC.MON_GET_TRANSACTION_LOG to user DBMon_Agent_User;
grant EXECUTE on package NULLID.SQLC2K26 to user DBMon_Agent_User;
grant select on SYSIBM.SYSDUMMY1 to user DBMon_Agent_User;
grant select on SYSIBMADM.ENV_PROD_INFO to user DBMon_Agent_User;
grant select on SYSIBMADM.ENV_SYS_RESOURCES to user DBMon_Agent_User;
grant execute on function SYSPROC.SNAP_GET_STMT(varchar(),Integer) to user DBMon_Agent_User;
grant select on SYSCAT.STATEMENTS to user DBMon_Agent_User;
grant select on SYSIBMADM.DBCFG to user DBMon_Agent_User;
grant execute on function SYSPROC.SNAP_GET_DB(varchar(),Integer) to user DBMon_Agent_User;
grant EXECUTE on package NULLID.SYSSH200 to user DBMon_Agent_User;
grant select on SYSIBMADM.ENV_SYS_RESOURCESto user DBMon_Agent_User;
grant select on SYSCAT.DBAUTH to user DBMon_Agent_User;
grant execute on function SYSPROC.SNAP_GET_DBM(Integer) to user DBMon_Agent_User;
grant select on syscat.schemata to user DBMon_Agent_User;
CODE

Replace DBMon_Agent_User with the user name under which you run the Database Visibility Agent.

Generate Execution Plans

To generate an execution plan in DB2, the monitoring user ID must have access to the explain_* tables. 

  1. Create the explain tables one of theses methods:
    • Call the SYSPROC.SYSINSTALLOBJECTS procedure:{{}}

{{db2 CONNECT TO database-name
db2 }}

{{CALL SYSPROC.SYSINSTALLOBJECTS('EXPLAIN', 'C',
CAST (NULL AS VARCHAR(128)), CAST (NULL AS VARCHAR(128)))}}

This call creates the explain tables under SYSTOOLS schema. To create them under a different schema, specify a schema name as the last parameter in the call.

    • Run the EXPLAIN.DDL command file:{{}}

{{db2 CONNECT TO database-name
db2 -tf EXPLAIN.DDL}}

{{}}

Explain plans will not function properly unless the monitoring user ID is granted SELECT privilege on every table being accessed in the SQL as well as the necessary explain_* tables.