Performance Class
Performance class is a type of the system resource that can be monitored. This includes CPU, memory, disk, network, etc. A class is identified by its ID. You obtain the IDs of the available classes by retrieving them from the Agent vocabulary. Each performance class is represented by a category in the vocabulary. To distinguish the class categories from other categories, they all belong to another category named counters
. Different server types (generic, Virtuozzo Containers) have their own sets of performance classes. The following are examples of performance class entries in a vocabulary.
Generic performance class (compatible with physical servers only):
<category>
<id>counters_net</id>
<category>generic</category>
<category>counters</category>
<short>Network usage</short>
<long>Network usage related parameters</long>
</category>
Virtuozzo performance class (compatible with Virtuozzo Containers only):
<category>
<id>counters_vz_net</id>
<category>virtuozzo</category>
<category>counters</category>
<short>Network usage</short>
<long>Container network-related counters</long>
</category>
The following table describes the properties of a performance class:
Property |
Description |
|
The unique class ID |
|
The name of the parent vocabulary category. The The |
|
Short description of the class. |
|
Long description of the class. |
Class Instance
While class identifies the type of the system resource, the term "instance" refers to a particular device when multiple devices of the same type exist in the system. For example, a network interface in general is a class, but each network card installed in the system is an instance of that class. Each class has at least one instance, but not all classes may have multiple instances.
Performance Counter
Counters are used to measure various aspects of a performance, such as the CPU times, network rates, disk usage, etc. Each class has its own set of counters. Counter data is comprised of the current, minimum, maximum, and average values. You retrieve the list of counters available for a particular class from the vocabulary by specifying the class name as the criteria. Performance counters are stored as parameters in a vocabulary. Each counter has a category
property that contains the name of the performance class this counter belongs to. The following is an example of a performance counter entry in a vocabulary:
<parameter>
<id>counter_cpu_system</id>
<category>counters_vz_cpu</category>
<type>int</type>
<value_type>1</value_type>
<counter_type>2</counter_type>
<short>System</short>
<long>System CPU time</long>
<measure>seconds</measure>
</parameter>
The following table describes the properties of a performance counter:
Property |
Description |
|
A string containing the unique counter identifier. |
|
A string containing the name of the parent performance class (in general, the name of the parent vocabulary category). |
|
A string specifying the data type of the counter values. The possible values are:
|
|
A numeric representation of the counter data type (used internally by Agent). |
|
An integer representing the counter type. Depending on the type, the values of the counter can be interpreted differently:
|
|
Short counter description. |
|
Long counter description. |
|
Units of measure (seconds, percent). |