9.7.3.7 DESCRIBE METRICDEFINITION

Purpose

The DESCRIBE METRICDEFINITION command displays a list of attributes for the METRICDEFINITION object type.

Syntax

DESCRIBE METRICDEFINITION

Usage Notes

Table 9-8 lists the attributes for the DESCRIBE METRICDEFINITION command.

Table 9-8 DESCRIBE METRICDEFINITION Attributes

Attribute Description

name

Unique name of the metric definition.

The value of the name attribute is a composite of abbreviations. The attribute value starts with an abbreviation of the object type on which the metric is defined:

  • DS_ (database server)

  • N_ (network)

description

Description of the metric.

fineGrained

Specifies if the metric is enabled for fine-grained collection.

metricType

Indicator of how the statistic was created or defined. The options are as follows:

  • cumulative: Cumulative statistics since the metric was created.

  • instantaneous: Value at the time that the metric is collected.

  • rate: Rates computed by averaging statistics over observation periods.

  • transition: Transition metrics are collected at the time their value has changed and typically capture important transitions in hardware status.

objectType

Options are DBSERVER, DBSERVER_FILESYSTEM, and IBPORT.

retentionPolicy

Specifies the retention policy for historical metric observations.

When retentionPolicy=Default, the retention period for the associated metric is governed by the metricHistoryDays database server attribute. If retentionPolicy=Annual, the associated metric has a one-year retention period.

streaming

Specifies if the metric is enabled for streaming to a collection endpoint.

unit

Unit for the metric explicitly, and is related to the metric collected:

  • Number

  • % (percentage)

  • F (Fahrenheit)

  • C (Celsius)