This XML schema defines the structure of DMTF metric registries. A metric registry is a normative expression of the CIM BaseMetricDefinition instances. A metric registry is an XML instance document following this XML schema which consists of a list of values for the properties which define metric CIM Instances.
Except for the REGISTRY element, any global element and type definitions in this schema shall not be used by other XML schemas, in order to allow for structural changes in future updates to this XML schema.
The top-level element of the metric registry. Metric registries shall contain one occurence of the REGISTRY element as the only top-level element.
Identification and other details about the metric registry.
The owning entity of the metric registry.
The element content shall identify the business entity owning the metric registry. It shall include a copyrighted, trademarked, or otherwise unique name that is owned by that business entity or that is a registered ID assigned to that business entity by a recognized global authority. In addition, to ensure uniqueness, the element content shall not contain a colon (:).
For registries owned by DMTF, the element content shall be "DMTF".
A description of the metric registry. The description is targeted to developers of an implementation that exploits the metric definitions defined in this registry. It does not need to be well suited as an explanation for human consumers of the metrics.
Identification information for the metric registry, through its attributes ID, NAME and VERSION.
An identification of the metric registry, for programmatic use and external reference to the registry.
It shall be unique across all metric registries owned by the owning entity stated in the OWNING_ENTITY element of the registry, and it shall not change over the lifetime of the registry.
Its format shall conform to the IDENTIFIER ABNF rule defined in DSP0004.
It shall be compared case sensitively.
For registries owned by DMTF, its value shall be the DSP number of the registry if specified, in upper case (e.g. "DSP8048").
A display name of the metric registry, for human consumption. It should not be used for external reference to the registry.
It shall be unique across all metric registries owned by the owning entity stated in the OWNING_ENTITY element of the registry. It may be changed in future releases of the registry.
The version of the metric registry.
The attribute value shall conform to the DMTF versioning rules defined in DSP4004.
The version of the CIM Schema the metric registry is dependent on.
The version of the CIM Schema. The version shall contain the major and minor version number, and optionally the update
version number. If the version contains only the major and minor version number, the latest published update version number is meant to be
referenced.
The list of metric definitions in this registry.
An indicator on whether or not the metric is considered
experimental. A value of "true" means the metric is experimental. Experimental metrics may be
removed or changed incompatibly in future revisions of the metric registry.
The normative expression of a metric definition.
The normative expression of an aggregation metric definition, based on an underlying
base metric. Metrics of this type are mapped to instances of aggregation metric definition.
The class name of the CIM_StatisticalData subclass.
A global identification of the metric definition, for programmatic use.
It shall be unique across all metric registries, and it shall not change over the lifetime of the
metric definition.
Its format shall conform to the following ABNF rule:
MetricID = RegOwningEntity ":" RegID ":" LocalID
where:
- RegOwningEntity is the content of the OWNING_ENTITY element of this registry.
- RegID is the value of the IDENTIFICATION/@ID attribute of this registry.
- LocalID is the content of the LOCALID element of the METRIC element in the registry.
A reference to the base metric instance used by the aggregation metric as a base.
A local identification of the metric definition, for use as an
identifier name (e.g. as a CIM property). It shall be unique within this metric registry, and it
shall not change over the lifetime of the metric definition. It shall conform to the format defined
by the IDENTIFIER ABNF rule defined in DSP0004.
The name of the metric, for human consumption. This name does not have to be unique, but should be descriptive and may contain blanks.
A comprehensive description of the metric described by the metric definition.
The CIM datatype of the metric value described by the metric definition.
An enumerated value that describes the characteristics of the metric,
for purposes of performing calculations.
Numeric calculations on the metric values are not defined.
Summing metric values up across multiple metric instances
results in a meaningful value.
Numeric calculations generally are defined for the metric,
but summing the metric values up across multiple metric instances does not result in a meaningful
value.
Identifies the unit of measurement for the metric values as defined in DSP0004.
Deprecated: Usage of this element is deprecated. Use the PROGRAMMATIC_UNITS element instead.
Identifies the unit of measurement for the metric values as a
programmatic unit, as defined in DSP0004.
Defines one or more strings that can be used to refine (break down)
queries against the BaseMetricValues along a certain dimension.
Indicates whether the possible metric values are continuous (if true)
or discrete (if false).
Indicates how the metric value changes, in the form of typical
combinations of finer grain attributes such as direction change, minimum and maximum values, and
wrapping semantics.
A change type is not defined or unknown for the metric.
A change type is not applicable to the metric.
The metric is a counter metric (i.e. ever increasing from 0 and wraps to 0).
The metric is a gauge metric (i.e. floats between minimum and maximum value).
The metric is a value calculated based on an underlying base metric. This change type must be used for metrics of type aggregation metric definition. It shall not be used for any metric wich is not of type aggregation metric definition.
Indicates the time scope to which the metric value applies.
A time scope is not defined or unknown for the metric.
The metric applies to a point in time.
The metric applies to a time interval.
The metric applies to a time interval that began at the startup of the measured resource.
Indicates how the metric values are gathered by the underlying
instrumentation.
A gathering type is not defined or unknown for the metric.
The metric values get updated immediately when the values inside of the measured resource change.
The metric values get updated periodically.
The metric values get updated only when the metric is read.
If metric values of this metric definition are collected by sampling at regular intervals,
this element indicates the duration of the sampling interval. Otherwise, this element shall not be specified.
If specified, the format of this element shall be the CIM datetime interval format defined in DSP0004.
Indicates the minimal required accuracy of the values reported for this metric, in
units of the AccuracyUnits element. In other words, the value of the actual accuracy shall be less or equal to the value of the minimal required accuracy.
Identifies the unit of measurement for the ACCURACY element as a
programmatic unit, as defined in DSP0004.
Aggregation metric element which specifies what computation function is performed on the underlying base metrics.
The aggregation metric value reports the lowest value detected for the underlying base metric value.
The aggregation metric value reports the highest value detected for the underlying base metric value.
The aggregation metric value reports the average value of the detected underlying base metric values.
The aggregation metric value reports the median value of the detected underlying base metric values.
The aggregation metric value reports the value which is most frequently detected for the underlying base metric values.