Performance Logs and Alerts
Overview of the Performance Logs and Alerts technology.
To develop Performance Logs and Alerts, you need these headers:
For programming guidance for this technology, see:
Enumerations
| AutoPathFormat Defines how to decorate the file name or subdirectory name. |
| ClockType Defines the clock resolution to use when tracing events. |
| CommitMode Defines the action to take when committing changes to the data collector set. |
| DataCollectorSetStatus Defines the running status of the data collector set. |
| DataCollectorType Defines the data collector types. |
| DataManagerSteps Defines the actions that the data manager takes when it runs. |
| FileFormat Defines the format of the data in the log file. |
| FolderActionSteps Defines the action that the data manager takes when both the age and size limits are met. |
| ResourcePolicy Defines how folders are deleted when one of the disk resource limits is exceeded. |
| StreamMode Defines where the trace events are delivered. |
| ValueMapType Defines the type of the value. |
| WeekDays Defines the days of the week on which to run the data collector set. |
Functions
| Add Adds a data collector to the collection. |
| Add Adds a data collector set to the collection. |
| Add Adds a folder action to the collection. |
| Add Adds a schedule to the collection. |
| Add Adds a trace provider to the collection. |
| Add Adds an item to the collection. (IValueMap.Add) |
| AddRange Adds one or more data collectors to the collection. |
| AddRange Adds one or more data collector sets to the collection. |
| AddRange Adds one or more folder actions to the collection. |
| AddRange Adds one or more schedules to the collection. |
| AddRange Adds one or more trace providers to the collection. |
| AddRange Adds one or more items to the collection. |
| Clear Removes all data collectors from the collection. |
| Clear Removes all data collector sets from the collection. |
| Clear Removes all folder actions from the collection. |
| Clear Removes all schedules from the collection. |
| Clear Removes all trace providers from the collection. |
| Clear Removes all items from the collection |
| Commit Saves, updates, or validates the data collector set. You can also use this method to flush a trace session. |
| CreateDataCollector Creates a data collector of the specified type. |
| CreateDataCollectorFromXml Creates a data collector using the specified XML. |
| CreateFolderAction Creates a folder action object. |
| CreateSchedule Creates a schedule object. |
| CreateTraceDataProvider Creates a trace data provider object. |
| CreateValueMapItem Creates a value map item. |
| Delete Deletes the persisted copy of the data collector set if the set is not running. |
| Extract Extracts the specified CAB file. |
| get__NewEnum Retrieves an interface to the enumeration. (IDataCollectorCollection.get__NewEnum) |
| get__NewEnum Retrieves an interface to the enumeration. (IDataCollectorSetCollection.get__NewEnum) |
| get__NewEnum Retrieves an interface to the enumeration. (IFolderActionCollection.get__NewEnum) |
| get__NewEnum Retrieves an interface to the enumeration. (IScheduleCollection.get__NewEnum) |
| get__NewEnum Retrieves an interface to the enumeration. (ITraceDataProviderCollection.get__NewEnum) |
| get__NewEnum Retrieves an interface to the enumeration. (IValueMap.get__NewEnum) |
| get_Actions Retrieves or sets the actions that the data manager is to take if both conditions (age and size) are met. (Get) |
| get_Age Retrieves or sets the interval to wait between applying the actions. (Get) |
| get_AlertThresholds Retrieves or sets a list of performance counters and thresholds to monitor. (Get) |
| get_BufferSize Retrieves or sets the suggested buffer size for each buffer in the event tracing session. (Get) |
| get_BuffersLost Retrieves the number of buffers that were not written to the log file. |
| get_BuffersWritten Retrieves the number of buffers written to the log file. |
| get_CheckBeforeRunning Retrieves or sets a value that indicates whether the data manager should check imposed limits, such as the minimum available free disk space, before collecting data. (Get) |
| get_ClockType Retrieves or sets the clock resolution to use when logging the time stamp for each event. (Get) |
| get_Count Retrieves the number of data collectors in the collection. |
| get_Count Retrieves the number of data collector sets in the collection. |
| get_Count Retrieves the number of folder actions in the collection. |
| get_Count Retrieves the number of schedules in the collection. |
| get_Count Retrieves the number of trace providers in the collection. |
| get_Count Retrieves the number of items in the collection. (IValueMap.get_Count) |
| get_DataCollectors Retrieves the list of data collectors in this set. |
| get_DataCollectorSet Retrieves the data collector set to which this data collector belongs. |
| get_DataCollectorType Retrieves the type of this data collector, for example, a performance data collector. |
| get_DataManager Retrieves the data manager associated with this data collector set. |
| get_DataSourceName Retrieves or sets the data source name if the log file is an SQL log file. (Get) |
| get_Days Retrieves or sets the days on which the data collector set runs. (Get) |
| get_Description Retrieves or sets the description of the data collector set. The description will be added to all output files as metadata and inserted into Performance Data Helper logs as a comment. (Get) |
| get_Description Retrieves or sets a description of the collection. (Get) |
| get_Description Retrieves or sets a description of the item. (Get) |
| get_DescriptionUnresolved Retrieves the description of the data collector set in its original form. |
| get_DisplayName Retrieves or sets the display name of the data collector set. (Get) |
| get_DisplayName Retrieves or sets the display name of the provider. (Get) |
| get_DisplayNameUnresolved Retrieves the display name of the data collector set in its original form. |
| get_Duration Retrieves and sets the duration that the data collector set runs. (Get) |
| get_Enabled Retrieves or sets a value that indicates whether the data manager is enabled to run. (Get) |
| get_Enabled Retrieves or sets a value that indicates whether the item is enabled. (Get) |
| get_EndDate Retrieves or sets the last date that the schedule is valid. (Get) |
| get_EventLog Retrieves or sets a value that indicates if PLA should log an event each time the counter value crosses the threshold. (Get) |
| get_EventsFileName Retrieves or sets the name for the events file. (Get) |
| get_EventsLost Retrieves the number of events that were not written to the buffer. |
| get_ExcludeApis Retrieves or sets the list of functions to exclude from the trace. (Get) |
| get_ExePath Retrieves or sets the path to the executable file whose API calls you want to trace. (Get) |
| get_ExtendedModes Retrieves or sets the extended log file modes. (Get) |
| get_FileMaxCount Retrieves or sets the maximum number of files to collect. (Get) |
| get_FileMaxRecursiveDepth Retrieves or sets the maximum number of subfolders from which to recursively collect files. (Get) |
| get_FileMaxTotalSize Retrieves or sets the maximum total file size of all files combined that you can collect. (Get) |
| get_FileName Retrieves or sets the base name of the file that will contain the data collector data. (Get) |
| get_FileNameFormat Retrieves or sets flags that describe how to decorate the file name. (Get) |
| get_FileNameFormatPattern Retrieves or sets the format pattern to use when decorating the file name. (Get) |
| get_Files Retrieves or sets the files to collect. (Get) |
| get_FilterData Retrieves or sets arbitrary data that is sent to the trace data provider for filtering purposes. (Get) |
| get_FilterEnabled Retrieves or sets a value that determines whether the filter data is used to enable the provider. (Get) |
| get_FilterType Retrieves or sets a provider-defined filter type. (Get) |
| get_FlushTimer Retrieves or sets the time to wait before flushing buffers. (Get) |
| get_FolderActions Retrieves a collection that you use to manage the actions to take on each folder in the data collector set when the age and size conditions are met. |
| get_FreeBuffers Retrieves the number of buffers that are allocated but unused in the event tracing session's buffer pool. |
| get_Guid Retrieves or sets the session GUID. (Get) |
| get_Guid Retrieves or sets the provider's GUID. (Get) |
| get_IncludeApis Retrieves or sets the list of functions to include in the trace. (Get) |
| get_IncludeModules Retrieves or sets the list of modules to include in the trace. (Get) |
| get_Index Retrieves the index value of the data collector. The index value identifies the data collector within the data collector set. |
| get_IsKernelTrace Retrieves a value that indicates whether the trace contains kernel providers. |
| get_Item Retrieves the requested data collector from the collection. |
| get_Item Retrieves the requested data collector set from the collection. |
| get_Item Retrieves the requested folder action from the collection. |
| get_Item Retrieves the requested schedule from the collection. |
| get_Item Retrieves the requested trace provider from the collection. |
| get_Item Retrieves the requested item from the collection. (IValueMap.get_Item) |
| get_Key Retrieves or sets the name of the item. (Get) |
| get_Keywords Retrieves or sets keywords that describe the data collector set. The list of keywords is added to the output files as metadata. (Get) |
| get_KeywordsAll Retrieves the list of keywords that restricts the category of events that you want the provider to write. |
| get_KeywordsAny Retrieves the list of keywords that determine the category of events that you want the provider to write. |
| get_LatestOutputLocation Retrieves or sets the fully decorated file name that PLA used the last time it created the file. (IDataCollector.get_LatestOutputLocation) |
| get_LatestOutputLocation Retrieves or sets the fully decorated folder name that PLA used the last time logs were written. (IDataCollectorSet.get_LatestOutputLocation) |
| get_Level Retrieves the level of information used to enable the provider. |
| get_LogApiNamesOnly Retrieves or sets a value that indicates whether PLA logs only the function name. (Get) |
| get_LogApisRecursively Retrieves or sets a value that indicates whether API tracing logs calls that are imported directly by the application. (Get) |
| get_LogAppend Retrieves or sets a value that indicates if PLA should append the collected data to the current file. (Get) |
| get_LogCircular Retrieves or sets a value that indicates if PLA should create a circular file. (Get) |
| get_LogFileFormat Retrieves or sets the format of the log file. (Get) |
| get_LogFilePath Retrieves or sets the name of the log file that contains the API trace data. (Get) |
| get_LogOverwrite Retrieves or sets a value that indicates if PLA should overwrite the current file. (Get) |
| get_ManagementQueries Retrieves or sets Windows Management Instrumentation (WMI) queries to run. (Get) |
| get_MaxFolderCount Retrieves or sets the maximum number of folders to be used by all data collectors in the set. (Get) |
| get_MaximumBuffers Retrieves or sets the maximum number of buffers allocated for the event tracing session's buffer pool. (Get) |
| get_MaxSize Retrieves or sets the maximum disk space to be used by all data collectors in the set. (Get) |
| get_MinFreeDisk Retrieves or sets the minimum free disk space that needs to exist before data collection begins. (Get) |
| get_MinimumBuffers Retrieves or sets the minimum number of buffers allocated for the event tracing session's buffer pool. (Get) |
| get_Name Retrieves or sets the name of the data collector. (Get) |
| get_Name Retrieves the unique name used to identify the data collector set. |
| get_NumberOfBuffers Retrieves or sets the suggested number of buffers to use for logging. (Get) |
| get_OutputLocation Retrieves the decorated file name if PLA were to create it now. |
| get_OutputLocation Retrieves the decorated folder name if PLA were to create it now. |
| get_PerformanceCounters Retrieves or sets the performance counters to query. (Get) |
| get_PreallocateFile Retrieves or sets a value that indicates whether PLA should allocate the entire log file size before logging. (Get) |
| get_ProcessMode Retrieves or sets a value that indicates whether the session is a private, in-process session. (Get) |
| get_Properties Retrieves the list of extended data items that Event Tracing for Windows (ETW) includes with the event. |
| get_QueryNetworkAdapters Retrieves or sets a value that indicates whether the installed network adapters are queried for their offloading capabilities and other configuration information. (Get) |
| get_RealTimeBuffersLost Retrieves the number of buffers that were not delivered in real time to the consumer. |
| get_RegistryKeys Retrieves or sets a list of registry keys to collect. |
| get_RegistryMaxRecursiveDepth Retrieves or sets the maximum number of subkeys from which to recursively collect registry values. (Get) |
| get_ReportFileName Retrieves or sets the name of the HTML file that results from converting the file in the IDataManager::RuleTargetFileName property from XML to HTML. (Get) |
| get_ReportSchema Retrieves or sets the schema used to customize the report that the TraceRpt.exe application generates. (Get) |
| get_ResourcePolicy Retrieves or sets the action to take when one of the disk resource limits is exceeded. (Get) |
| get_RootPath Retrieves or sets the base path where the subdirectories are created. (Get) |
| get_Rules Retrieves or sets the rules to apply to the report. (Get) |
| get_RuleTargetFileName Retrieves or sets the name of the report file that the TraceRpt.exe application creates. (IDataManager.get_RuleTargetFileName) |
| get_SampleInterval Retrieves or sets the time interval to wait between sampling counter data. (Get) |
| get_SampleInterval Retrieves or sets the interval to wait between sampling counter data. (Get) |
| get_Schedules Retrieves the list of schedules that determine when the data collector set runs. |
| get_SchedulesEnabled Retrieves or sets a value that indicates whether the schedules are enabled. (Get) |
| get_Security Retrieves or sets access control information that determines who can access this data collector set. (Get) |
| get_Segment Retrieves or sets a value that indicates whether PLA creates new logs if the maximum size or segment duration is reached before the data collector set is stopped. (Get) |
| get_SegmentMaxDuration Retrieves or sets the duration that the data collector set can run before it begins writing to new log files. (Get) |
| get_SegmentMaxRecords Retrieves or sets the maximum number of samples to log. (Get) |
| get_SegmentMaxSize Retrieves or sets the maximum size of any log file in the data collector set. (Get) |
| get_SendCabTo Retrieves or sets the destination of the cabinet file if the action is to send a cabinet file. (Get) |
| get_SerialNumber Retrieves or sets the number of times that this data collector set has been started, including segments. (Get) |
| get_Server Retrieves the name of the server where the data collector set is run. |
| get_SessionId Retrieves the session identifier. |
| get_SessionName Retrieves or sets the name of the session. (Get) |
| get_SessionThreadId Retrieves the current thread of the log session, if the thread is running. |
| get_Size Retrieves or sets the minimum folder size that, when exceeded, initiates the actions. (Get) |
| get_StartDate Retrieves or sets the date when the schedule becomes valid. (Get) |
| get_StartTime Retrieves or sets the time of day when the data collector set runs. (Get) |
| get_Status Retrieves the status of the data collector set. |
| get_StopOnCompletion Retrieves or sets a value that determines whether the data collector set stops when all the data collectors in the set are in a completed state. (Get) |
| get_StreamMode Retrieves or sets the logging mode of the trace session. (Get) |
| get_Subdirectory Retrieves or sets a base subdirectory of the root path where the next instance of the data collector set will write its logs. (Get) |
| get_SubdirectoryFormat Retrieves or sets flags that describe how to decorate the subdirectory name. (Get) |
| get_SubdirectoryFormatPattern Retrieves or sets a format pattern to use when decorating the folder name. (Get) |
| get_SystemStateFile Retrieves or sets the name of the file that contains the saved system state. (Get) |
| get_Task Retrieves or sets the name of a Task Scheduler job to start each time the counter value crosses the threshold. (Get) |
| get_Task Retrieves or sets the name of a Task Scheduler job to start each time the data collector set stops, including between segments. (Get) |
| 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) |
| get_TaskArguments Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IDataCollectorSet::Task property. (Get) |
| 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) |
| 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. (IDataCollectorSet.get_TaskRunAsSelf) |
| 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) |
| get_TaskUserTextArguments Retrieves or sets the command-line arguments that are substituted for the {usertext} substitution variable in the IDataCollectorSet::TaskArguments property. (Get) |
| get_TraceDataProviders Retrieves the list of providers enabled for this trace session. |
| get_TriggerDataCollectorSet Retrieves or sets the name of a data collector set to start each time the counter value crosses the threshold. (Get) |
| get_UserAccount Retrieves the user account under which the data collector set will run. |
| get_Value Retrieves or sets the value of the collection. (Get) |
| get_Value Retrieves or sets the value of the item. (Get) |
| get_ValueMapType Retrieves or sets the type of items in the collection. (Get) |
| get_ValueMapType Retrieves or sets the type of the item. (Get) |
| get_Xml Retrieves an XML string that describes the values of the data collector properties. |
| get_Xml Retrieves an XML string that describes the values of the data collector set properties, including those of the data collectors contained in the set. |
| GetDataCollectorSets Populates the data collector set collection. |
| GetRegisteredProcesses Retrieves a list of processes that have registered as an Event Tracing for Windows (ETW) provider. |
| GetSecurity Retrieves the security information for the trace data provider. |
| GetTraceDataProviders Populates the collection with registered trace providers. |
| GetTraceDataProvidersByProcess Populates the collection with the list of providers that have been registered by the specified process. |
| GetValue Retrieves a user-defined value. |
| put_Actions Retrieves or sets the actions that the data manager is to take if both conditions (age and size) are met. (Put) |
| put_Age Retrieves or sets the interval to wait between applying the actions. (Put) |
| put_AlertThresholds Retrieves or sets a list of performance counters and thresholds to monitor. (Put) |
| put_BufferSize Retrieves or sets the suggested buffer size for each buffer in the event tracing session. (Put) |
| put_CheckBeforeRunning Retrieves or sets a value that indicates whether the data manager should check imposed limits, such as the minimum available free disk space, before collecting data. (Put) |
| put_ClockType Retrieves or sets the clock resolution to use when logging the time stamp for each event. (Put) |
| put_DataSourceName Retrieves or sets the data source name if the log file is an SQL log file. (Put) |
| put_Days Retrieves or sets the days on which the data collector set runs. (Put) |
| put_Description Retrieves or sets the description of the data collector set. The description will be added to all output files as metadata and inserted into Performance Data Helper logs as a comment. (Put) |
| put_Description Retrieves or sets a description of the collection. (Put) |
| put_Description Retrieves or sets a description of the item. (Put) |
| put_DisplayName Retrieves or sets the display name of the data collector set. (Put) |
| put_DisplayName Retrieves or sets the display name of the provider. (Put) |
| put_Duration Retrieves and sets the duration that the data collector set runs. (Put) |
| put_Enabled Retrieves or sets a value that indicates whether the data manager is enabled to run. (Put) |
| put_Enabled Retrieves or sets a value that indicates whether the item is enabled. (Put) |
| put_EndDate Retrieves or sets the last date that the schedule is valid. (Put) |
| put_EventLog Retrieves or sets a value that indicates if PLA should log an event each time the counter value crosses the threshold. (Put) |
| put_EventsFileName Retrieves or sets the name for the events file. (Put) |
| put_ExcludeApis Retrieves or sets the list of functions to exclude from the trace. (Put) |
| put_ExePath Retrieves or sets the path to the executable file whose API calls you want to trace. (Put) |
| put_ExtendedModes Retrieves or sets the extended log file modes. (Put) |
| put_FileMaxCount Retrieves or sets the maximum number of files to collect. (Put) |
| put_FileMaxRecursiveDepth Retrieves or sets the maximum number of subfolders from which to recursively collect files. (Put) |
| put_FileMaxTotalSize Retrieves or sets the maximum total file size of all files combined that you can collect. (Put) |
| put_FileName Retrieves or sets the base name of the file that will contain the data collector data. (Put) |
| put_FileNameFormat Retrieves or sets flags that describe how to decorate the file name. (Put) |
| put_FileNameFormatPattern Retrieves or sets the format pattern to use when decorating the file name. (Put) |
| put_Files Retrieves or sets the files to collect. (Put) |
| put_FilterData Retrieves or sets arbitrary data that is sent to the trace data provider for filtering purposes. (Put) |
| put_FilterEnabled Retrieves or sets a value that determines whether the filter data is used to enable the provider. (Put) |
| put_FilterType Retrieves or sets a provider-defined filter type. (Put) |
| put_FlushTimer Retrieves or sets the time to wait before flushing buffers. (Put) |
| put_Guid Retrieves or sets the session GUID. (Put) |
| put_Guid Retrieves or sets the provider's GUID. (Put) |
| put_IncludeApis Retrieves or sets the list of functions to include in the trace. (Put) |
| put_IncludeModules Retrieves or sets the list of modules to include in the trace. (Put) |
| put_Key Retrieves or sets the name of the item. (Put) |
| put_Keywords Retrieves or sets keywords that describe the data collector set. The list of keywords is added to the output files as metadata. (Put) |
| put_LatestOutputLocation Retrieves or sets the fully decorated file name that PLA used the last time it created the file. (IDataCollector.put_LatestOutputLocation) |
| put_LatestOutputLocation Retrieves or sets the fully decorated folder name that PLA used the last time logs were written. (IDataCollectorSet.put_LatestOutputLocation) |
| put_LogApiNamesOnly Retrieves or sets a value that indicates whether PLA logs only the function name. (Put) |
| put_LogApisRecursively Retrieves or sets a value that indicates whether API tracing logs calls that are imported directly by the application. (Put) |
| put_LogAppend Retrieves or sets a value that indicates if PLA should append the collected data to the current file. (Put) |
| put_LogCircular Retrieves or sets a value that indicates if PLA should create a circular file. (Put) |
| put_LogFileFormat Retrieves or sets the format of the log file. (Put) |
| put_LogFilePath Retrieves or sets the name of the log file that contains the API trace data. (Put) |
| put_LogOverwrite Retrieves or sets a value that indicates if PLA should overwrite the current file. (Put) |
| put_ManagementQueries Retrieves or sets Windows Management Instrumentation (WMI) queries to run. (Put) |
| put_MaxFolderCount Retrieves or sets the maximum number of folders to be used by all data collectors in the set. (Put) |
| put_MaximumBuffers Retrieves or sets the maximum number of buffers allocated for the event tracing session's buffer pool. (Put) |
| put_MaxSize Retrieves or sets the maximum disk space to be used by all data collectors in the set. (Put) |
| put_MinFreeDisk Retrieves or sets the minimum free disk space that needs to exist before data collection begins. (Put) |
| put_MinimumBuffers Retrieves or sets the minimum number of buffers allocated for the event tracing session's buffer pool. (Put) |
| put_Name Retrieves or sets the name of the data collector. (Put) |
| put_NumberOfBuffers Retrieves or sets the suggested number of buffers to use for logging. (Put) |
| put_PerformanceCounters Retrieves or sets the performance counters to query. (Put) |
| put_PreallocateFile Retrieves or sets a value that indicates whether PLA should allocate the entire log file size before logging. (Put) |
| put_ProcessMode Retrieves or sets a value that indicates whether the session is a private, in-process session. (Put) |
| put_QueryNetworkAdapters Retrieves or sets a value that indicates whether the installed network adapters are queried for their offloading capabilities and other configuration information. (Put) |
| put_RegistryKeys Retrieves or sets a list of registry keys to collect. (Put) |
| put_RegistryMaxRecursiveDepth Retrieves or sets the maximum number of subkeys from which to recursively collect registry values. (Put) |
| put_ReportFileName Retrieves or sets the name of the HTML file that results from converting the file in the IDataManager::RuleTargetFileName property from XML to HTML. (Put) |
| put_ReportSchema Retrieves or sets the schema used to customize the report that the TraceRpt.exe application generates. (Put) |
| put_ResourcePolicy Retrieves or sets the action to take when one of the disk resource limits is exceeded. (Put) |
| put_RootPath Retrieves or sets the base path where the subdirectories are created. (Put) |
| put_Rules Retrieves or sets the rules to apply to the report. (Put) |
| put_RuleTargetFileName Retrieves or sets the name of the report file that the TraceRpt.exe application creates. (IDataManager.put_RuleTargetFileName) |
| put_SampleInterval Retrieves or sets the time interval to wait between sampling counter data. (Put) |
| put_SampleInterval Retrieves or sets the interval to wait between sampling counter data. (Put) |
| put_SchedulesEnabled Retrieves or sets a value that indicates whether the schedules are enabled. (Put) |
| put_Security Retrieves or sets access control information that determines who can access this data collector set. (Put) |
| put_Segment Retrieves or sets a value that indicates whether PLA creates new logs if the maximum size or segment duration is reached before the data collector set is stopped. (Put) |
| put_SegmentMaxDuration Retrieves or sets the duration that the data collector set can run before it begins writing to new log files. (Put) |
| put_SegmentMaxRecords Retrieves or sets the maximum number of samples to log. (Put) |
| put_SegmentMaxSize Retrieves or sets the maximum size of any log file in the data collector set. (Put) |
| put_SendCabTo Retrieves or sets the destination of the cabinet file if the action is to send a cabinet file. (Put) |
| put_SerialNumber Retrieves or sets the number of times that this data collector set has been started, including segments. (Put) |
| put_SessionName Retrieves or sets the name of the session. (Put) |
| put_Size Retrieves or sets the minimum folder size that, when exceeded, initiates the actions. (Put) |
| put_StartDate Retrieves or sets the date when the schedule becomes valid. (Put) |
| put_StartTime Retrieves or sets the time of day when the data collector set runs. (Put) |
| put_StopOnCompletion Retrieves or sets a value that determines whether the data collector set stops when all the data collectors in the set are in a completed state. (Put) |
| put_StreamMode Retrieves or sets the logging mode of the trace session. (Put) |
| put_Subdirectory Retrieves or sets a base subdirectory of the root path where the next instance of the data collector set will write its logs. (Put) |
| put_SubdirectoryFormat Retrieves or sets flags that describe how to decorate the subdirectory name. (Put) |
| put_SubdirectoryFormatPattern Retrieves or sets a format pattern to use when decorating the folder name. (Put) |
| put_SystemStateFile Retrieves or sets the name of the file that contains the saved system state. (Put) |
| put_Task Retrieves or sets the name of a Task Scheduler job to start each time the counter value crosses the threshold. (Put) |
| put_Task Retrieves or sets the name of a Task Scheduler job to start each time the data collector set stops, including between segments. (Put) |
| 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) |
| put_TaskArguments Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IDataCollectorSet::Task property. (Put) |
| 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) |
| 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. (IDataCollectorSet.put_TaskRunAsSelf) |
| 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) |
| put_TaskUserTextArguments Retrieves or sets the command-line arguments that are substituted for the {usertext} substitution variable in the IDataCollectorSet::TaskArguments property. (Put) |
| put_TriggerDataCollectorSet Retrieves or sets the name of a data collector set to start each time the counter value crosses the threshold. (Put) |
| put_Value Retrieves or sets the value of the collection. (Put) |
| put_Value Retrieves or sets the value of the item. (Put) |
| put_ValueMapType Retrieves or sets the type of items in the collection. (Put) |
| put_ValueMapType Retrieves or sets the type of the item. (Put) |
| Query Retrieves the specified data collector set. |
| Query Retrieves details about a registered provider. |
| Remove Removes a data collector from the collection. |
| Remove Removes a data collector set from the collection. |
| Remove Removes a folder action from the collection based on the specified index. |
| Remove Removes a schedule from the collection. |
| Remove Removes a trace provider from the collection. |
| Remove Removes an item from the collection. |
| Resolve Merges the details about a provider with this instance. |
| Run Manually runs the data manager. |
| SetCredentials Specifies the user account under which the data collector set runs. |
| SetSecurity Sets the security information for the trace data provider. |
| SetValue Sets a user-defined value. |
| SetXml Sets the property values of those properties included in the XML. (IDataCollector.SetXml) |
| SetXml Sets the property values of those properties included in the XML. (IDataCollectorSet.SetXml) |
| Start Manually starts the data collector set. |
| Stop Manually stops the data collector set. |
Interfaces
| IAlertDataCollector 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. |
| IApiTracingDataCollector Logs Win32 calls to Kernel32.dll, Advapi32.dll, Gdi32.dll, and User32.dll. |
| IConfigurationDataCollector Collects computer settings at the time of collection. |
| IDataCollector Sets and retrieves collector properties using XML, specifies the log file name, and retrieves the location of the log file.This interface is an abstract class from which the following data collectors derive:IAlertDataCollectorIApiTracingDataCollectorIConfigurationDataCollectorIPerformanceCounterDataCollectorITraceDataCollector |
| IDataCollectorCollection Manages a collection of DataCollector objects.To get this interface, access the IDataCollectorSet::DataCollectors property. |
| IDataCollectorSet Manages the configuration information that is common to all data collector objects in the set; adds and removes data collectors from the set; and starts data collection. This is the primary PLA interface that you use. |
| IDataCollectorSetCollection Manages a collection of DataCollectorSet objects.To get this interface, call the CoCreateInstance function, passing __uuidof(DataCollectorSetCollection) as the class identifier and __uuidof(IDataCollectorSetCollection) as the interface identifier.Then, to populate the collection, call the IDataCollectorSetCollection::GetDataCollectorSets method. |
| IDataManager Manages data generated by the data collectors, including report generation, data retention policy, and data transfer.To get this interface, access the IDataCollectorSet::DataManager property. |
| IFolderAction Specifies the actions that the data manager is to take on each folder under the data collector set's root path if both conditions (age and size) are met. To get this interface, call the IFolderActionCollection::CreateFolderAction method. |
| IFolderActionCollection Manages a collection of FolderAction objects.To get this interface, access the IDataManager::FolderActions property. |
| IPerformanceCounterDataCollector Specifies the performance counters to query and the log file to which the counter data is written.To create this data collector, call the IDataCollectorCollection::CreateDataCollector or IDataCollectorCollection::CreateDataCollectorFromXml method. |
| ISchedule Specifies when the data collector set runs.To get this interface, call the IScheduleCollection::CreateSchedule method. |
| IScheduleCollection Manages a collection of Schedule objects.To get this interface, access the IDataCollectorSet::Schedules property. |
| ITraceDataCollector Collects trace events from registered providers.This interface defines the trace session. |
| ITraceDataProvider Specifies a trace provider to enable in the trace session. |
| ITraceDataProviderCollection Manages a collection of TraceDataProvider objects.To get this interface, access the ITraceDataCollector::TraceDataProviders property.You can also call the CoCreateInstance function to create a new instance of the TraceDataProviderCollection object. |
| IValueMap Manages a collection of name/value pairs.To get this interface, access one of the following properties or methods:IDataCollector::SetXmlIDataCollectorSet::CommitIDataCollectorSet::SetXmlITraceDataProvider::KeywordsAllITraceDataProvider::KeywordsAnyITraceDataProvider::LevelITraceDataProvider::Properties |
| IValueMapItem Defines a name/value pair.To get this interface, call the IValueMap::Item property. To create this interface, call the IValueMap::CreateValueMapItem method. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for