HEALTH_GET_IND_DEFINITION table function

Returns the health indicator definitions.

Important: This table function has been deprecated and might be removed in a future release because the health monitor has been deprecated. It is not supported in Db2® pureScale® environments. For more information, see Health monitor has been deprecated..

Syntax

The schema is SYSPROC.

Table function parameter

locale

An input argument of type VARCHAR(33) that indicates the locale in which the translatable output is to be returned. If the input locale is not supported by the database server, an SQL warning message is issued, and the default language (English) is used. If the input locale is not provided, that is, its value is NULL (or an empty string), the default language is used.

Authorization

One of the following authorities is required to execute the routine:

EXECUTE privilege on the routine
DATAACCESS authority
DBADM authority
SQLADM authority

Default PUBLIC privilege

In a non-restrictive database, EXECUTE privilege is granted to PUBLIC when the function is automatically created.

Examples

Example 1: Retrieve the type and short description for health indicator db.db_op_status in French.

SELECT TYPE, SHORT_DESCRIPTION 
   FROM TABLE(SYSPROC.HEALTH_GET_IND_DEFINITION('fr_FR')) 
   AS IND_DEFINITION WHERE NAME = 'db.db_op_status'

The following is an example of output for this query.

TYPE             SHORT_DESCRIPTION                        
---------------- ----------------------------------------...---------
STATE            Etat opérationnel de la base de données  
                                                          
  1 record(s) selected.

Example 2: Retrieve the short description for health indicator ID 1001 in English.

SELECT SHORT_DESCRIPTION FROM TABLE(SYSPROC.HEALTH_GET_IND_DEFINITION('en_US') 
   AS IND_DEFINITION WHERE ID = 1001

The following is an example of output for this query.

SHORT_DESCRIPTION
-----------------------------...-------------
Database Operational State

Example 3: Retrieve all health indicator IDs and names.

SELECT ID, NAME FROM TABLE(HEALTH_GET_IND_DEFINITION('')) AS T

The following is an example of output for this query.

ID                   NAME                        
-------------------- ----------------------------
                   1 db2.db2_op_status           
                   2 db2.sort_privmem_util       
                   4 db2.mon_heap_util           
                1001 db.db_op_status             
                1002 db.sort_shrmem_util         
...
                2001 ts.ts_op_status             
                2002 ts.ts_util                  
...
                3002 tsc.tscont_util             
                1015 db.tb_reorg_req             
...

Information returned

Table 1. Information returned by the HEALTH_GET_IND_DEFINITION table function
Column name	Data type	Description
ID	BIGINT	id - cluster caching facility identification monitor element
NAME	VARCHAR(128)	Health indicator name.
SHORT_DESCRIPTION	VARCHAR(1024)	Health indicator short description.
LONG_DESCRIPTION	VARCHAR(32672)	Health indicator long description.
TYPE	VARCHAR(16)	Health indicator type. Possible values are: 'THRESHOLD_UPPER': upper-bounded threshold-based health indicators. 'THRESHOLD_LOWER': lower-bounded threshold-based health indicators. 'STATE': state-based health indicators. 'COLLECTION_STATE': collection state-based health indicators.
UNIT	VARCHAR(1024)	Unit of the health indicator values and thresholds or Null if not applicable.
CATEGORY	VARCHAR(1024)	Health indicator category.
FORMULA	VARCHAR(512)	Health indicator formula.
REFRESH_INTERVAL	BIGINT	Health indicator evaluation interval in seconds.