7.7.5.17 DESCRIBE METRICDEFINITION

Purpose

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

Syntax

DESCRIBE METRICDEFINITION

Usage Notes

The attributes for the DESCRIBE METRICDEFINITION command can include the following:

• 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:

  • CD_ (cell disk)

  • CG_ (IORM consumer group, database-qualified)

  • CL_ (cell)

  • CT_ (IORM category)

  • DB_ (IORM database-level)

  • FC_ (flash cache)

  • FL_ (flash log)

  • GD_ (grid disk)

  • IORM

  • N_ (network, IBPORT, HOST_INTERCONNECT)

  • PDB_ (IORM pluggable database)

  • SIO_ (Smart IO)

  After the abbreviation of the object type, most of the name attributes contain one of the following combinations to identify the operation:

  • IO_BY (I/O amount)

  • IO_RQ (number of I/O requests)

  • IO_TM (I/O latency)

  • IO_WT (I/O wait time)

  • FC_IO_BY (Flash cache I/O amount)

  • FC_IO_RQ (Flash cache I/O requests)

  • FD_IO_BY (Flash disk I/O amount)

  • FD_IO_RQ (Flash disk I/O requests)

  • FD_IO_TM (Flash disk latency)

  • FD_IO_UTIL (Flash disk utilization percentage)

  Next, in the name could be _R (for read) or _W (for write). Following that in the name attribute value there might be _SM or _LG to identify small or large blocks, respectively. At the end of the name, there could be _SEC to signify per seconds or _RQ to signify per request.

  For consumer group and category metrics, read or write details are omitted.

  For example:

  • CD_IO_RQ_R_SM is the number of requests to read small blocks on a cell disk.

  • GD_IO_TM_W_LG is the microseconds of I/O latency writing large blocks on a grid disk.

• 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: Type of object being measured. Values are:

  • CELL

  • CELL_FILESYSTEM

  • CELLDISK

  • FLASHCACHE

  • FLASHLOG

  • GRIDDISK

  • IBPORT

  • IORM_CATEGORY

  • IORM_CONSUMER_GROUP

  • IORM_DATABASE

  • IORM_PLUGGABLE_DATABASE

  • HOST_INTERCONNECT

  • SMARTIO

• retentionPolicy: Specifies the retention policy for historical metric observations.

  When retentionPolicy=Default, the retention period for the associated metric is governed by the metricHistoryDays cell 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)

  • IO/sec

  • “IO requests”

  • KB

  • KB/sec

  • MB

  • MB/sec

  • /min

  • ms

  • ms/request

  • ms/sec

  • us (microseconds)

  • us/request

  • us/sec

Examples

The following example shows the DESCRIBE command with the METRICDEFINITION object.

Example 7-110 Describing the METRICDEFINITION Object

CellCLI> DESCRIBE METRICDEFINITION

         name
         description
         metricType
         objectType
         persistencePolicy
         unit