diff --git a/docs/20_Checks/_index.md b/docs/20_Checks/_index.md index 918714269cd546194b5af7abbff765962a9664a1..53a6c04454b52bd4d1972c0e51d4aae5d02670f1 100644 --- a/docs/20_Checks/_index.md +++ b/docs/20_Checks/_index.md @@ -1,10 +1,3 @@ -# Checks - -## Shared functions - -There is one include script used by all checks: -[inc_pluginfunctions](inc_pluginfunctions.md) - ## Check scripts * [about](about.md) diff --git a/docs/20_Checks/about.md b/docs/20_Checks/about.md index 4012e25234fee2cc7a83ee0e0e5d7d2e14c23d7f..4cd1d41587680e8c208dbb084387dbc58270bd13 100644 --- a/docs/20_Checks/about.md +++ b/docs/20_Checks/about.md @@ -1,6 +1,6 @@ -# About +## About -## Introduction +Script: `about` This check shows a short summary for the current system. Its status is always OK. diff --git a/docs/20_Checks/check_apache_requests.md b/docs/20_Checks/check_apache_requests.md index e5eab23311865b13a23f19b255c55f684cc4e68d..8b80c1d2614f1782f1625f947f51e73eae475e09 100644 --- a/docs/20_Checks/check_apache_requests.md +++ b/docs/20_Checks/check_apache_requests.md @@ -1,6 +1,6 @@ -# Check_apache_requests +## Check_apache_requests -## Introduction +Script: `check_apache_requests` After requesting the apache servre status page you get diff --git a/docs/20_Checks/check_ceph_diskfree.md b/docs/20_Checks/check_ceph_diskfree.md index 811cf5c6ced2de9305e103037a66f8b492e4a3c7..cbe5b0e821be7c2b96a49e67549e7a4e65fffadc 100644 --- a/docs/20_Checks/check_ceph_diskfree.md +++ b/docs/20_Checks/check_ceph_diskfree.md @@ -1,8 +1,8 @@ -# Check Ceph diskfree +## Check Ceph diskfree -## Introduction +Script: `check_ceph_diskfree` -**check_ceph_diskfree** is a plugin to show the available and free diskspace. +It is a plugin to show the available and free diskspace. It returns a single line for the status, data and performance data. ## Requirements diff --git a/docs/20_Checks/check_ceph_io.md b/docs/20_Checks/check_ceph_io.md index 550b7cfd21426fc03443f46327fd286a71ab3e93..dfc6744023d5207a25cfd6e2417ac8568d4f6e8f 100644 --- a/docs/20_Checks/check_ceph_io.md +++ b/docs/20_Checks/check_ceph_io.md @@ -1,8 +1,8 @@ -# Check Ceph IO +## Check Ceph IO -## Introduction +Script: `check_ceph_io` -**check_ceph_io** is a plugin to show read and written bytes per second. +It is a plugin to show read and written bytes per second. It returns a single line for the status and performance data. ## Requirements diff --git a/docs/20_Checks/check_ceph_osd.md b/docs/20_Checks/check_ceph_osd.md index 5c4bf6000ff1f1c0a7d5c8965eabd0473c83341e..de1d49ce0403e370722709f9f1bb6008ee280e17 100644 --- a/docs/20_Checks/check_ceph_osd.md +++ b/docs/20_Checks/check_ceph_osd.md @@ -1,6 +1,6 @@ -# Check Ceph OSDs +## Check Ceph OSDs -## Introduction +Script: `check_ceph_osd` Show cheph osd status: how many OSDs exist and how many are up/ down. This check sends performance data. diff --git a/docs/20_Checks/check_ceph_status.md b/docs/20_Checks/check_ceph_status.md index e4e8d41ee2372e28721fbbc7b5bf617babac9e49..4f45b732498f6606b61f7bff90bb407c1b4e5493 100644 --- a/docs/20_Checks/check_ceph_status.md +++ b/docs/20_Checks/check_ceph_status.md @@ -1,6 +1,6 @@ -# Check Ceph Status +## Check Ceph Status -## Introduction +Script: `check_ceph_statusbb` **check_ceph_status** is a plugin to show ceph status. It switches the state in dependency of the HEALTH_* value. diff --git a/docs/20_Checks/check_clientbackup.md b/docs/20_Checks/check_clientbackup.md index b4dae32b709e03161a5a3f202100f06a615a76e8..9fe6c3d2100bd492d188d8144efe83ea40d1e683 100644 --- a/docs/20_Checks/check_clientbackup.md +++ b/docs/20_Checks/check_clientbackup.md @@ -1,12 +1,12 @@ -# Check Client backup +## Check Client backup -## Introduction +Script: `check_clientbackup` **check_client_backup** is a plugin to show the backup status of IML Backup. π Source: <https://git-repo.iml.unibe.ch/iml-open-source/iml-backup/>\ π License: GNU GPL 3.0\ -π Docs: see docs folder or online <https://os-docs.iml.unibe.ch/iml-backup/> +π Docs: see docs folder or online <https://os-docs.iml.unibe.ch/iml-backup/> ## Requirements diff --git a/docs/20_Checks/check_couchdb.md b/docs/20_Checks/check_couchdb.md index eb6cd51c4c67d708a35a295d778df6fcc71c7ecb..ce672b00afbb48ff64784fec69974cbccc066846 100644 --- a/docs/20_Checks/check_couchdb.md +++ b/docs/20_Checks/check_couchdb.md @@ -1,6 +1,6 @@ -# check_couchdb +## Check_couchdb -## Introduction +Script: `check_couchdb` Check couchdb status. diff --git a/docs/20_Checks/check_cpu.md b/docs/20_Checks/check_cpu.md index d59c2cd6b4238c547a1f0b649dac8a24ef75604b..9133cb3d03812e57f0943fa6b4bec4f80123444d 100644 --- a/docs/20_Checks/check_cpu.md +++ b/docs/20_Checks/check_cpu.md @@ -1,8 +1,8 @@ -# check CPU +## Check CPU -## Introduction +Script: `check_cpu` -**check_cpu** is a plugin to check cpu usage and cpu io wait. +It is a plugin to check cpu usage and cpu io wait. It reads cpu data from output of top command and shows hwi - Time spent handling hardware interrupt routines. (Whenever a peripheral unit want attention form the CPU, it literally pulls a line, to signal the CPU to service it) diff --git a/docs/20_Checks/check_cronstatus.md b/docs/20_Checks/check_cronstatus.md index e03fbca0f49f7560bb6209defab37b717d8268b3..067a1713363b3a6b0a3dc93c071171ae0d4e0905 100644 --- a/docs/20_Checks/check_cronstatus.md +++ b/docs/20_Checks/check_cronstatus.md @@ -1,6 +1,6 @@ -# Check Cronstatus +## Check Cronstatus -## Introduction +Script: `check_cronstatus` Show status of all Cronjobs using Axels Cronwrapper @@ -21,7 +21,7 @@ As output you get a summary of all checks followed by more detailed status per j π Source: <https://github.com/axelhahn/cronwrapper>\ π License: GNU GPL 3.0\ -π Docs: see docs folder or online <https://www.axel-hahn.de/docs/cronwrapper/> +π Docs: see docs folder or online <https://www.axel-hahn.de/docs/cronwrapper/> ## Syntax diff --git a/docs/20_Checks/check_disk_io.md b/docs/20_Checks/check_disk_io.md index bc3c90654e30039b89f1ae1c587a2b4016ee2885..a881c483d829c1421a8491967c48e79f443f7ef9 100644 --- a/docs/20_Checks/check_disk_io.md +++ b/docs/20_Checks/check_disk_io.md @@ -1,6 +1,6 @@ -# CHECK_DISK-IO +## CHECK_DISK-IO -## Introduction +Script: `check_disk_io` **check_disk-io** is a plugin to show io, ticks and wait time. It shows a multiline output and sends performance data. diff --git a/docs/20_Checks/check_dns_responsetime.md b/docs/20_Checks/check_dns_responsetime.md index bf25cd5cd2b9a30e1a9fdc959a9c328f8186cd3a..19d0f15293a814757cd40a71b92d2c271e6f7a7c 100644 --- a/docs/20_Checks/check_dns_responsetime.md +++ b/docs/20_Checks/check_dns_responsetime.md @@ -1,6 +1,6 @@ -# CHECK_DNS_RESPONSETIME +## CHECK_DNS_RESPONSETIME -## Introduction +Script: `check_dns_responsetime` **check_dns_responsetime** check dns response time of all dns servers found in local /etc/resolv.conf diff --git a/docs/20_Checks/check_docker_info.md b/docs/20_Checks/check_docker_info.md index 1d8230f1033b584c07e17afb66760793ca2e1d64..f4cde8f2e5b3d917478065ad5125b147d5ac185a 100644 --- a/docs/20_Checks/check_docker_info.md +++ b/docs/20_Checks/check_docker_info.md @@ -1,6 +1,6 @@ -# CHECK_DOCKER_INFO +## CHECK_DOCKER_INFO -## Introduction +Script: `check_docker_info` **check_docker_info_** shows the docker version and count of containers. You get the count of containers by state running, paused or stopped. diff --git a/docs/20_Checks/check_docker_stats.md b/docs/20_Checks/check_docker_stats.md index 2cd82d0405310513f26f37c4cac4097ce56885e0..0d953bb0118e4546e6df36756fd0eba8b838b3cc 100644 --- a/docs/20_Checks/check_docker_stats.md +++ b/docs/20_Checks/check_docker_stats.md @@ -1,6 +1,6 @@ -# CHECK_DOCKER_STATS +## CHECK_DOCKER_STATS -## Introduction +Script: `check_docker_stats` **check_docker_stats** shows the docker resources of containers. This check sends performance data. diff --git a/docs/20_Checks/check_dockercontainer_top.md b/docs/20_Checks/check_dockercontainer_top.md index af3d9d9c2e4fd290cd02b62a8247591ec4b4b821..b734a21a50ba688e194bb23f534663d582bbdbcd 100644 --- a/docs/20_Checks/check_dockercontainer_top.md +++ b/docs/20_Checks/check_dockercontainer_top.md @@ -1,6 +1,6 @@ -# CHECK_DOCKERCONTAINER_TOP +## CHECK_DOCKERCONTAINER_TOP -## Introduction +Script: `check_dockercontainer_top` **check_dockercontaeiner_top** shows the docker top output for each container. diff --git a/docs/20_Checks/check_eol.md b/docs/20_Checks/check_eol.md index 0436321b854b10ff57e4335f1e32cf27f30634fe..06f50ebdd388c09b64880d1493cfee193aafd2e4 100644 --- a/docs/20_Checks/check_eol.md +++ b/docs/20_Checks/check_eol.md @@ -1,6 +1,6 @@ -## check EOL +## Check EOL -### Introduction +Script: `check_eol` **check_eol** is a plugin for Icinga/ Nagios. It detects the end of life of an OS or a product. @@ -10,7 +10,7 @@ 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. -### Syntax +## Syntax ```txt ./check_eol @@ -60,7 +60,7 @@ EXAMPLES ``` -#### Parameters +### Parameters PRODUCT set a product; known product keys are listed below VERSION set a version. @@ -70,12 +70,12 @@ VERSION set a version. You can set "os" as product to detect the (linux) distribution. See examples below. -#### Options +### Options -c set critical limit; default 90 -w set warning limit; default 365 -### Examples +## Examples ``check_eol php 7.4`` Show end of life for given php version 7.4 @@ -89,7 +89,7 @@ VERSION set a version. ``check_eol php detect`` Show the end of life for the detected php version -### Extend/ customize +## Extend/ customize The check is build to be customizable. You can add @@ -116,7 +116,7 @@ detect-postgres* detect-ruby* ``` -#### End of life dates +### End of life dates The dates are defined in the files *check_eol-*.cfg*. Those contain lines with parsed information that must start at the begin of line: @@ -156,7 +156,7 @@ website https://www.centos.org/ 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/check_eol-databases.cfg - Mariadb, PostgreSql @@ -166,7 +166,7 @@ You can add your custom products and dates - it just must match *check_eol-*.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). diff --git a/docs/20_Checks/check_fs_errors.md b/docs/20_Checks/check_fs_errors.md index 75df3e274603b6d61a2570fda190ceb7348aacb8..718dfd517b8debd8778bf5752b095ab0a1a73b61 100644 --- a/docs/20_Checks/check_fs_errors.md +++ b/docs/20_Checks/check_fs_errors.md @@ -1,6 +1,6 @@ -# Check filesystem errors +## Check filesystem errors -## Introduction +Script: `check_fs_errors` **check_fs_errors** checks if kernel logs inconsistency messages in the journallog. It requires sudo permission on /bin/journalctl diff --git a/docs/20_Checks/check_fs_writable.md b/docs/20_Checks/check_fs_writable.md index 9646a75455f14fa3eafd503a94ac066703a5a830..51ac13313be7f4e2fdabbc1c21d1231729b60202 100644 --- a/docs/20_Checks/check_fs_writable.md +++ b/docs/20_Checks/check_fs_writable.md @@ -1,6 +1,6 @@ -# Check writable filesystem +## Check writable filesystem -## Introduction +Script: `check_fs_writable` **check_fs_writebale** checks in the given directories a file can be touched. The response is critical of one of the directory is not writable for the icinga client user. diff --git a/docs/20_Checks/check_gitlab_tokens.md b/docs/20_Checks/check_gitlab_tokens.md index 818c705930ab4c777eb6b480293f48caa64c8ee5..4509c57ad2586d0aa06470577ef5bd6a30185783 100644 --- a/docs/20_Checks/check_gitlab_tokens.md +++ b/docs/20_Checks/check_gitlab_tokens.md @@ -1,6 +1,6 @@ -# Check Gitlab tokens +## Check Gitlab tokens -## Introduction +Script: `check_gitlab_tokens` **check_gitlab_tokens** checks all newer tokens of projects and groups if they expire soon. You can set a warning and a critical level in days. @@ -17,7 +17,7 @@ The check returns ## Requirements * curl -* Bash REST API client<br>A set of class like functions with a http. prefix. <br>Docs: <https://os-docs.iml.unibe.ch/bash-rest-api-client/> +* Bash REST API client<br>A set of class like functions with a http. prefix. <br>π Docs: <https://os-docs.iml.unibe.ch/bash-rest-api-client/> Extract or Git pull the Bash REST API client somewhere in your filesystem. eg. /opt/bash-api-client/. With the parameter `-r <FILE>` you point to the file `rest-api-client.sh`. diff --git a/docs/20_Checks/check_haproxy_health.md b/docs/20_Checks/check_haproxy_health.md index ca7b59cee1c0c5d401a7bcd6d9f350dbdbbdb0f3..81287b4b28adafa4344f25076bcb786215ae5925 100644 --- a/docs/20_Checks/check_haproxy_health.md +++ b/docs/20_Checks/check_haproxy_health.md @@ -1,6 +1,6 @@ -# Check HA-Proxy health +## Check HA-Proxy health -## Introduction +Script: `check_haproxy_health` **check_haproxy_health** checks health url of haproxy service. The url of it will be detected from /etc/haproxy/haproxy.cfg. diff --git a/docs/20_Checks/check_haproxy_status.md b/docs/20_Checks/check_haproxy_status.md index a9465d7fa42f157e4a7e8577abbf43e5688deedf..0a0f5ec9b8300dd4889eecf7676dbc15dbbcdbb3 100644 --- a/docs/20_Checks/check_haproxy_status.md +++ b/docs/20_Checks/check_haproxy_status.md @@ -1,6 +1,6 @@ -# Check HA-Proxy Status +## Check HA-Proxy Status -## Introduction +Script: `check_haproxy_status` **check_haproxy_health** show status and connections count on frontend and backend. This check sends performance data. diff --git a/docs/20_Checks/check_http.md b/docs/20_Checks/check_http.md index de5a48668689b37d025e29dd355c14b90923a48b..cc4328973739f7000ec72bac013fbd2ef1c6fab4 100644 --- a/docs/20_Checks/check_http.md +++ b/docs/20_Checks/check_http.md @@ -1,6 +1,6 @@ -# Check Httpd +## Check Httpd -## Introduction +Script: `check_http` Makes an http request with a given method (like HEAD or GET; GET is default). Additionally you can verify the response: diff --git a/docs/20_Checks/check_iml_backup_server.md b/docs/20_Checks/check_iml_backup_server.md index 6227e4d6a55519676c8498c13bec410cfe2d1744..a33c630ffd0a8c80d135fa06aedb56f8654add0b 100644 --- a/docs/20_Checks/check_iml_backup_server.md +++ b/docs/20_Checks/check_iml_backup_server.md @@ -1,6 +1,6 @@ -# Check IML backup server +## Check IML backup server -## Introduction +Script: `check_iml_backup_server` This check is for IML Backup server. This check executes the script 'storage_helper.sh' to get thebackup status. diff --git a/docs/20_Checks/check_journallog.md b/docs/20_Checks/check_journallog.md index 1b5517bd1a04e1feb068f08f323206d221b879ca..cd8528f1db3fee0f59bae68e10fef6e2a2e17cae 100644 --- a/docs/20_Checks/check_journallog.md +++ b/docs/20_Checks/check_journallog.md @@ -1,6 +1,6 @@ -# Check Systemd unit +## Check Systemd unit -## Introduction +Script: `check_journallog` This check shows the count of written entries in the journallog per minute. This check requires access to journalctl. diff --git a/docs/20_Checks/check_memory.md b/docs/20_Checks/check_memory.md index 56ffa3be2db937fc1ec3eb99346b68d3f6533189..a5765817f2cb64a8630e20b27a7bffd687733bb3 100644 --- a/docs/20_Checks/check_memory.md +++ b/docs/20_Checks/check_memory.md @@ -1,6 +1,6 @@ -# Check Memory (RAM) +## Check Memory (RAM) -## Introduction +Script: `check_memory` **check_memory** Check memory usage incl. free, used and total memory. @@ -19,7 +19,7 @@ It reads /proc/meminfo and fetches the needed values. This plugin sends all values as performance data. -### Requirements +## Requirements * bc diff --git a/docs/20_Checks/check_mysqlserver.md b/docs/20_Checks/check_mysqlserver.md index 640b6441fa6d0dd1546f314f7709fa9ff29a1ed3..68fb818ac3d24ccae298bb1ac89baab644fd287d 100644 --- a/docs/20_Checks/check_mysqlserver.md +++ b/docs/20_Checks/check_mysqlserver.md @@ -1,6 +1,6 @@ -# check Mysql / mariadb server +## Check Mysql / mariadb server -## Introduction +Script: `check_mysqlserver` **check_mysqlserver** is a plugin execute different checks on a mysql server instance. The kind of check is defined by a parameter `-m METHOD`. diff --git a/docs/20_Checks/check_netio.md b/docs/20_Checks/check_netio.md index 0c52dd0c7ccf32a22a851d803cafdfb0b6fa8b4a..ce7f745deee42145f7d6d25c085eb718375e07f4 100644 --- a/docs/20_Checks/check_netio.md +++ b/docs/20_Checks/check_netio.md @@ -1,12 +1,12 @@ -# check_netio +## Check_netio -## Introduction +Script: `check_netio` Show network io for all or selected interfaces. This plugin scans `/proc/net/dev` with the regex `eth|en[ops][0-9]*` to show a few types of interfaces. -### Requirements +## Requirements * none diff --git a/docs/20_Checks/check_netstat.md b/docs/20_Checks/check_netstat.md index 2dd0f322c2873e96c21f566148eceb2f64f250cc..9274037cc572b366a6a181ebba6e32da9e255202 100644 --- a/docs/20_Checks/check_netstat.md +++ b/docs/20_Checks/check_netstat.md @@ -1,6 +1,6 @@ -# check netstat +## Check netstat -## Introduction +Script: `check_netstat` Count number of network connections. diff --git a/docs/20_Checks/check_onehost.md b/docs/20_Checks/check_onehost.md index bfb34e992da766893e69bcc59eff857f565d969a..e9b2be57cecb88b80d94e043a92d0a37fa3b6c3c 100644 --- a/docs/20_Checks/check_onehost.md +++ b/docs/20_Checks/check_onehost.md @@ -1,6 +1,6 @@ -# check OpenNebula hosts +## Check OpenNebula hosts -## Introduction +Script: `check_onehost` **check_onevm** is a plugin to show count of hosts in OpenNebula and warn if a host is down. diff --git a/docs/20_Checks/check_onevm.md b/docs/20_Checks/check_onevm.md index 5340443d00b5fbc5721efd498e1f5a1b135d716e..4a42f19e5e714664abeb46858053a1de10c8cc26 100644 --- a/docs/20_Checks/check_onevm.md +++ b/docs/20_Checks/check_onevm.md @@ -1,6 +1,6 @@ -# Check OpenNebula virtual machines +## Check OpenNebula virtual machines -## Introduction +Script: `check_onevm` **check_onevm** is a plugin to show count of vms in OpenNebula - listed by state and by host. diff --git a/docs/20_Checks/check_opencpu.md b/docs/20_Checks/check_opencpu.md index 6113c16b9f1b55c23ddd3b73c4d3769b96d38714..40e11ea5a84b0bfdf05758790a3980607b999874 100644 --- a/docs/20_Checks/check_opencpu.md +++ b/docs/20_Checks/check_opencpu.md @@ -1,6 +1,6 @@ -# check_opencpu +## Check_opencpu -## Introduction +Script: `check_opencpu` Test if OpenCpu is available via http and test if given packages are installed. diff --git a/docs/20_Checks/check_packages2install.md b/docs/20_Checks/check_packages2install.md index f8a2b8294451cafda95835850107c37311681e1f..4e60971b703d0e8129e1983cf2994363211ceaca 100644 --- a/docs/20_Checks/check_packages2install.md +++ b/docs/20_Checks/check_packages2install.md @@ -1,6 +1,6 @@ -# check_packages2install +## Check_packages2install -## Introduction +Script: `check_packages2install` Check available package updates. Found updates will be shown in groups. diff --git a/docs/20_Checks/check_php-fpm-status.md b/docs/20_Checks/check_php-fpm-status.md index 8ca858e41f5c2ea3ac1f0ca3eba8df445be290e4..837bbb5ebb9b8cca0379940d14e6fb885564cb08 100644 --- a/docs/20_Checks/check_php-fpm-status.md +++ b/docs/20_Checks/check_php-fpm-status.md @@ -1,10 +1,10 @@ -# check_php-fpm-status +## Check_php-fpm-status -## Introduction +Script: `check_php-fpm-status` The check fetches several counters from php-fm-status page. -### Requirements +## Requirements * wget * running PHP FPM service diff --git a/docs/20_Checks/check_proc_mem.md b/docs/20_Checks/check_proc_mem.md index 57623ccc841d9206847acf9a1cacb7bce158e12e..7732c16b08462e1d60433768c938b27b273f5a92 100644 --- a/docs/20_Checks/check_proc_mem.md +++ b/docs/20_Checks/check_proc_mem.md @@ -1,6 +1,6 @@ -# Check memory consuming processes +## Check memory consuming processes -## Introduction +Script: `check_proc_mem` Show processes that consume the most memory. You get a list with process name, total usage of all its processes, count of instances. diff --git a/docs/20_Checks/check_proc_ressources.md b/docs/20_Checks/check_proc_ressources.md index e0722fb201ded80262494a2043a3e8c567394c33..d26ab3ef7ab66f40d1ee8fbe8019133261d13113 100644 --- a/docs/20_Checks/check_proc_ressources.md +++ b/docs/20_Checks/check_proc_ressources.md @@ -1,6 +1,6 @@ -# Check process resources regarding cpu and memory +## Check process resources regarding cpu and memory -## Introduction +Script: `check_proc_ressources` Show processes that consume the most memory or cpu. You get a list with usage, process id and process diff --git a/docs/20_Checks/check_proc_zombie.md b/docs/20_Checks/check_proc_zombie.md index 499c5a9eca19ff2c0c0deb773575021fb1f3d969..1c1706be958e0561f9044f273c8a1aa1eed8d877 100644 --- a/docs/20_Checks/check_proc_zombie.md +++ b/docs/20_Checks/check_proc_zombie.md @@ -1,6 +1,6 @@ -# Check_proc_zombie +## Check_proc_zombie -## Introduction +Script: `check_proc_zombie` **check_proc_zombie** is a plugin to show the count of zombie processes. It sends performance data. diff --git a/docs/20_Checks/check_psqlserver.md b/docs/20_Checks/check_psqlserver.md index 96c5869913136a2c7261035276c2665802b258f2..89459984a7d3efdecdd9efd1dacfa2e43ddbb03c 100644 --- a/docs/20_Checks/check_psqlserver.md +++ b/docs/20_Checks/check_psqlserver.md @@ -1,6 +1,6 @@ -# check PostgreSql server +## Check PostgreSql server -## Introduction +Script: `check_psqlserver` **check_psqlserver** is a plugin execute different checks on a postgreSql server instance. The kind of check is defined by a parameter `-m METHOD`. diff --git a/docs/20_Checks/check_rearbackup.md b/docs/20_Checks/check_rearbackup.md index c718824289b193b212513100b609402f678d389b..acb88d6a194ca39fee5c27150d9e020df932c688 100644 --- a/docs/20_Checks/check_rearbackup.md +++ b/docs/20_Checks/check_rearbackup.md @@ -1,6 +1,6 @@ -# Check Rear backup +## Check Rear backup -## Introduction +Script: `check_rearbackup` This check can verify the age of all iso files in the backup target directory. diff --git a/docs/20_Checks/check_reboot_required.md b/docs/20_Checks/check_reboot_required.md index df428595fed48382f7efbc0bedf84229299b760d..47deb3cd9b89829402d9aceb4126145465edbcb1 100644 --- a/docs/20_Checks/check_reboot_required.md +++ b/docs/20_Checks/check_reboot_required.md @@ -1,6 +1,6 @@ -# Check Reboot required +## Check Reboot required -## Introduction +Script: `check_reboot_required` Check if a reboot is required. It works for Centos and Debian/ Ubuntu. diff --git a/docs/20_Checks/check_requirements.md b/docs/20_Checks/check_requirements.md index 3aff9717d47a8c2fb53e1429ba7729c5c04eb73e..feef6f79ac5ccaa05e81652016b3a66daa57d98c 100644 --- a/docs/20_Checks/check_requirements.md +++ b/docs/20_Checks/check_requirements.md @@ -1,6 +1,6 @@ -# Check_requirements +## Check_requirements -## Introduction +Script: `check_requirements` **check_requirements** is a plugin to run different check to show the ability to run an application. You can these checks diff --git a/docs/20_Checks/check_smartstatus.md b/docs/20_Checks/check_smartstatus.md index 7131c8372b147759f8edba4b103d8d21a9ec0d74..fc1d399141a1b4fc29ae4015a4831d30dc49ecc4 100644 --- a/docs/20_Checks/check_smartstatus.md +++ b/docs/20_Checks/check_smartstatus.md @@ -1,6 +1,6 @@ -# Check_smartstatus +## Check_smartstatus -## Introduction +Script: `check_smartstatus` **check_smartstatus** is a plugin run a smartctl check to verify the disk status of all local harddisks/ ssds. diff --git a/docs/20_Checks/check_snmp_data.md b/docs/20_Checks/check_snmp_data.md index ff88cf2998455996a30d82b0ddbcaa6875ec9ce4..807b560fb6cc7b95cd51b9422232935f8da27ffa 100644 --- a/docs/20_Checks/check_snmp_data.md +++ b/docs/20_Checks/check_snmp_data.md @@ -1,6 +1,6 @@ -# check SNMP data +## Check SNMP data -## Introduction +Script: `check_snmp_data` **check_snmp_data** is a plugin for fetching performance data with a set of given OIDs. diff --git a/docs/20_Checks/check_snmp_synology.md b/docs/20_Checks/check_snmp_synology.md index ffe4315b2a159bec98fa99d27029782a8b533e4d..bbbbbdaefc02e8369c4430a12eb71466869ab787 100644 --- a/docs/20_Checks/check_snmp_synology.md +++ b/docs/20_Checks/check_snmp_synology.md @@ -1,6 +1,6 @@ -# check SNMP Synology +## Check SNMP Synology -## Introduction +Script: `check_snmp_synology` **check_snmp_data** is a plugin to check the status of a Synology storage using snmp v2 or v3. diff --git a/docs/20_Checks/check_ssl_certs.md b/docs/20_Checks/check_ssl_certs.md index a84bca88c878d35c7a3bc200ffa0e26b134c856b..de9814f76dce92df38f7994b8b91d1ee0ec1093a 100644 --- a/docs/20_Checks/check_ssl_certs.md +++ b/docs/20_Checks/check_ssl_certs.md @@ -1,6 +1,6 @@ -# Check ssl certs +## Check ssl certs -## Introduction +Script: `check_ssl_certs` **check_ssl_certs** is a plugin to check local certificats. diff --git a/docs/20_Checks/check_systemdunit.md b/docs/20_Checks/check_systemdunit.md index 3148753531f6734b18421942c6490b3158655cf6..e23adebc5e4b7408948c4a5286c727c5ddb40ac7 100644 --- a/docs/20_Checks/check_systemdunit.md +++ b/docs/20_Checks/check_systemdunit.md @@ -1,6 +1,6 @@ -# Check Systemd unit +## Check Systemd unit -## Introduction +Script: `check_systemdunit` This check shows the status of a systemd unit. diff --git a/docs/20_Checks/zz_template_check_.md b/docs/20_Checks/zz_template_check_.md index a51231222750253421e5d7c7ec4d6dc82b0355f1..7fc3a0c8ee0279a511f1b8299ba5b76b49b7e121 100644 --- a/docs/20_Checks/zz_template_check_.md +++ b/docs/20_Checks/zz_template_check_.md @@ -1,8 +1,8 @@ -# check NAME +## Check NAME -## Introduction +Script: `check_NAME` -**check_NAME** is a plugin for ... +It is a plugin for ... ## Syntax diff --git a/docs/30_Shared_functions/_index.md b/docs/30_Shared_functions/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..efc04bcc5b2baeadbede4a5ca0ee8d32f36aed8b --- /dev/null +++ b/docs/30_Shared_functions/_index.md @@ -0,0 +1,5 @@ +## Shared functions + +There is one include script used by all checks: +[inc_pluginfunctions](inc_pluginfunctions.md) + diff --git a/docs/20_Checks/inc_pluginfunctions.md b/docs/30_Shared_functions/inc_pluginfunctions.md similarity index 99% rename from docs/20_Checks/inc_pluginfunctions.md rename to docs/30_Shared_functions/inc_pluginfunctions.md index 1bcb056b63b877073b9acf759f96c9eb978678fe..83b33672af346dcbf7e7c15ca66600379ff69d02 100644 --- a/docs/20_Checks/inc_pluginfunctions.md +++ b/docs/30_Shared_functions/inc_pluginfunctions.md @@ -1,6 +1,4 @@ -# Shared functions - -## Introduction +## Shared functions All scripts start with sourcing a shared bash file diff --git a/docs/_index.md b/docs/_index.md index 8bf54d2f93ce8a6d894e9e2a85db5021cda49231..8cbbc6cbf0db19a120bd49400b3b5a73c7b15a18 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,6 +1,4 @@ -# IML Checks for Icinga / Nagios - -## Introduction +## IML Checks for Icinga / Nagios IML - Institute for Medical Education at university in Bern, Switzerland. diff --git a/docs/style.css b/docs/style.css index 5877f857e6bb0e7d5d76c29006cca18eecd87747..90a0bc938f147608a1d4fd11952e4825f076862c 100644 --- a/docs/style.css +++ b/docs/style.css @@ -1,6 +1,6 @@ /* override css elements of daux.io blue theme - version 2024-10-24 + version 2024-10-31 */ :root { /* Axels Overrides */ @@ -19,8 +19,9 @@ --sidebar-background: var(--body-background); --sidebar-border-color: none; --sidebar-link-active-background: #f0f4f6; + --toc--inner-border-color: none; /* Axels custom values */ - --axel_bg-toc: var(--body-background); + --axel_bg-toc: #f8fafa; --axel_bg-toc-head: #f8f8f8; --axel_brand-background: none; --axel_brand-pre-background: rgb(255, 0, 51); @@ -35,8 +36,8 @@ --axel_h2-hero-bottom: 2px solid #912; --axel_h3: #333; --axel_h3-bottom: 0px solid #ddd; - --axel_h4: #478; - --axel_h5: #699; + --axel_h4: #666; + --axel_h5: #888; --axel_hero_bg: #faf8f6; --axel_img-border: 2px dashed #ccc; --axel_nav-bg: #fcfcfc; @@ -60,6 +61,7 @@ --sidebar-background: var(--body-background); --sidebar-border-color: none; --sidebar-link-active-background: #333; + --sidebar-link-color: var(--link-color); /* Axels custom values */ --axel_bg-toc: var(--body-background); --axel_bg-toc-head: #333; @@ -126,19 +128,26 @@ a.Brand { /* ---------- page content ---------- */ .s-content { - padding-top: 1em; + padding-top: 6em; } -/* .s-content h1::before{ - background: #fee; - border: 3px double #f00; +/** +h1::before{color: #aaa;content: 'h1: ';} +h2::before{color: #aaa;content: 'h2: ';} +h3::before{color: #aaa;content: 'h3: ';} +h4::before{color: #aaa;content: 'h4: ';} +h5::before{color: #aaa;content: 'h5: ';} +h6::before{color: #aaa;content: 'h6: ';} +*/ +h2::before{color: #888;content: ': : ';} +h3::before{color: #ccc;content: '> ';} +h4::before{color: #ccc;content: '_ ';} + +.s-content h1::before{ color: #f00; content: 'FEHLER: Keine UΜberschrift 1 in einer Markdown-Datei fΓΌr Daux verwenden! Mit H2 beginnen!'; - display: block; - font-size: 50%; - padding: 0.3em; - margin-bottom: 2em; -} */ + content: '!! h1 !! '; +} .s-content h1 { background: var(--axel_h1-bg); @@ -159,8 +168,14 @@ a.Brand { border-bottom: var(--axel_h2-bottom); } -h1:first-of-type { +.Page__header > h1:first-of-type { margin-top: 0em; + margin-left: -1em; + padding-left: 1em; + position: fixed; + min-width: 100%; + background: var(--body-background); + box-shadow: 0 2em 1em var(--body-background); } h2:first-of-type { @@ -211,6 +226,8 @@ ul.TableOfContents a{ } .s-content pre { background: var(--axel_pre-background); + border-radius: 0.5em; + padding: 1rem; } /* FIX smaller fnt size in tables */ @@ -262,14 +279,6 @@ div.hero h2 { } /* ---------- TOC ---------- */ -@media(min-width:1700px) { - .TableOfContentsContainer { - position: fixed; - right: 2em; - top: 1em; - height: 96%; - } -} .TableOfContentsContainer { background-color: var(--axel_bg-toc); @@ -279,9 +288,11 @@ div.hero h2 { .s-content .TableOfContentsContainer h4 { background-color: var(--axel_bg-toc-head); border-top-left-radius: 1em; + border-bottom: 2px solid var(--axel_bg-toc-bottom-border); font-size: 1.1em; margin: 0; padding: 0.3em; + display: none; } .TableOfContentsContainer__content { @@ -300,6 +311,16 @@ ul.TableOfContents ul { text-decoration: underline; } +@media(min-width:1700px) { + .TableOfContentsContainer { + background: none; + position: fixed; + right: 2em; + top: 4em; + height: 90%; + } +} + /* ----- Icons on links --- */ .EditOn a::before{