Share via

Microsoft.Windows.WmiRawPerfCounterProvider

  • Article

Applies To: Operations Manager 2007 R2

The Microsoft.Windows.WmiRawPerfCounterProvider module is a data source module type that is used to query Windows Management Instrumentation (WMI) for raw performance counter data at the specified frequency and return the information as a System.Performance.BaseData type.

Usage

Use this module when you want to query raw performance counter data from a specific WMI performance counter class at a set frequency.

Type Definition

<DataSourceModuleType ID="Microsoft.Windows.WmiRawPerfCounterProvider" Accessibility="Public" Batching="false">
  <Configuration>
    <xsd:element name="NameSpace" type="xsd:string" />
    <xsd:element name="WMIClass" type="xsd:string" />
    <xsd:element name="WhereClause" type="xsd:string" />
    <xsd:element name="ObjectName" type="xsd:string" />
    <xsd:element name="CounterName" type="xsd:string" />
    <xsd:element name="InstanceProperty" type="xsd:string" />
    <xsd:element name="ValueProperty" type="xsd:string" />
    <xsd:element name="ScaleBy" type="xsd:double" minOccurs="0" maxOccurs="1" />
    <xsd:element name="Frequency" type="xsd:unsignedInt" />
  </Configuration>
  <OverrideableParameters>
    <OverrideableParameter ID="Frequency" Selector="$Config/Frequency$" ParameterType="int" />
  </OverrideableParameters>
  <ModuleImplementation Isolation="Any">
    <Composite>
      <MemberModules>
        <DataSource ID="Scheduler" TypeID="System!System.Scheduler">
          <Scheduler>
            <SimpleReccuringSchedule>
              <Interval Unit="Seconds">$Config/Frequency$</Interval>
            </SimpleReccuringSchedule>
            <ExcludeDates />
          </Scheduler>
        </DataSource>
        <ProbeAction ID="Probe" TypeID="Microsoft.Windows.WmiRawPerfCounterProbe">
          <NameSpace>$Config/NameSpace$</NameSpace>
          <WMIClass>$Config/WMIClass$</WMIClass>
          <WhereClause>$Config/WhereClause$</WhereClause>
          <ObjectName>$Config/ObjectName$</ObjectName>
          <CounterName>$Config/CounterName$</CounterName>
          <InstanceProperty>$Config/InstanceProperty$</InstanceProperty>
          <ValueProperty>$Config/ValueProperty$</ValueProperty>
          <ScaleBy>$Config/ScaleBy$</ScaleBy>
        </ProbeAction>
      </MemberModules>
      <Composition>
        <Node ID="Probe">
          <Node ID="Scheduler" />
        </Node>
      </Composition>
    </Composite>
  </ModuleImplementation>
  <OutputType>Performance!System.Performance.Data</OutputType>
</DataSourceModuleType>

Parameters

The Microsoft.Windows.WmiRawPerfCounterProvider module supports the configuration parameters described in the following table.

Parameter Type Overrideable Description

Namespace

String

False

Required parameter. Specifies the WMI namespace within which the module is to run the query.

WMIClass

String

False

Required parameter. Specifies a valid performance counter WMI class against which to perform the query.

WhereClause

String

False

Optional parameter. Specifies the SQL WHERE clause in the query against the WMI class.

ObjectName

String

False

Required parameter. The name of the performance object against to which the selected counter belongs.

CounterName

String

False

Required parameter. The name of the performance counter.

InstanceProperty

String

False

Required parameter. The WMI class property that represents a unique identity of an instance.

ValueProperty

String

False

Required parameter. The WMI class property that supplies the value of the performance data.

ScaleBy

Double

False

Operations Manager 2007 R2 only. Optional parameter. Specifies the scale value of the raw performance counter value to make that value more readable.

Frequency

Unsigned Integer

True

Required parameter. Specifies the frequency in seconds at which the module will query new performance counter data.

For parameter information, see Microsoft.Windows.WmiRawPerfCounterProbe.

Composition

The Microsoft.Windows.WmiRawPerfCounterProvider module is a composite module that contains the member modules described in the following table.

Workflow Run Order Module Type Usage

1

System.Scheduler

Triggers the subsequent probe module to run at a scheduled, recurring interval.

2

Microsoft.Windows.WmiRawPerfCounterProbe

Queries WMI for raw performance counter data at the specified frequency and returns the information as a System.Performance.BaseData type.
Module Type Usage

Microsoft.Windows.WmiPerfCounterProvider

Queries WMI for performance counter data at the specified frequency and returns the information as a System.Performance.BaseData type.

External Module References

None.

Sample

The following example shows how the Microsoft.Windows.WmiRawPerfCounterProvider module is used to collect performance data and store it into the Operations Manager database.

<Rule ID="WmiRawPerfCounterTestRule" Enabled="true" Target="Windows!Microsoft.Windows.Computer" ConfirmDelivery="true">
<Category>Maintenance</Category>
 <DataSources>
   <DataSource ID="DS" TypeID="Windows!Microsoft.Windows.WmiRawPerfCounterProvider">
    <NameSpace>\\$Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$\ROOT\CIMV2</NameSpace>
    <WMIClass>Win32_PerfRawData_PerfProc_Process</WMIClass>
    <WhereClause>Name="Idle"</WhereClause>
    <ObjectName>Process</ObjectName>
    <CounterName>PercentProcessorTime</CounterName>
    <InstanceProperty>Name</InstanceProperty>
    <ValueProperty>PercentProcessorTime</ValueProperty>
    <Frequency>10</Frequency>
  </DataSource>
 </DataSources>
 <WriteActions>
  <WriteAction ID="WA" TypeID="SC!Microsoft.SystemCenter.CollectPerformanceData" />
 </WriteActions>
</Rule>

Information

   

Module Type

DataSourceModuleType

Input Type

None

Output Type

System.PropertyBagData

Implementation

Native

Library

Microsoft.Windows.Library