IAlertDataCollector interface

Monitors performance counters and performs actions each time a counter value crosses the specified threshold.

To create the alert data collector, call the IDataCollectorCollection::CreateDataCollector or IDataCollectorCollection::CreateDataCollectorFromXml method. For details on the XML that you pass to CreateDataCollectorFromXml, see Remarks.

Members

The IAlertDataCollector interface inherits from IDataCollector. IAlertDataCollector also has these types of members:

Properties

The IAlertDataCollector interface has these properties.

PropertyDescription

AlertThresholds

Retrieves or sets a list of performance counters to monitor.

EventLog

Retrieves or sets a value that indicates if PLA should log an event each time a counter value crosses the threshold.

SampleInterval

Retrieves or sets the time interval to wait between sampling counter data.

Task

Retrieves or sets the name of a Task Scheduler job to start each time a counter value crosses the threshold.

TaskArguments

Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IAlertDataCollector::Task property.

TaskRunAsSelf

Retrieves or sets a value that determines whether the task runs as the data collector set user or as the user specified in the task.

TaskUserTextArguments

Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IAlertDataCollector::Task property.

TriggerDataCollectorSet

Retrieves or sets the name of a data collector set to start each time a counter value crosses the threshold.

 

Remarks

The following example shows the XML that you can use to initialize this object if you call CreateDataCollectorFromXml to create it. The IDataCollector::Xml property also returns this XML.


<AlertDataCollector>
    <Alert/>              <!-- Specify an <Alert> element for each alert -->
    <AlertDisplayName/>   <!-- Read-only. Contains the contents of -->
                          <!-- <Alert/> in the user's locale -->
    <EventLog/>           <!-- nonzero (true), 0 (false) -->
    <SampleInterval/>
    <Task/>
    <TaskArguments/>
    <TaskRunAsSelf/>
    <TaskUserTextArguments/>
    <TriggerDataCollectorSet/>
</AlertDataCollector>

Note that the example does not show the property elements inherited from IDataCollector that you also need to specify.

When you specify the XML to create the collector, you can specify only the elements for the properties that you want to set. If you do not specify a property, PLA provides a default value. When you retrieve the XML for the collector, the XML provides all elements, including those from IDataCollector.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Pla.h

DLL

Pla.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft