From a81a12684f0408af32559f9cd0003556116bebc1 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch> Date: Fri, 7 Jun 2024 09:52:47 +0200 Subject: [PATCH] check_cronjobs: add more details --- docs/20_Checks/check_cronstatus.md | 48 ++++++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/docs/20_Checks/check_cronstatus.md b/docs/20_Checks/check_cronstatus.md index 19f90ee..22f04cf 100644 --- a/docs/20_Checks/check_cronstatus.md +++ b/docs/20_Checks/check_cronstatus.md @@ -3,20 +3,60 @@ ## 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: +📄 Source: <https://github.com/axelhahn/cronwrapper>\ +📜 License: GNU GPL 3.0\ +📖 Docs: see docs folder or online <https://www.axel-hahn.de/docs/cronwrapper/> + +Pre conditions: + +* The cronwrapper must be installed +* Your cronjob(s) must be changed to use the wrapper, eg.\ + `*/60 * * * * /opt/cronwrappre.sh 60 <YOUR_COMMAND>` + +`check_cronstatus` executes the cronstatus.sh in the cronwrapper installation directory and will parse its output. + +In the cronstatus the last run of each job will be verified with these conditions: * exitcode was 0 * last run is younger than given TTL +As output you get a summary of all checks followed by more detailed status per job. + ## Syntax -`$ check_cronstatus [-h] [SCRIPT]` +`$ check_cronstatus [-h]` + +or + +`$ check_cronstatus [SCRIPT]` + ### Parameters ```text +______________________________________________________________________ + +CHECK_CRONSTATUS +v2.4 + +(c) Institute for Medical Education - University of Bern +Licence: GNU GPL 3 + +https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_cronstatus.html +______________________________________________________________________ + +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] + OPTIONS: -h or --help show this help. @@ -25,6 +65,7 @@ PARAMETERS: SCRIPT optional: custom status script default: /opt/cronwrapper/cronstatus.sh + ``` ## Examples @@ -34,3 +75,4 @@ PARAMETERS: `check_cronstatus /usr/share/cronwrapper/cronstatus.sh` The Check of cronjobs with custom loction. + The parameter must reference cronstatus.sh with its full path \ No newline at end of file -- GitLab