VsanPerfMetricId | Virtual Infrastructure JSON API

VsanPerfMetricId

A metric is used identify the stats of an entity.

i.e., IOPS, Throughput, Latency

AllOf

This class requires all of the following:

JSON Example

{
    "_typeName": "string",
    "label": "string",
    "group": "string",
    "rollupType": "string",
    "statsType": "string",
    "name": "string",
    "description": "string",
    "metricsCollectInterval": 0
}

string

label

Required

This is an identification label of a performance metric - VsanPerfMetricId (i.e., 'iopsRead', 'iopsWrite').

It is unique for a type of monitored entities like VMs, but not unique among different types of entities. For example both VM and disk entities have 'iopsRead' metric label. All performance statistics are represented using performance metrics. It is a basic element used in perforamnce stats querying and performance stats presentation. When querying stats of an entity, you can use metric labels to specify what kind of metrics you want in the query spec (see labels). In performance stats query results, metric labels are also used to identify stats data for different metrics (used in VsanPerfMetricId). You can get all supported metrics of an entity using the API of VsanPerfGetSupportedEntityTypes.

string

group

Optional

The group label of the performance metric.

i.e., Metric groups include "domclient", "domowner", "domcompmgr".

string

rollupType

Optional

Unused field.