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.

ElementDescription
nameInfo
Required

Static strings used for describing an object model string or enumeration.

ElementDescription
groupInfo
Required

Static strings used for describing an object model string or enumeration.

ElementDescription
unitInfo
Required

Static strings used for describing an object model string or enumeration.

PerfSummaryType_enum
rollupType
Required

Indicates how multiple samples of a specific counter type are transformed into a single statistical value.

Possible values:

  • average: The actual value collected or the average of all values collected during the summary period.
  • maximum: The maximum value of the performance counter value over the summarization period.
  • minimum: The minimum value of the performance counter value over the summarization period.
  • latest: The most recent value of the performance counter over the summarization period.
  • summation: The sum of all the values of the performance counter over the summarization period.
  • none: The counter is never rolled up.
Possible values are : average, maximum, minimum, latest, summation, none,
PerfStatsType_enum
statsType
Required

Indicates the type of statistical measurement that a counter’s value represents.

Valid types are “absolute”, “delta”, or “rate”.

Possible values:

  • absolute: Represents an actual value, level, or state of the counter.

    For example, the “uptime” counter (system group) represents the actual number of seconds since startup. The “capacity” counter represents the actual configured size of the specified datastore. In other words, number of samples, samplingPeriod, and intervals have no bearing on an “absolute” counter“s value.

  • delta: Represents an amount of change for the counter during the samplingPeriod as compared to the previous interval.

    The first sampling interval

  • rate: Represents a value that has been normalized over the samplingPeriod, enabling values for the same counter type to be compared, regardless of interval.

    For example, the number of reads per second.

Possible values are : absolute, delta, 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.

Property Of
Returned By