Skip to content

Commit f3313bf

Browse files
committed
Updated docs
Signed-off-by: Michael Medin <michael@medin.name>
1 parent 51f4584 commit f3313bf

11 files changed

Lines changed: 9144 additions & 11146 deletions

File tree

docs/docs/reference/check/CheckDisk.md

Lines changed: 569 additions & 1220 deletions
Large diffs are not rendered by default.

docs/docs/reference/check/CheckNet.md

Lines changed: 898 additions & 2172 deletions
Large diffs are not rendered by default.

docs/docs/reference/check/CheckSystem.md

Lines changed: 2005 additions & 761 deletions
Large diffs are not rendered by default.

docs/docs/reference/index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Type | Module | Description |
66
|---------|-------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
77
| check | [CheckDisk](check/CheckDisk.md) | CheckDisk can check various file and disk related things. |
8-
| misc | [CheckDocker](misc/CheckDocker.md) | Use this module to detect and monitor docker containers |
8+
| misc | [CheckDocker](misc/CheckDocker.md) | Check docker containers (state, health) and the docker daemon itself. |
99
| windows | [CheckEventLog](windows/CheckEventLog.md) | Check for errors and warnings in the event log. |
1010
| check | [CheckExternalScripts](check/CheckExternalScripts.md) | Module used to execute external scripts |
1111
| check | [CheckHelpers](check/CheckHelpers.md) | Various helper function to extend other checks. |
@@ -58,7 +58,7 @@
5858
| CheckDisk | [check_single_file](check/CheckDisk.md#check_single_file) | Check various aspects of a single file (size, age, line count, version, ...). Simpler alternative to check_files when you only need to inspect one specific file. |
5959
| CheckDisk | [check_storagepool](check/CheckDisk.md#check_storagepool) | Check Storage Spaces pool health and capacity (Windows). |
6060
| CheckDisk | [check_uncpath](check/CheckDisk.md#check_uncpath) | Check free space on a UNC path (server share), with optional alternate credentials. |
61-
| CheckDocker | [check_docker](misc/CheckDocker.md#check_docker) | Checks that a given docker container is running. |
61+
| CheckDocker | [check_docker](misc/CheckDocker.md#check_docker) | Check the state of docker containers, optionally requiring specific containers to be running. |
6262
| CheckDocker | [check_docker_df](misc/CheckDocker.md#check_docker_df) | Check docker disk usage: images, containers, volumes, build cache and reclaimable space. |
6363
| CheckDocker | [check_docker_info](misc/CheckDocker.md#check_docker_info) | Check that the docker daemon is healthy: version plus container and image counts. |
6464
| CheckDocker | [check_docker_restarts](misc/CheckDocker.md#check_docker_restarts) | Detect container restart loops and out-of-memory kills. |
@@ -112,11 +112,12 @@
112112
| CheckSystem | [check_cpu](check/CheckSystem.md#check_cpu) | Check that the load of the CPU(s) are within bounds. |
113113
| CheckSystem | [check_cpu_frequency](check/CheckSystem.md#check_cpu_frequency) | Check CPU clock frequency (current vs max) per processor. |
114114
| CheckSystem | [check_cpu_utilization](check/CheckSystem.md#check_cpu_utilization) | Check CPU utilization broken down by user/system/iowait/steal/guest. |
115-
| CheckSystem | [check_hostname](check/CheckSystem.md#check_hostname) | Check host identity: hostname, canonical FQDN and DNS domain, with drift detection for the name mismatches that silently break auth and monitoring. |
116-
| CheckSystem | [check_installed_software](check/CheckSystem.md#check_installed_software) | Check installed software packages via the system package manager (dpkg/rpm/pacman): inventory, unwanted/EOL software policy and recent-install detection. |
117-
| CheckSystem | [check_kernel_memory](check/CheckSystem.md#check_kernel_memory) | Check kernel memory-manager health: slab bytes (reclaimable/unreclaimable), page-cache bytes and page-fault rates — the kernel-leak and fault-storm signals free-RAM thresholds miss. |
118-
| CheckSystem | [check_kernel_stats](check/CheckSystem.md#check_kernel_stats) | Check kernel activity: context-switch rate, fork rate and live thread count. |
119-
| CheckSystem | [check_load](check/CheckSystem.md#check_load) | Check the system load average (1/5/15 minutes). |
115+
| CheckSystem | [check_hardware](check/CheckSystem.md#check_hardware) | Check hardware inventory (vendor, model, serial, chassis type, memory modules) with pinned-expectation alerting: serial changed, DIMM dropped, laptop in a server fleet. |
116+
| CheckSystem | [check_hostname](check/CheckSystem.md#check_hostname) | Check host identity: hostname, FQDN, DNS domain and domain-join state, with drift detection for the name mismatches that silently break auth and monitoring. |
117+
| CheckSystem | [check_installed_software](check/CheckSystem.md#check_installed_software) | Check installed software from the registry Uninstall hives (64-bit, 32-bit and per-user views): inventory, unwanted/EOL software policy and recent-install detection. |
118+
| CheckSystem | [check_kernel_memory](check/CheckSystem.md#check_kernel_memory) | Check kernel memory-manager health: paged/nonpaged pool bytes, file-cache bytes and page-fault rates — the pool-exhaustion and hard-fault-storm signals free-RAM thresholds miss. |
119+
| CheckSystem | [check_kernel_stats](check/CheckSystem.md#check_kernel_stats) | Check system-wide kernel activity: context-switch and system-call rates plus live process and thread counts. |
120+
| CheckSystem | [check_load](check/CheckSystem.md#check_load) | Check the system load average (1/5/15 minutes), synthesised from the processor queue length plus busy cores. |
120121
| CheckSystem | [check_memory](check/CheckSystem.md#check_memory) | Check free/used memory on the system. |
121122
| CheckSystem | [check_network](check/CheckSystem.md#check_network) | Check network interface status. |
122123
| CheckSystem | [check_os_updates](check/CheckSystem.md#check_os_updates) | Check for available Windows updates via the Windows Update Agent (WUA) API. |

0 commit comments

Comments
 (0)