Skip to content
Snippets Groups Projects
Commit 4640331f authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update doc

parent 79114c3f
Branches
No related tags found
No related merge requests found
# check EOL # # IML Checks for Icinga / Nagios
## Introduction ## [Home](readme.md)
---
## check EOL
### Introduction
**check_eol** is a plugin for Icinga/ Nagios. It detects the end of life of an OS or a product. **check_eol** is a plugin for Icinga/ Nagios. It detects the end of life of an OS or a product.
...@@ -10,11 +16,11 @@ The status is "unknown" if a product or the eol date was not detected. ...@@ -10,11 +16,11 @@ The status is "unknown" if a product or the eol date was not detected.
It is customizable / extendable to detect other products that are not included in the delivered basic config. It is customizable / extendable to detect other products that are not included in the delivered basic config.
## Syntax ## ### Syntax
``$ check_eol [-c CRITICAL] [-w WARING] PRODUCT VERSION`` ``$ check_eol [-c CRITICAL] [-w WARING] PRODUCT VERSION``
### Parameters ### #### Parameters
PRODUCT set a product; known product keys are listed below PRODUCT set a product; known product keys are listed below
VERSION set a version. VERSION set a version.
...@@ -24,12 +30,12 @@ VERSION set a version. ...@@ -24,12 +30,12 @@ VERSION set a version.
You can set "os" as product to detect the (linux) distribution. You can set "os" as product to detect the (linux) distribution.
See examples below. See examples below.
### Options ### #### Options
-c set critical limit; default 90 -c set critical limit; default 90
-w set warning limit; default 365 -w set warning limit; default 365
## Examples ## ### Examples
``check_eol php 7.4`` ``check_eol php 7.4``
Show end of life for given php version 7.4 Show end of life for given php version 7.4
...@@ -43,14 +49,14 @@ VERSION set a version. ...@@ -43,14 +49,14 @@ VERSION set a version.
``check_eol php detect`` ``check_eol php detect``
Show the end of life for the detected php version Show the end of life for the detected php version
## Extend/ customize ## ### Extend/ customize
The check is build to be customizable. You can add The check is build to be customizable. You can add
* add your own end of life dates * add your own end of life dates
* version detection for other products * version detection for other products
### End of life dates ### #### End of life dates
The dates are defined in the files *check_eol-*.cfg*. The dates are defined in the files *check_eol-*.cfg*.
Those contain lines with parsed information that must start at the begin of line: Those contain lines with parsed information that must start at the begin of line:
...@@ -86,7 +92,7 @@ Example output: ...@@ -86,7 +92,7 @@ Example output:
Limit Info: warn below 365 days; critical below 90 days Limit Info: warn below 365 days; critical below 90 days
#### Files #### #### Files
* check_eol-data/os.cfg - contains eol dates for debian, centos, ubuntu * check_eol-data/os.cfg - contains eol dates for debian, centos, ubuntu
* check_eol-data/check_eol-databases.cfg - Mariadb, PostgreSql * check_eol-data/check_eol-databases.cfg - Mariadb, PostgreSql
...@@ -96,7 +102,7 @@ You can add your custom products and dates - it just must match *check_eol-*.cfg ...@@ -96,7 +102,7 @@ You can add your custom products and dates - it just must match *check_eol-*.cfg
Suggestion: *check_eol-data/custom-[my category].cfg* Suggestion: *check_eol-data/custom-[my category].cfg*
### Version detection ### #### Version detection
If you use ``check_eol [product] [version]`` with an already known version in your monitoring check then the search for an eol date is done directly in the *cfg files (see above). If you use ``check_eol [product] [version]`` with an already known version in your monitoring check then the search for an eol date is done directly in the *cfg files (see above).
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
All scripts start with sourcing a shared bash file All scripts start with sourcing a shared bash file
. `dirname $0`/inc_pluginfunctions ``. `dirname $0`/inc_pluginfunctions``
In that script are several functions starting with prefix **ph.** (=plugin helper) In that script are several functions starting with prefix **ph.** (=plugin helper)
...@@ -40,7 +40,7 @@ return default value or its override from command line. ...@@ -40,7 +40,7 @@ return default value or its override from command line.
Example: Example:
typeset -i iWarnLimit=`ph.getValueWithParam 75 w "$@"` ``typeset -i iWarnLimit=`ph.getValueWithParam 75 w "$@"` ``
This will set variable iWarnLimit based on CLI parameter -w [value] ... if it does not exist it gets the default 75. This will set variable iWarnLimit based on CLI parameter -w [value] ... if it does not exist it gets the default 75.
...@@ -55,7 +55,7 @@ set statuscode by verifying integer(!) value with crtical and warning limit ...@@ -55,7 +55,7 @@ set statuscode by verifying integer(!) value with crtical and warning limit
Example: Example:
ph.setStatusByLimit $ramUsage $iWarnLimit $iCriticalLimit ``ph.setStatusByLimit $ramUsage $iWarnLimit $iCriticalLimit``
**ph.status** [TEXT] **ph.status** [TEXT]
...@@ -88,5 +88,5 @@ check if a binary PROG exists in search path (=are installed) - if not then exec ...@@ -88,5 +88,5 @@ check if a binary PROG exists in search path (=are installed) - if not then exec
Example: Example:
ph.reqire bc lsblk ``ph.reqire bc lsblk``
...@@ -21,4 +21,37 @@ We use Icinga graphite module to show performance data. The templates are locate ...@@ -21,4 +21,37 @@ We use Icinga graphite module to show performance data. The templates are locate
## Checks ## Checks
... check_apache_requests
\ No newline at end of file check_backup_one
check_ceph_diskfree
check_ceph_osd
check_ceph_status
check_clientbackup
check_couchdb-lb
check_cpu
check_cronstatus
check_disk-io
check_dns_responsetime
[check_eol)[check_eol.md]
check_haproxy_health
check_haproxy_status
check_memory
check_netio
check_netstat
check_opencpu
check_packages2install
check_proc_mem
check_proc_ressources
check_proc_zombie
check_reboot_required
check_sensuplugins
check_smartstatus
check_snmp_syno.sh
check_snmp_synology
check_ssl
check_systemdservices
check_timesync
check_uptime
inc_pluginfunctions
inc_pluginfunctions.md
paramtest
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment