Name | Data Type | Qualifiers |
Name | Data Type | Value | Scope | Flavors |
Calculable | uint16 |
Description | string | An enumerated value that describes the characteristics of the metric, for purposes of performing calculations. The property can take one of the following values:
1="Non-calculable" -> a string. Arithmetic makes no sense.
2="Summable" -> It is reasonable to sum this value over many instances of e.g., UnitOfWork, such as the number of files processed in a backup job. For example, if each backup job is a UnitOfWork, and each job backs up 27,000 files on average, then it makes sense to say that 100 backup jobs processed 2,700,000 files.
3="Non-summable" -> It does not make sense to sum this value over many instances of UnitOfWork. An example would be a metric that measures the queue length when a job arrives at a server. If each job is a UnitOfWork, and the average queue length when each job arrives is 33, it does not make sense to say that the queue length for 100 jobs is 3300. It does make sense to say that the mean is 33. | None | TRANSLATABLE= true |
ValueMap | string | 1, 2, 3 | None | None |
Values | string | Non-calculable, Summable, Non-summable | None | TRANSLATABLE= true |
Caption | string |
Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
MaxLen | uint32 | 64 | None | None |
DataType | uint16 |
Description | string | The data type of the metric. For example, "boolean" (value=1) or "datetime" (=3) may be specified. These types represent the datatypes defined for CIM. | None | TRANSLATABLE= true |
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 | None | None |
Values | string | boolean, char16, datetime, real32, real64, sint16, sint32, sint64, sint8, string, uint16, uint32, uint64, uint8 | None | TRANSLATABLE= true |
Description | string |
Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
ElementName | string |
Description | string | A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information.
Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. | None | TRANSLATABLE= true |
Id | string |
Description | string | A 16 byte value that uniquely identifies the Metric Definition. The use of OSF UUID/GUIDs is recommended. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 16 | None | None |
Override | string | Id | None | OVERRIDABLE= false
|
Name | string |
Description | string | The name of the metric. This name does not have to be unique, but should be descriptive and may contain blanks. | None | TRANSLATABLE= true |
Units | string |
Description | string | Identifies the specific units of a value. Examples are Bytes, Packets, Jobs, Files, Milliseconds, and Amps. | None | TRANSLATABLE= true |
Validity | uint16 |
Description | string | An enumerated value describing when the Metric may be considered valid. Some metrics are valid only at the beginning of a transaction (e.g., bytes to print), while the transaction is running (e.g., percent complete), or when the transaction is finished (e.g., pages printed). If a metric is valid at more than one of the enumerated values, such as both when the unit of work starts and when it stops, it is recommended to not use Validity. | None | TRANSLATABLE= true |
ValueMap | string | 1, 2, 3 | None | None |
Values | string | At Start, In Middle, At Stop | None | TRANSLATABLE= true |
BreakdownDimensions | string[] |
Description | string | Defines one or more strings that can be used to refine (break down) queries against the BaseMetricValues along a certain dimension. An example is a transaction name, allowing the break down of the total value for all transactions into a set of values, one for each transaction name. Other examples might be application system or user group name. The strings are free format and should be meaningful to the end users of the metric data. The strings indicate which break down dimensions are supported for this metric definition, by the underlying instrumentation. | None | TRANSLATABLE= true |