Windows default checks and policies
Agent Client Collector provides the following default checks and policies for Windows health monitoring.
Windows event monitoring checks
| Check | Description | Usage and Example | Output |
|---|---|---|---|
| os.windows.check-event-log | Measures the Windows event log against parameter thresholds and returns a CRITICAL\WARNING\OK event. |
Usage:
Usage example: |
Check Event Log OK: The Event Log that matches the pattern is <matched count> |
| os.windows.check-event-log-count | Measures the Windows event log against parameter thresholds and returns a CRITICAL\WARNING\OK event. Provides information on the number of events that have occurred within a specified duration for a single log file and a single ID. Also indicates the filters to be applied to retrieve events for a specific single-valued windows event level and provider name. Retrieving events from multiple log files is not supported. The number of events is provided, without details of each and every event. |
Usage:
Usage example: |
Check Event Log OK: The Event Log that matches the pattern is <matched count> |
| os.windows.check-event-log-details |
Collects and filters Windows Event logs based on the Retrieves and filters Windows event logs according to the provided parameters. It returns details about the events with CRITICAL, WARNING, or OK status, based on the specified severity level. |
Usage:
Usage example: |
Check Event Log Details WARNING: Type: Information, Category: Application, Machine: ws19-inc0061393.LOCAL.LAB, Event_ID: 1704, Message: Security policy in the Group policy objects has been applied successfully., TimeCreated: 10/14/2024 12:09:35 AM. Type: Information, Category: Application, Machine: ws19-inc0061393.LOCAL.LAB, Event_ID: 16384, Message: Successfully scheduled Software Protection service for restart at 2124-09-20T06:25:44Z. Reason: Rules Engine, TimeCreated: 10/13/2024 11:25:44 PM. Type: Information, Category: Application, Machine: ws19-inc0061393.LOCAL.LAB, Event_ID: 16394, Message: Offline downlevel migration succeeded., TimeCreated: 10/13/2024 11:24:19 PM. Type: Information, Category: Application, Machine: ws19-inc0061393.LOCAL.LAB, Event_ID: 8224, Message: The VSS service is shutting down due to idle timeout., TimeCreated: 10/13/2024 11:51:36 AM. |
| os.windows.check-disk-name | Takes the storage drive name as input and verifies if the drive is present. Returns a CRITICAL\WARNING\OK value based on the parameter provided. |
winchecks check-windows-disk-name <options> -d : Disk name (Default = C) Usage example: |
Windows Checks OK: Disk storage C is present. |
| os.windows.check-processor-queue-length |
Measures the process queue length against thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Processor Queue Length OK: The Processor Queue length is 0.00 |
| os.windows.check-system-cpu-load |
Checks CPU Load by using typeperf. Measures the CPU load against configured thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
CPU Load OK: The total CPU utilization is 26.92% |
| os.windows.check-system-disk |
Measures the free physical memory against thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Disk Usage Check OK: The disk usage is % |
| os.windows.check-system-memory-percent |
Collects the RAM usage. Measures the memory usage against configured thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
RAM Usage OK: The total memory utilization is 84% |
| os.windows.check-system-process |
Query running processes to find running processes that match the given arguments (pattern, name, both pattern and name. At least one must be given). Measures the running processes against configured thresholds and filters, returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Check Process OK: OK Found 1 matching running processes named explorer |
| os.windows.check-directory | Verifies whether a Windows directory exists. |
Usage: -d --directory Path to the relevant directory; use '\' for separation. Usage example: |
Check Directory OK: The directory 'C:/Users/Public' exists |
| os.windows.check-pagefile |
Collects the Pagefile usage and compares it against the WARNING and CRITICAL thresholds. |
Usage:
Usage example: |
Check Windows Page File OK: Page file usage at 31.63% |
| os.windows.check-free-physical-memory |
Measures the free physical memory against configured thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Free Physical Memory OK: The Free Physical Memory is 20.25% |
| os.windows.check-free-virtual-memory |
Measures the free virtual memory against configured thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Free Virtual Memory OK: The Free Virtual Memory is 25.66% |
| os.windows.check-process-cpu |
Processes CPU usage against configured thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Check Process CPU OK: Process CPU usage is 0.0000% |
| os.windows.check-process-memory |
Processes memory usage against thresholds and returns a CRITICAL\WARNING\OK event according to the thresholds given in the accompanying parameters. |
Usage:
Usage example: |
Check Process Memory OK: Process Memory usage is 0.0149% |
| os.windows.check-user-account |
Takes the list of user names as an input and verifies whether the user account is active. Returns a CRITICAL\WARNING\OK value. |
winchecks check-windows-user-disabled (options) -u : Comma separated List of User Name Usage example: |
User Name and Status |
Windows metric monitoring checks
| Check | Description | Usage and Example | Output |
|---|---|---|---|
| os.windows.check-processor-queue-length | Measures the processor queue length. | Usage: -s scheme - Replaces output's hostname + process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.cpu.queuelength 0.00 1645371109 |
| os.windows.check-system-cpu-load | Collects average CPU load per second. | Usage: -s scheme - Replaces output's hostname + process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.cpu.loadavgsec 15.07 1645371561 |
| os.windows.check-system-cpu | Collects the CPU core metric. | Usage: -s , scheme Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.cpu.cpu0.cores 2 1645371681 |
| os.windows.check-system-disk-usage | Collects the following disk usage metrics usage:
|
Usage:
Usage example: |
win2019-dc-64bit.disk_usage.disk_C.total(GB) 99.40 1645371774 win2019-dc-64bit.disk_usage.disk_C.used(GB) 50.72 1645371774 win2019-dc-64bit.disk_usage.disk_C.avail(GB) 48.68 1645371774 win2019-dc-64bit.disk_usage.disk_C.used_percentage 51.02 1645371774 |
| os.windows.check-system-memory-percent | Collects RAM percentage usage, Free Physical Memory percentage and Free Virtual Memory percentage. |
Usage: -s, scheme - Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.mem.free_physical_percentage 13.30 1645371856 win2019-dc-64bit.mem.free_virtual_percentage 13.93 1645371856 win2019-dc-64bit.ram.usage_percentage 86.07 1645371856 |
| os.windows.check-system-network | Collects the following active network adapter metrics:
|
Usage: -s scheme: Replaces output's hostname + process with the given value (example: hostname.process) Usage name: |
win2019-dc-64bit.system.network.Network_Interface(Intel[R]_82574L_Gigabit_Network_Connection).<metric name><metric value>Bytes_Total/sec 98742.67 1645372042 For example: win2019-dc-64bit.system.network.Network_Interface(Intel[R]_82574L_Gigabit_Network_Connection).Bytes_Total/sec 98742.67 1645372042 |
| os.windows.check-system-uptime | Collects system uptime. | Usage: -s, scheme - Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.system.uptime(sec) 4614142.06 1645372124 |
| os.windows.check-system-disk | Collects the following disk metrics:
|
Usage:
Usage example: |
win2019-dc-64bit.disk._total.AvgDisksec/Read 0.000000 1645372198 win2019-dc-64bit.disk._total.AvgDisksec/Write 0.000608 1645372198 win2019-dc-64bit.disk._total.DiskReadBytes/sec 0.000000 1645372198 win2019-dc-64bit.disk._total.DiskWriteBytes/sec 34941.692255 1645372198 win2019-dc-64bit.disk.C.AvgDisksec/Read 0.000000 1645372200 win2019-dc-64bit.disk.C.AvgDisksec/Write 0.000000 1645372200 win2019-dc-64bit.disk.C.DiskReadBytes/sec 0.000000 1645372200 win2019-dc-64bit.disk.C.DiskWriteBytes/sec 0.000000 1645372200 |
| os.windows.check-system-memory | Collects the following disk metrics:
|
Usage: -s, scheme - Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.mem.free_physical(KB) 1175440.00 1645372274 win2019-dc-64bit.mem.total_physical(KB) 8588898304.00 1645372274 win2019-dc-64bit.mem.free_virtual(KB) 1747636.00 1645372274 win2019-dc-64bit.mem.total_virtual(KB) 12263156.00 1645372274 win2019-dc-64bit.mem.available(KB) 1202032640.00 1645372274 win2019-dc-64bit.mem.total_visible(KB) 8387596.00 1645372274 |
| os.windows.check-process-status | Collects windows process status with CPU and memory data used by the process. | Usage:
|
win2019-dc-64bit.Process.Status 67 1645372421 win2019-dc-64bit.Process.CpuPercent 0 1645372421 win2019-dc-64bit.Process.Memory(KB) 1226444 1645372421 |
| os.windows.metrics-process-status | Retrieves the number of running instances, the percentage of CPU utilization, and the memory usage (in kilobytes) of the specified Windows process. |
Usage:
Usage example: |
WIN-R493MKFE75G.Process.Status 1 1625478491 WIN-R493MKFE75G.Process.CpuPercent 0 1625478491 WIN-R493MKFE75G.Process.MemoryKB 276 162547849 |
Windows OS event checks - Extended
| Check | Description | Usage and Example | Output |
|---|---|---|---|
| os.windows.check-processor-queue-length | Measures the processor queue length. |
Usage: -s scheme - Replaces output's hostname + process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.cpu.queuelength 0.00 1645371109 |
| os.windows.check-system-cpu | Collects the CPU core metric. |
Usage: -s , scheme Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.cpu.cpu0.cores 2 1645371681 |
| os.windows.check-system-cpu-load | Collects average CPU load per second. |
Usage: -s scheme - Replaces output's hostname + process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.cpu.loadavgsec 15.07 1645371561 |
| os.windows.check-system-disk-usage |
Collects the following disk usage metrics usage:
|
Usage:
Usage example: |
win2019-dc-64bit.disk_usage.disk_C.total(GB) 99.40 1645371774 win2019-dc-64bit.disk_usage.disk_C.used(GB) 50.72 1645371774 win2019-dc-64bit.disk_usage.disk_C.avail(GB) 48.68 1645371774 win2019-dc-64bit.disk_usage.disk_C.used_percentage 51.02 1645371774 |
| os.windows.check-system-memory-percent |
Collects RAM percentage usage, Free Physical Memory percentage and Free Virtual Memory percentage. |
Usage: -s, scheme - Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.mem.free_physical_percentage 13.30 1645371856 win2019-dc-64bit.mem.free_virtual_percentage 13.93 1645371856 win2019-dc-64bit.ram.usage_percentage 86.07 1645371856 |
| os.windows.check-system-network | Collects the following active network adapter metrics:
|
Usage: -s scheme: Replaces output's hostname + process with the given value (example: hostname.process) Usage name: |
win2019-dc-64bit.system.network.Network_Interface(Intel[R]_82574L_Gigabit_Network_Connection).<metric name><metric value>Bytes_Total/sec 98742.67 1645372042 For example: win2019-dc-64bit.system.network.Network_Interface(Intel[R]_82574L_Gigabit_Network_Connection).Bytes_Total/sec 98742.67 1645372042 |
| os.windows.check-system-uptime | Collects system uptime. |
Usage: -s, scheme - Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.system.uptime(sec) 4614142.06 1645372124 |
| os.windows.check-system-disk | Collects the following disk metrics:
|
Usage:
Usage example: |
win2019-dc-64bit.disk._total.AvgDisksec/Read 0.000000 1645372198 win2019-dc-64bit.disk._total.AvgDisksec/Write 0.000608 1645372198 win2019-dc-64bit.disk._total.DiskReadBytes/sec 0.000000 1645372198 win2019-dc-64bit.disk._total.DiskWriteBytes/sec 34941.692255 1645372198 win2019-dc-64bit.disk.C.AvgDisksec/Read 0.000000 1645372200 win2019-dc-64bit.disk.C.AvgDisksec/Write 0.000000 1645372200 win2019-dc-64bit.disk.C.DiskReadBytes/sec 0.000000 1645372200 win2019-dc-64bit.disk.C.DiskWriteBytes/sec 0.000000 1645372200 |
| os.windows.check-system-memory | Collects the following disk metrics:
|
Usage: -s, scheme - Replaces output's hostname+process with the given value (example: hostname.process) Usage example: |
win2019-dc-64bit.mem.free_physical(KB) 1175440.00 1645372274 win2019-dc-64bit.mem.total_physical(KB) 8588898304.00 1645372274 win2019-dc-64bit.mem.free_virtual(KB) 1747636.00 1645372274 win2019-dc-64bit.mem.total_virtual(KB) 12263156.00 1645372274 win2019-dc-64bit.mem.available(KB) 1202032640.00 1645372274 win2019-dc-64bit.mem.total_visible(KB) 8387596.00 1645372274 |
| os.windows.check-process-status | Collects windows process status with CPU and memory data used by the process. |
Usage:
|
win2019-dc-64bit.Process.Status 67 1645372421 win2019-dc-64bit.Process.CpuPercent 0 1645372421 win2019-dc-64bit.Process.Memory(KB) 1226444 1645372421 |