From 4e944952eee23353d50a63194b3d5f851fcd7868 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Fri, 23 Sep 2022 09:45:48 +0200 Subject: [PATCH] update docs --- docs/20_Checks/check_cpu.md | 2 +- docs/20_Checks/check_cronstatus.md | 36 ++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/20_Checks/check_cronstatus.md diff --git a/docs/20_Checks/check_cpu.md b/docs/20_Checks/check_cpu.md index 58e5a90..9e931f3 100644 --- a/docs/20_Checks/check_cpu.md +++ b/docs/20_Checks/check_cpu.md @@ -22,7 +22,7 @@ If there are processes with status D they will be shown (to analyze cpu waits). ## Syntax -``$ check_NAME [-c CRITICAL] [-w WARING] [-i CRITICAL_IO]`` +``$ check_cpu [-c CRITICAL] [-w WARING] [-i CRITICAL_IO]`` ### Parameters diff --git a/docs/20_Checks/check_cronstatus.md b/docs/20_Checks/check_cronstatus.md new file mode 100644 index 0000000..19f90ee --- /dev/null +++ b/docs/20_Checks/check_cronstatus.md @@ -0,0 +1,36 @@ +# Check Cronstatus + +## Introduction + +Show status of all Cronjobs using Axels Cronwrapper +https://github.com/axelhahn/cronwrapper + +The last run of each job is verified to these conditions: + +* exitcode was 0 +* last run is younger than given TTL + +## Syntax + +`$ check_cronstatus [-h] [SCRIPT]` + +### Parameters + +```text +OPTIONS: + + -h or --help show this help. + +PARAMETERS: + + SCRIPT optional: custom status script + default: /opt/cronwrapper/cronstatus.sh +``` + +## Examples + +`check_cronstatus` + The Check of cronjobs with the default loction does not require any parameter + +`check_cronstatus /usr/share/cronwrapper/cronstatus.sh` + The Check of cronjobs with custom loction. -- GitLab