diff --git a/docs/20_Checks/_index.md b/docs/20_Checks/_index.md index 335c6c67b6a58caf20804c3f62d82ecbca9929a5..dda9bceb0062d6f01e0109f8b98a7f196e3ebbe7 100644 --- a/docs/20_Checks/_index.md +++ b/docs/20_Checks/_index.md @@ -30,7 +30,7 @@ There is one include script used by all checks: * [check_netstat](check_netstat.md) * [check_onehost](check_onehost.md) * [check_onevm](check_onevm.md) -* check_opencpu +* [check_opencpu](check_opencpu.md) * check_packages2install * check_php-fpm-status * check_proc_mem diff --git a/docs/20_Checks/check_opencpu.md b/docs/20_Checks/check_opencpu.md new file mode 100644 index 0000000000000000000000000000000000000000..6113c16b9f1b55c23ddd3b73c4d3769b96d38714 --- /dev/null +++ b/docs/20_Checks/check_opencpu.md @@ -0,0 +1,65 @@ +# check_opencpu + +## Introduction + +Test if OpenCpu is available via http and test if given packages are installed. + +### Requirements + +* wget + +## Syntax + +```text +> ./check_opencpu -h +______________________________________________________________________ + +CHECK_OPENCPU +v1.4 + +(c) Institute for Medical Education - University of Bern +Licence: GNU GPL 3 + +https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_opencpu.html +______________________________________________________________________ + +Test if opencpu is available. +It returns OK if +- opencpu is running on http://localhost/ocpu +- all packages are installed: + eosceGLM eosceLinReg eosceReliability eosceReporter msrdAnalytics + +SYNTAX: +check_opencpu [-h] [-p PKG] + +OPTIONS: + + -h or --help show this help and exit. + +PARAMETERS: + + -p PKG(s) define package to test; for multiple packages quote + it and delimit them with space. + +EXAMPLES: + + check_opencpu -p "myPackage1 myPackage2 anotherPackage" + Check given opencpu packages + + check_opencpu -p "" + Check Opencpu only (without packages) + +``` + +## Examples + +### Check with packages + +```txt +OpenCpu: OK + +OK: openCpu is running and reachable with http +OK: package is available [myPackage1] .. Build: R 4.1.1; ; 2021-11-09 10:18:01 UTC; unix +OK: package is available [myPackage2] .. Build: R 4.1.1; ; 2022-03-07 11:07:03 UTC; unix +OK: package is available [anotherPackage] .. Build: R 4.1.2; ; 2023-07-18 08:32:57 UTC; unix +```