Health monitor interfaces
There are a number of different health monitor interfaces. The interface you chose depends on your database configuration and current state.
Important: The health monitor, health indicators, and related components have been deprecated and might be
removed in a future release. Health monitor is not supported in Db2®
pureScale® environments. For
more information, see Health monitor has been deprecated.
The following table lists the health monitor interfaces for APIs:
| Monitoring task | API |
|---|---|
| Capturing a health snapshot | db2GetSnapshot - Get Snapshot with snapshot class SQLM_CLASS_HEALTH |
| Capturing a health snapshot with the full list of collection objects | db2GetSnapshot - Get Snapshot with snapshot class SQLM_CLASS_HEALTH and SQLM_HMON_OPT_COLL_FULL for agent_id |
| Capturing a health snapshot with formula, additional information, and history | db2GetSnapshot - Get Snapshot with snapshot class SQLM_CLASS_HEALTH_WITH_DETAIL |
| Capturing a health snapshot with formula, additional information, history, and the full list of collection objects | db2GetSnapshot - Get Snapshot with snapshot class SQLM_CLASS_HEALTH_WITH_DETAIL and SQLM_HMON_OPT_COLL_FULL for agent_id |
| Converting the self-describing data stream | db2ConvMonStream - Convert Monitor stream |
| Estimating the size of a health snapshot | db2GetSnapshotSize - Estimate Size Required for db2GetSnapshot Output Buffer |
The GET HEALTH SNAPSHOT command is part of the health monitor components that have been deprecated.
The
following table lists the health monitor interfaces for CLP commands:
| Monitoring task | CLP command |
|---|---|
| Capturing a health snapshot | GET HEALTH SNAPSHOT Command |
| Capturing a health snapshot with formula, additional information, and history | GET HEALTH SNAPSHOT WITH DETAILS Command |
The health monitor SQL functions are part of the health monitor components that have been deprecated.
The
following table lists the health monitor interfaces for SQL functions:
| Monitoring task | SQL Function |
|---|---|
| Database manager level health information snapshot | HEALTH_DBM_INFO |
| Database manager level health indicator snapshot | HEALTH_DBM_HI |
| Database manager level health indicator history snapshot | HEALTH_DBM_HI_HIS |
| Database level health information snapshot | HEALTH_DB_INFO |
| Database level health indicator snapshot | HEALTH_DB_HI |
| Database level health indicator history snapshot | HEALTH_DB_HI_HIS |
| Database level health indicator collection snapshot | HEALTH_DB_HIC |
| Database level health indicator collection history snapshot | HEALTH_DB_HIC_HIS |
| Table space level health information snapshot | HEALTH_TBS_INFO |
| Table space level health indicator snapshot | HEALTH_TBS_HI |
| Table space level health indicator history snapshot | HEALTH_TBS_HI_HIS |
| Table space container level health information snapshot | HEALTH_CONT_INFO |
| Table space container level health indicator snapshot | HEALTH_CONT_HI |
| Table space container level health indicator history snapshot | HEALTH_CONT_HI_HIS |