Edit

CIM_BaseMetricDefinition class

  • Article

Represents a metric definition that contains the meta data for a CIM_MetricInstance object.

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Metrics::BaseMetric"), AMENDMENT]
class CIM_BaseMetricDefinition : CIM_ManagedElement
{
  string  Id;
  string  Name;
  uint16  DataType;
  uint16  Calculable;
  string  Units;
  string  BreakdownDimensions[];
  boolean IsContinuous;
  uint16  ChangeType;
  uint16  TimeScope;
  uint16  GatheringType;
  string  ProgrammaticUnits;
};

Members

The CIM_BaseMetricDefinition class has these types of members:

Properties

The CIM_BaseMetricDefinition class has these properties.

BreakdownDimensions

Data type: string array

Access type: Read-only

An array that contains free format strings that can be used to break down queries of CIM_BaseMetricValue objects along a certain dimension. The strings should be meaningful to the end users of the metric data. In addition, the strings should indicate which break down dimensions are supported for the metric definition, by the underlying instrumentation.

An example is a transaction name that allows the break down of the total value for all transactions into a set of values, one for each transaction name. Other examples are an application system, or a user group name.

Calculable

Data type: uint16

Access type: Read-only

The characteristics of the metric used to perform calculations.

Non-calculable (1)

A string. Arithmetic makes no sense.

Summable (2)

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.

Non-summable (3)

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.

ChangeType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_BaseMetricDefinition.IsContinuous")

Indicates how the metric value changes using common attributes such as direction change, minimum and maximum values, and wrapping semantics.

Unknown (0)

The metric designer did not qualify the ChangeType.

N/A (2)

If the "IsContinuous" property is "false", ChangeType does not make sense and MUST be is set to "N/A".

Counter (3)

The metric is a counter metric. These have non-negative integer values which increase monotonically until reaching the maximum representable number and then wrap around and start increasing from 0. Such counters, also known as rollover counters, can be used for instance to count the number of network errors or the number of transactions processed. The only way for a client application to keep track of wrap arounds is to retrieve the value of the counter in appropriately short intervals.

Gauge (4)

The metric is a gauge metric. These have integer or float values that can increase and decrease arbitrarily. A gauge MUST NOT wrap when reaching the minimum or maximum representable number, instead, the value "sticks" at that number. Minimum or maximum values inside of the representable value range at which the metric value "sticks", may or may not be defined.

DMTF Reserved (5..32767)

Vendor Reserved (32768..65535)

DataType

Data type: uint16

Access type: Read-only

The data type of the metric.

boolean (1)

char16 (2)

datetime (3)

real32 (4)

real64 (5)

sint16 (6)

sint32 (7)

sint64 (8)

sint8 (9)

string (10)

uint16 (11)

uint32 (12)

uint64 (13)

uint8 (14)

GatheringType

Data type: uint16

Access type: Read-only

Indicates how the metric values are gathered by the underlying instrumentation.

Unknown (0)

Indicates that the GatheringType is not known.

OnChange (2)

Indicates that the CIM metric values get updated immediately when the values inside of the measured resource change. The values of OnChange metrics truly reflect the current situation within the resource at any time. An example is the number of logged on users that gets updated immediately as users log on and off.

Periodic (3)

": Indicates that the CIM metric values get updated periodically. For instance, to a client application, a metric value applying to the current time will appear constant during each gathering interval, and then jumps to the new value at the end of each gathering interval.

OnRequest (4)

Indicates that the CIM metric value is determined each time a client application reads it. The values of OnRequest metrics truly return the current situation within the resource if somebody asks for it. However, they do not change "unobserved", and therefore subscribing for value changes of OnRequest metrics is NOT RECOMMENDED.

DMTF Reserved (5..32767)

Vendor Reserved (32768..65535)

Id

Data type: string

Access type: Read-only

Qualifiers: Key

The unique ID of the metric definition. Open Software Foundation (OSF) UUID/GUIDs are recommended.

IsContinuous

Data type: boolean

Access type: Read-only

True if the metric value is continuous; otherwise, false.

Name

Data type: string

Access type: Read-only

The name of the metric. This name does not have to be unique, but should be descriptive and may contain blank spaces.

ProgrammaticUnits

Data type: string

Access type: Read-only

The specific units of a value. The value of this property should be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later.

TimeScope

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_BaseMetricValue.TimeStamp", "CIM_BaseMetricValue.Duration")

The time scope that applies to the metric designer.

Unknown (0)

Indicates the time scope was not qualified by the metric designer, or is unknown to the provider.

Point (2)

Indicates that the metric applies to a point in time. On the corresponding BaseMetricValue instances, TimeStamp specifies the point in time and Duration is always 0.

Interval (3)

Indicates that the metric applies to a time interval. On the corresponding BaseMetricValue instances, TimeStamp specifies the end of the time interval and Duration specifies its duration

StartupInterval (4)

Indicates that the metric applies to a time interval that began at the startup of the measured resource (i.e. the ManagedElement associated by MetricDefForMe). On the corresponding BaseMetricValue instances, TimeStamp specifies the end of the time interval. If Duration is 0, this indicates that the startup time of the measured resource is unknown. Else, Duration specifies the duration between startup of the resource and TimeStamp.

DMTF Reserved (5..32767)

Vendor Reserved (32768..65535)

Units

Data type: string

Access type: Read-only

The units of the metric. Examples are bytes, packets, jobs, files, milliseconds, and amps.

Requirements

Requirement Value
Minimum supported client
 Windows 8
Minimum supported server
 Windows Server 2012
Namespace
 Root\virtualization\v2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

CIM_ManagedElement