Task Scheduler
Introduction
The Windows Task Scheduler is a built-in utility in the Windows operating system that allows users to automate the execution of tasks at specified intervals or in response to certain events. It provides a user-friendly interface for creating, managing, and monitoring scheduled tasks, making it easier to automate repetitive or time-sensitive actions without manual intervention.
Getting Started
Compatibility
The Windows Task Scheduler O11ySource is compatible with all versions Microsoft Windows Server 2016 and newer. Minimum PowerShell version 5.1 is required.
Data Collection Method
vuSmartMaps collects health and performance data for Windows Task Scheduler server using VuNet's Healthbeat agent. This agent collects data based on the source configuration.
Prerequisites
Inputs for Configuring Data Source
- Server: The IP Address/FQDN of the Windows server. This field is the key to identify each server you add here.
- Period [in seconds]: How frequently data is gathered. The period should be between 60 seconds – 3000 seconds.
- **Task Path **: Enter the relative path to task(s). Eg: \Microsoft\customtasks\
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
Source IP | Destination IP | Destination Port | Protocol | Direction |
---|---|---|---|---|
IP address of the Windows Server | vuSmartMaps Data Collector End Point | 9092* | TCP | Inbound |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
Please check permissions for task configuration files:
- The extension reads task details directly from their configuration files. These are stored relative to the base location of C:\Windows\System32\Tasks
- Ensure the files of all monitored tasks are readable by the
LOCAL_SERVICE
user account.
Configuration Steps
Enable
the Task Scheduler O11ySource.- Select the Sources tab and press the
+
button to add a new Windows host and task path details to be monitored. - Add the required details and then click on
Next
. - The following packages will be available for download based on the OS:Healthbeat full installer package - Downloads the full Healthbeat package with required configurations for a fresh installationHealthbeat config update package - Downloads the agent configuration package to update an existing Healthbeat installation
- Download the agent installation or update package, then click
Finish
to close the data source window.
Metrics Collected
Name | Description | Data Type |
---|---|---|
host | The IP address of the server | LowCardinality(String) |
target | The IP address of the server | LowCardinality(String) |
taskName | The name of the task | LowCardinality(String) |
author | The author/owner of the task | LowCardinality(String) |
Start_Date | Task start date | String |
lastRunTime | The time when the task last executed | String |
nextRunTime | The time when the task will executed | String |
result | The result of the last execution | Float32 |
taskState | The state of the task(Enabled/Disabled) | String |
scheduleType | The schedule interval(Daily/Weekly/System Startup) | String |
status | The status of the task(Running/Ready) | String |
status_value | The value of the status | UInt8 |
NumberOfMissedRuns | The number of missed runs for the particular task | UInt16 |
NumberOfMissedRuns_diff | Calcualted value for the current time frame | UInt16 |
NumberOfMissedRuns_rate | The rate of missed runs | Float32 |
lastRunBefore | The time since last execution of the job | String |
lastRunBeforeSeconds | The time since last execution of the job in seconds | Float32 |
message | The message based on the result of last execution | String |
taskPath | The path to the task | String |
@timestamp | The timestamp in Elastic format | String |
timestamp | The timestamp data | DateTime64 |
o11ysource_name | Name of the O11ysource | LowCardinality(String) |