IAlertDataCollector interface (pla.h)
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.
Inheritance
The IAlertDataCollector interface inherits from the IDataCollector interface.
Methods
The IAlertDataCollector interface has these methods.
| IAlertDataCollector::get_AlertThresholds Retrieves or sets a list of performance counters and thresholds to monitor. (Get) |
| IAlertDataCollector::get_EventLog Retrieves or sets a value that indicates if PLA should log an event each time the counter value crosses the threshold. (Get) |
| IAlertDataCollector::get_SampleInterval Retrieves or sets the time interval to wait between sampling counter data. (Get) |
| IAlertDataCollector::get_Task Retrieves or sets the name of a Task Scheduler job to start each time the counter value crosses the threshold. (Get) |
| IAlertDataCollector::get_TaskArguments Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IAlertDataCollector::Task property. (IAlertDataCollector.get_TaskArguments) |
| IAlertDataCollector::get_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. (IAlertDataCollector.get_TaskRunAsSelf) |
| IAlertDataCollector::get_TaskUserTextArguments Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IAlertDataCollector::Task property. (IAlertDataCollector.get_TaskUserTextArguments) |
| IAlertDataCollector::get_TriggerDataCollectorSet Retrieves or sets the name of a data collector set to start each time the counter value crosses the threshold. (Get) |
| IAlertDataCollector::put_AlertThresholds Retrieves or sets a list of performance counters and thresholds to monitor. (Put) |
| IAlertDataCollector::put_EventLog Retrieves or sets a value that indicates if PLA should log an event each time the counter value crosses the threshold. (Put) |
| IAlertDataCollector::put_SampleInterval Retrieves or sets the time interval to wait between sampling counter data. (Put) |
| IAlertDataCollector::put_Task Retrieves or sets the name of a Task Scheduler job to start each time the counter value crosses the threshold. (Put) |
| IAlertDataCollector::put_TaskArguments Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IAlertDataCollector::Task property. (IAlertDataCollector.put_TaskArguments) |
| IAlertDataCollector::put_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. (IAlertDataCollector.put_TaskRunAsSelf) |
| IAlertDataCollector::put_TaskUserTextArguments Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IAlertDataCollector::Task property. (IAlertDataCollector.put_TaskUserTextArguments) |
| IAlertDataCollector::put_TriggerDataCollectorSet Retrieves or sets the name of a data collector set to start each time the counter value crosses the threshold. (Put) |
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | pla.h |