GET DESCRIPTION FOR HEALTH INDICATOR command

The GET DESCRIPTION FOR HEALTH INDICATOR command returns a description for the specified health indicator. A Health Indicator measures the healthiness of a particular state, capacity, or behavior of the database system. The state defines whether or not the database object or resource is operating normally.

Authorization

None

Required connection

Instance. If there is no instance attachment, a default instance attachment is created.

To obtain a snapshot of a remote instance, it is necessary to first attach to that instance.

Command syntax

Read syntax diagramSkip visual syntax diagramGET DESCRIPTION FOR HEALTH INDICATORshortname

Command parameters

HEALTH INDICATOR shortname
The name of the health indicator for which you would like to retrieve the description. Health indicator names consist of a two- or three-letter object identifier followed by a name which describes what the indicator measures. For example: 
    db.sort_privmem_util

Examples

The following example is sample output from the GET DESCRIPTION FOR HEALTH INDICATOR command. 
GET DESCRIPTION FOR HEALTH INDICATOR db2.sort_privmem_util

DESCRIPTION FOR db2.sort_privmem_util

Sorting is considered healthy if there is sufficient heap space in which to 
perform sorting and sorts do not overflow unnecessarily. This indicator 
tracks the utilization of the private sort memory. If db2.sort_heap_allocated
(system monitor data element) >= SHEAPTHRES (DBM configuration parameter), sorts
may not be getting full sort heap as defined by the SORTHEAP parameter and an 
alert may be generated. The indicator is calculated using the formula:  
(db2.sort_heap_allocated / SHEAPTHRES) * 100. The Post Threshold Sorts snapshot 
monitor element measures the number of sorts that have requested heaps after the 
sort heap threshold has been exceeded. The value of this indicator, shown in the
Additional Details, indicates the degree of severity of the problem for this  
health indicator. The Maximum Private Sort Memory Used snapshot monitor element 
maintains a private sort memory high-water mark for the instance.  The value of  
this indicator, shown in the Additional Information, indicates the maximum amount 
of private sort memory that has been in use at any one point in time since the 
instance was last recycled.  This value can be used to help determine an 
appropriate value for SHEAPTHRES.