PerfCounterInfo

PerfCounterInfo
PerfCounterInfo

This data object type contains metadata for a performance counter.

See PerformanceManager for definitions of available counters.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": 0,
    "nameInfo": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string"
    },
    "groupInfo": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string"
    },
    "unitInfo": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string"
    },
    "rollupType": "string",
    "statsType": "string",
    "level": 0,
    "perDeviceLevel": 0,
    "associatedCounterId": [
        0
    ]
}
integer As int32 As int32
key
Required

A system-generated number that uniquely identifies the counter in the context of the system.

The performance counter ID.

nameInfo
Required

The name of the counter with label and summary details.

For example, the counter with name "usage" for the "cpu" group of performance counters.

groupInfo
Required

The group of the performance counter with its label and summary details.

Counter groups include "cpu," "mem," "net," "disk," "system," "rescpu," and "clusterServices," for example.

unitInfo
Required

The unit for the values of the performance counter with its label and summary details.

See PerformanceManagerUnitEnum for a description of the valid values.

rollupType
Required

The counter type.

Valid values include average, maximum, minimum, latest, summation, or none. This determines the type of statistical values that are returned for the counter. None means that the counter is never rolled up.

statsType
Required

Statistics type for the counter.

Valid values include absolute, delta, or rate.

integer As int32 As int32
level
Optional

Minimum level at which metrics of this type will be collected by VirtualCenter Server.

The value for this property for any performance counter is a number from 1 to 4. The higher the setting, the more data is collected by VirtualCenter Server. The default setting for VirtualCenter Server is 1, which collects the minimal amount of performance data that is typically useful to administrators and developers alike. The specific level of each counter is documented in the respective counter-documentation pages, by group. See PerformanceManager for links to the counter group pages.

integer As int32 As int32
perDeviceLevel
Optional

Minimum level at which the per device metrics of this type will be collected by vCenter Server.

The value for this property for any performance counter is a number from 1 to 4. By default all per device metrics are calculated at level 3 or more. If a certain per device counter is collected at a certain level, the aggregate metric is also calculated at that level, i.e., perDeviceLevel is greater than or equal to level.

array of integer
associatedCounterId
Optional

Deprecated as of VI API 2.5, this property is not used.

The counter IDs associated with the same performance counter name for the same device type.

For example, the rollup types for CPU Usage for a host are average, minimum, and maximum. Therefore, their counter IDs are associated.