CIM_BaseMetricValue class

Article
05/31/2018

Represents the instance value of a metric.

Since the gathering of metric information can involve large quantities of information there may be many instances of this class. The use of this class as an instrumentation source may be inefficient unless the rate of metrics are known. The length of time a CIM_BaseMetricValue instance exists after the metric information is captured without being defined, and is implementation dependent.

Most metric data values change over time. There are two ways of mapping this data into CIM_BaseMetricValue objects. The value for the next point in time may use the same object and just change its properties (such as the value or timestamp), or the existing objects remain unchanged and a new object is created for the new point in time. The first method is typically used for snapshot data and the second method for historical data. The method used, is indicated by the Volatile property.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Abstract, Version("2.19.0"), UMLPackagePath("CIM::Metrics::BaseMetric")]
class CIM_BaseMetricValue : CIM_ManagedElement
{
  string   Caption;
  string   Description;
  string   ElementName;
  string   InstanceID;
  string   MetricDefinitionId;
  string   MeasuredElementName;
  datetime TimeStamp;
  datetime Duration;
  string   MetricValue;
  string   BreakdownDimension;
  string   BreakdownValue;
  boolean  Volatile;
};

Members

The CIM_BaseMetricValue class has these types of members:

Properties

Properties

The CIM_BaseMetricValue class has these properties.

BreakdownDimension

Data type: string
Access type: Read-only

The dimension for which this set of metric values is broken down based on BreakdownDimensions property of the associated CIM_BaseMetricDefinition object.

BreakdownValue

Data type: string
Access type: Read-only

The value of the BreakdownDimension property defined for this instance value. For example, if BreakdownDimension contains "TransactionName", this property could name the actual transaction to which this particular metric value applies.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string
Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

Duration

Data type: datetime
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_BaseMetricDefinition.TimeScope", "CIM_BaseMetricValue.TimeStamp")

The time duration over which this metric value is valid. This property should not exist for time stamps that only apply to a point in time, but should be defined for values that are considered valid for a certain time period (ex. sampling). If the Duration property exists and is non-Null, the TimeStamp value should be the end of the interval.

ElementName

Data type: string
Access type: Read-only

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.

This property is inherited from CIM_ManagedElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key, Override ("InstanceID")

Uniquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

MeasuredElementName

Data type: string
Access type: Read-only

A descriptive name for the element that is measure by the metric.

This property is required if the metric definition is not associated with a CIM_ManagedElement object, and may be used in other cases to provide supplemental information. This allows metrics to be captured independent of any CIM_ManagedElement object.

If there are multiple CIM_ManagedElement objects associated with the metric value, then you can choose one of the managed elements to create the supplemental information for the metric. The property is not meant to be used as a foreign key to query the measured element. Instead, the association to the CIM_ManagedElement should be used.

MetricDefinitionId

Data type: string
Access type: Read-only
Qualifiers: Required, ModelCorrespondence ("CIM_BaseMetricDefinition.Id")

The key of the CIM_BaseMetricDefinition instance that is associated with this instance value.

MetricValue

Data type: string
Access type: Read-only
Qualifiers: Required

A string representation of the metric value. The original data type of the metric value is specified in the associated CIM_BaseMetricDefinition object.

TimeStamp

Data type: datetime
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_BaseMetricDefinition.TimeScope", "CIM_BaseMetricValue.Duration")

The time when the value of a metric instance is computed. This is different from the time when the instance is created. If the Volatile property is true, this value changes whenever a new measurement snapshot is taken.

A management application may establish a time series of metric data by retrieving the instances of CIM_BaseMetricValue and sorting them according to their TimeStamp value.

Volatile

Data type: boolean
Access type: Read-only

True if the TimeStamp value changes whenever the value of the metric instance changes. False if this object must remain unchanged and a new object created for the new TimeStamp value.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

Share via

CIM_BaseMetricValue class

Syntax

Members

Properties

Requirements

See also

Additional resources