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..727f171866765a9379de053a7cdeaf5955b03eca 100644 --- a/docs/20_Checks/check_clientbackup.md +++ b/docs/20_Checks/check_clientbackup.md @@ -1,6 +1,6 @@ -# Check Client backup +## Check Client backup -## Introduction +Script: `check_clientbackup` **check_client_backup** is a plugin to show the backup status of IML Backup. 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..8459cea5015c6b020c50daa74b4dc0b6660c76b3 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 diff --git a/docs/20_Checks/check_disk_io.md b/docs/20_Checks/check_disk_io.md index bc3c90654e30039b89f1ae1c587a2b4016ee2885..90e67e601413fc7374620ce678cceda804c69756 100644 --- a/docs/20_Checks/check_disk_io.md +++ b/docs/20_Checks/check_disk_io.md @@ -1,6 +1,4 @@ -# CHECK_DISK-IO - -## Introduction +## 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..2c9232dc85b8ec452233b1ef8b9b8aea7280b46a 100644 --- a/docs/20_Checks/check_dns_responsetime.md +++ b/docs/20_Checks/check_dns_responsetime.md @@ -1,6 +1,4 @@ -# CHECK_DNS_RESPONSETIME - -## Introduction +## 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..09782171697b337424b4828c71ab5e42149f5713 100644 --- a/docs/20_Checks/check_docker_info.md +++ b/docs/20_Checks/check_docker_info.md @@ -1,6 +1,4 @@ -# CHECK_DOCKER_INFO - -## Introduction +## 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..c0667fe701fab5a223cdf1d8cb003c16ca18385c 100644 --- a/docs/20_Checks/check_docker_stats.md +++ b/docs/20_Checks/check_docker_stats.md @@ -1,6 +1,4 @@ -# CHECK_DOCKER_STATS - -## Introduction +## 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..30eb8886d742c4eb9043f0903109f94ad2370dff 100644 --- a/docs/20_Checks/check_dockercontainer_top.md +++ b/docs/20_Checks/check_dockercontainer_top.md @@ -1,6 +1,4 @@ -# CHECK_DOCKERCONTAINER_TOP - -## Introduction +## 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..fb47429a1a4001b90f13cba4ff864b19b36ad511 100644 --- a/docs/20_Checks/check_eol.md +++ b/docs/20_Checks/check_eol.md @@ -1,6 +1,4 @@ -## check EOL - -### Introduction +## Check EOL **check_eol** is a plugin for Icinga/ Nagios. It detects the end of life of an OS or a product. @@ -10,7 +8,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 +58,7 @@ EXAMPLES ``` -#### Parameters +### Parameters PRODUCT set a product; known product keys are listed below VERSION set a version. @@ -70,12 +68,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 +87,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 +114,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 +154,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 +164,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..3c3eb28406f9225deff286dd64febe78a1e74675 100644 --- a/docs/20_Checks/check_fs_errors.md +++ b/docs/20_Checks/check_fs_errors.md @@ -1,6 +1,4 @@ -# Check filesystem errors - -## Introduction +## Check filesystem 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..2bfba939f59e093575227771966b1b55acbede7d 100644 --- a/docs/20_Checks/check_fs_writable.md +++ b/docs/20_Checks/check_fs_writable.md @@ -1,6 +1,4 @@ -# Check writable filesystem - -## Introduction +## Check writable filesystem **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..5b4c51f3fb4bd35895ebc525b7fe72d14394005a 100644 --- a/docs/20_Checks/check_gitlab_tokens.md +++ b/docs/20_Checks/check_gitlab_tokens.md @@ -1,6 +1,4 @@ -# Check Gitlab tokens - -## Introduction +## 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. diff --git a/docs/20_Checks/check_haproxy_health.md b/docs/20_Checks/check_haproxy_health.md index ca7b59cee1c0c5d401a7bcd6d9f350dbdbbdb0f3..444232b0977d8814bdb5fab3bc335ba206922ec2 100644 --- a/docs/20_Checks/check_haproxy_health.md +++ b/docs/20_Checks/check_haproxy_health.md @@ -1,6 +1,4 @@ -# Check HA-Proxy health - -## Introduction +## Check HA-Proxy 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..789c71bb9568dabb4856395bf6f99281d15fa0b3 100644 --- a/docs/20_Checks/check_haproxy_status.md +++ b/docs/20_Checks/check_haproxy_status.md @@ -1,6 +1,4 @@ -# Check HA-Proxy Status - -## Introduction +## Check HA-Proxy 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..e739583b913035fbe5f68689d77bea527291f62a 100644 --- a/docs/20_Checks/check_http.md +++ b/docs/20_Checks/check_http.md @@ -1,6 +1,4 @@ -# Check Httpd - -## Introduction +## Check Httpd 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..5fd22120ed010d1515260b100f13344f4ab971c4 100644 --- a/docs/20_Checks/check_iml_backup_server.md +++ b/docs/20_Checks/check_iml_backup_server.md @@ -1,6 +1,4 @@ -# Check IML backup server - -## Introduction +## 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..9b383f2914fd3c0a79ed8912bcf878805a8219ab 100644 --- a/docs/20_Checks/check_journallog.md +++ b/docs/20_Checks/check_journallog.md @@ -1,6 +1,4 @@ -# Check Systemd unit - -## Introduction +## Check Systemd unit 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..63816702e3fe865814e536050e4f445b4f906711 100644 --- a/docs/20_Checks/check_memory.md +++ b/docs/20_Checks/check_memory.md @@ -1,6 +1,4 @@ -# Check Memory (RAM) - -## Introduction +## Check Memory (RAM) **check_memory** Check memory usage incl. free, used and total memory. @@ -19,7 +17,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..00c763ed6e5770b0b36a318bcab07ea163eace73 100644 --- a/docs/20_Checks/check_mysqlserver.md +++ b/docs/20_Checks/check_mysqlserver.md @@ -1,6 +1,4 @@ -# check Mysql / mariadb server - -## Introduction +## Check Mysql / mariadb server **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..6975cb7d3326dbaa458e09bf863ea41f2919cbf3 100644 --- a/docs/20_Checks/check_netio.md +++ b/docs/20_Checks/check_netio.md @@ -1,12 +1,10 @@ -# check_netio - -## Introduction +## 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..df04c329ed7a8fd426a334f27c72dcae8e969280 100644 --- a/docs/20_Checks/check_netstat.md +++ b/docs/20_Checks/check_netstat.md @@ -1,6 +1,4 @@ -# check netstat - -## Introduction +## 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..34c2b79832eb171e8db0a4225ec7e8670714de92 100644 --- a/docs/20_Checks/check_onehost.md +++ b/docs/20_Checks/check_onehost.md @@ -1,6 +1,4 @@ -# check OpenNebula hosts - -## Introduction +## Check OpenNebula hosts **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..da56a9e159af9a8a36fd164239c4efdd37634200 100644 --- a/docs/20_Checks/check_onevm.md +++ b/docs/20_Checks/check_onevm.md @@ -1,6 +1,4 @@ -# Check OpenNebula virtual machines - -## Introduction +## Check OpenNebula virtual machines **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..40138425b069a7271468ee8977ecc283e488abc0 100644 --- a/docs/20_Checks/check_opencpu.md +++ b/docs/20_Checks/check_opencpu.md @@ -1,6 +1,4 @@ -# check_opencpu - -## Introduction +## 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..cde17d22c0a6a5f378616c028830a0ae8a89d690 100644 --- a/docs/20_Checks/check_packages2install.md +++ b/docs/20_Checks/check_packages2install.md @@ -1,6 +1,4 @@ -# check_packages2install - -## Introduction +## 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..5f614f281db7d5c6632530069e8eaef4d73f9542 100644 --- a/docs/20_Checks/check_php-fpm-status.md +++ b/docs/20_Checks/check_php-fpm-status.md @@ -1,10 +1,8 @@ -# check_php-fpm-status - -## Introduction +## 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..952ec92bc5ab825eafc3af092d83911477e11842 100644 --- a/docs/20_Checks/check_proc_mem.md +++ b/docs/20_Checks/check_proc_mem.md @@ -1,6 +1,4 @@ -# Check memory consuming processes - -## Introduction +## Check memory consuming processes 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..99489c3e523762ee6771ffe8cd6bd22473df8580 100644 --- a/docs/20_Checks/check_proc_ressources.md +++ b/docs/20_Checks/check_proc_ressources.md @@ -1,6 +1,4 @@ -# Check process resources regarding cpu and memory - -## Introduction +## Check process resources regarding cpu and memory 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..e9aa946b8c97d9f95e6bf0e9b3d78bcf11dc81ea 100644 --- a/docs/20_Checks/check_proc_zombie.md +++ b/docs/20_Checks/check_proc_zombie.md @@ -1,6 +1,4 @@ -# Check_proc_zombie - -## Introduction +## 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..2329bc3205e018dea924e380a2983b645cd716f6 100644 --- a/docs/20_Checks/check_psqlserver.md +++ b/docs/20_Checks/check_psqlserver.md @@ -1,6 +1,4 @@ -# check PostgreSql server - -## Introduction +## Check PostgreSql server **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..f4d97f4a100dc1cdf45e62166413546f8855af74 100644 --- a/docs/20_Checks/check_rearbackup.md +++ b/docs/20_Checks/check_rearbackup.md @@ -1,6 +1,4 @@ -# Check Rear backup - -## Introduction +## Check Rear backup 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..25e066dd61c74557035dcd804c32ac4dd584fed6 100644 --- a/docs/20_Checks/check_reboot_required.md +++ b/docs/20_Checks/check_reboot_required.md @@ -1,6 +1,4 @@ -# Check Reboot required - -## Introduction +## 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..15d5ed80c3273144f8bbf2723cc5902f35a9f502 100644 --- a/docs/20_Checks/check_requirements.md +++ b/docs/20_Checks/check_requirements.md @@ -1,6 +1,4 @@ -# Check_requirements - -## Introduction +## 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..1fac6a40343b833f899a53bae4b9099d53f53a4a 100644 --- a/docs/20_Checks/check_smartstatus.md +++ b/docs/20_Checks/check_smartstatus.md @@ -1,6 +1,4 @@ -# Check_smartstatus - -## Introduction +## 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..d54fb2d6c61e93dc8443d3cefeef7231fea10eb0 100644 --- a/docs/20_Checks/check_snmp_data.md +++ b/docs/20_Checks/check_snmp_data.md @@ -1,6 +1,4 @@ -# check SNMP data - -## Introduction +## 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..df59d944df08ade710f49a85f457f5ea42488f92 100644 --- a/docs/20_Checks/check_snmp_synology.md +++ b/docs/20_Checks/check_snmp_synology.md @@ -1,6 +1,4 @@ -# check SNMP Synology - -## Introduction +## 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..8fbed68382f4651f73d50efd65fc438ddf12d56d 100644 --- a/docs/20_Checks/check_ssl_certs.md +++ b/docs/20_Checks/check_ssl_certs.md @@ -1,6 +1,4 @@ -# Check ssl certs - -## Introduction +## 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..fbe1bcd7eaf591187d6d4bc6bed730dd79b02261 100644 --- a/docs/20_Checks/check_systemdunit.md +++ b/docs/20_Checks/check_systemdunit.md @@ -1,6 +1,4 @@ -# Check Systemd unit - -## Introduction +## Check Systemd unit This check shows the status of a systemd unit. diff --git a/docs/20_Checks/fix_h1.sh b/docs/20_Checks/fix_h1.sh new file mode 100755 index 0000000000000000000000000000000000000000..ee2488b9d266fa6a9cf7c0874d48ff124b74a916 --- /dev/null +++ b/docs/20_Checks/fix_h1.sh @@ -0,0 +1,54 @@ +#!/bin/bash + +tmpfile=/tmp/tmp_myfile_$USER__$$ + +cd "$( dirname "$0" )" + +for f in *.md; do + if head "$f" | grep -q "^# "; then + echo + echo ">>>>> FIX $f" + echo + cp -p "$f" "$tmpfile" + + if grep -q "^## Introduction" "$f"; then + echo "Replace '## Introduction'" + sed -i -e "s/^## Introduction.*//" "$tmpfile" + head -1 "$f" | tail -1 | grep "." && sed -i -e '2,3d' "$tmpfile" + + # make 1st h1 smaller + sed -i -e "0,/^# /{s/^# /## /}" "$tmpfile" + + else + echo "Move Headers" + if grep "^###### " "$f"; then + echo "ABORT: H6 was found that cannot moved to smaller level." + exit 1 + fi + for header in "#####" "####" "###" "##" "#" + do + sed -i -e "s/^$header /#$header /g" "$tmpfile" + done + fi + diff -u --color "$f" "$tmpfile" + echo + read -p "Apply changes on '$f' [Y/n]? > " apply + if [ "$apply" = "" ] || [ "$apply" = "y" ]|| [ "$apply" = "Y" ]; then + echo "Applying ..." + mv "$tmpfile" "$f" + else + echo "Keeping current version." + rm "$tmpfile" + fi + sleep 1 + echo + echo + echo + echo + echo + echo + echo ---------------------------------------------------------------------- + else + echo "OK $f" + fi +done \ No newline at end of file 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..cd1b3f0664f054ea2d46f6faccf0b87276e599f0 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,28 @@ 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: ';} + +h1::before{color: #aaa;content: '';} +h2::before{color: #888;content: ': : ';} +h3::before{color: #aaa;content: '> ';} +h4::before{color: #aaa;content: '_ ';} +h5::before{color: #aaa;content: 'h5: ';} +h6::before{color: #aaa;content: 'h6: ';} + +.s-content h1::before{ color: #f00; content: 'FEHLER: Keine Ü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 +170,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 +228,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 +281,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 +290,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 +313,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{