--- name: "pmdadb2" section: "1" platform: "linux" package: "pcp" version: "7.2.2-2" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/pmdadb2" --- # pmdadb2(1) IBM Db2 database PMDA ## NAME **pmdadb2** - IBM Db2 database PMDA ## DESCRIPTION **pmdadb2** is a Performance Co-Pilot (PCP) Performance Metrics Domain Agent (PMDA) which extracts live performance data from a running IBM Db2 database server using the Db2 monitoring table functions (**MON\_GET\_\***). Metrics are organised into the following groups: - **db2.instance** Instance-level identity metrics from **ENV\_GET\_INSTANCE\_INFO**, covering the instance name, full service level (version) string, and operating platform. These are **PM\_SEM\_DISCRETE** metrics: they are logged once at recording start and only when changed. - **db2.database** Database-wide aggregate counters from **MON\_GET\_DATABASE**, covering transactions, row operations, sort activity, locking, package cache efficiency, and direct I/O. The instance domain contains one entry per monitored database name. - **db2.bufferpool** Per-buffer-pool counters from **MON\_GET\_BUFFERPOOL**, covering logical and physical reads and writes for data, index, and column-organised pages, together with pool read/write times and unread prefetch pages. Instance names are *dbname*::*bpname*. - **db2.table** Per-table counters from **MON\_GET\_TABLE**, covering row operations, lock activity, overflow accesses, and full-table scans. System tables (schema prefix **SYS**) are excluded. Instance names are *dbname*::*tabschema.tabname*. - **db2.workload** Per-workload counters from **MON\_GET\_WORKLOAD**, covering row operations, CPU time, and transaction counts. Instance names are *dbname*::*workload\_name*. - **db2.tablespace** Per-tablespace I/O counters from **MON\_GET\_TABLESPACE**, covering buffer pool and direct read/write operations and times. Instance names are *dbname*::*tablespace\_name*. - **db2.connection** Per-connection counters from **MON\_GET\_CONNECTION**, covering CPU time, row operations, lock activity, and transaction counts. Instance names are *dbname*::*appname*::*handle*. - **db2.latch** Per-latch-type extended wait statistics from **MON\_GET\_LATCH**, covering cumulative wait time and event count. Only latch types that have experienced at least one extended wait event appear in the instance domain. Instance names are *dbname*::*latch\_name*. - **db2.log** Transaction log I/O counters from **MON\_GET\_TRANSACTION\_LOG**, covering log write and read operations, physical I/O counts, buffer-full events, and current used and available log space. The instance domain contains one entry per monitored database name. - **db2.pkg\_cache** Package cache aggregate counters from **MON\_GET\_PKG\_CACHE\_STMT**, summarising the entire statement cache without a per-statement instance domain: cached statement count, total executions, CPU time, rows read, sort operations, and sort overflows. The instance domain contains one entry per monitored database name. ## CONFIGURATION Firstly, **pmdadb2** requires installation of the **ibm\_db** Python package, which provides the IBM Db2 driver for Python. **pmdadb2** reads a mandatory ini-style configuration file: - - *`$PCP_SYSCONF_DIR`/db2/db2.conf* This file has two sections. **\[connection\]** specifies how to reach the Db2 server (default values shown in parentheses): - **hostname (*localhost*)** Hostname or IP address of the Db2 instance. - **port (*50000*)** TCP port number of the Db2 instance listener. - **timeout (*5*)** Connection timeout in seconds. **\[databases\]** specifies which databases on the instance to monitor: - **names** Space-separated list of Db2 database names to monitor. All databases must be reachable at the configured hostname and port using the same credentials. The database name appears as the instance name for **db2.database.\***, **db2.log.\*** and **db2.pkg\_cache.\*** metrics, and as the *dbname::* prefix in all per-object instance domains (buffer pools, tables, tablespaces, workloads, connections, latches). **\[authentication\]** specifies the Db2 user credentials: - **username** Db2 username to authenticate as. The user must have **EXECUTE** privilege on the **MON\_GET\_\*** table functions and **DATAACCESS** or the appropriate **MON\_\*** authorities on the target database. - **password** Password for the above username. ## INSTALLATION To install, the following must be done as root: ``` # cd $PCP_PMDAS_DIR/db2 # ./Install ``` To uninstall, the following must be done as root: ``` # cd $PCP_PMDAS_DIR/db2 # ./Remove ``` **pmdadb2** is launched by [**pmcd**(1)](/pmcd/1.md) and should never be executed directly. The **Install** and **Remove** scripts notify [**pmcd**(1)](/pmcd/1.md) when the agent is installed or removed. **pmdadb2** will automatically attempt to reconnect to the Db2 server if the connection is lost. ## FILES - *`$PCP_SYSCONF_DIR`/db2/db2.conf* configuration file for the **pmdadb2** agent - *`$PCP_PMDAS_DIR`/db2/Install* installation script for the **pmdadb2** agent - *`$PCP_PMDAS_DIR`/db2/Remove* undo installation script for the **pmdadb2** agent - *`$PCP_LOG_DIR`/pmcd/db2.log* default log file for messages from the **pmdadb2** agent Note that the usual/default value for **$PCP\_SYSCONF\_DIR** is **/etc/pcp** the default for **$PCP\_PMDAS\_DIR** is **/var/lib/pcp/pmdas** and the default for **$PCP\_LOG\_DIR** is **/var/log/pcp** but these settings are platform dependent. ## PCP ENVIRONMENT Environment variables with the prefix **PCP\_** are used to parameterize the file and directory names used by PCP. On each installation, the file */etc/pcp.conf* contains the local values for these variables. The **$PCP\_CONF** variable may be used to specify an alternative configuration file, as described in [**pcp.conf**(5)](/pcp.conf/5.md). ## SEE ALSO [**PCPIntro**(1)](/PCPIntro/1.md), [**pmcd**(1)](/pmcd/1.md), [**pmdamssql**(1)](/pmdamssql/1.md) and [**pmdapostgresql**(1)](/pmdapostgresql/1.md).