From 487f6a56354d85631e331fc11144dbe08c326080 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch> Date: Thu, 31 Oct 2024 15:38:10 +0100 Subject: [PATCH] update docs --- docs/20_Checks/check_clientbackup.md | 2 +- docs/20_Checks/check_cronstatus.md | 2 +- docs/20_Checks/check_disk_io.md | 2 ++ docs/20_Checks/check_dns_responsetime.md | 2 ++ docs/20_Checks/check_docker_info.md | 2 ++ docs/20_Checks/check_docker_stats.md | 2 ++ docs/20_Checks/check_dockercontainer_top.md | 2 ++ docs/20_Checks/check_eol.md | 2 ++ docs/20_Checks/check_fs_errors.md | 2 ++ docs/20_Checks/check_fs_writable.md | 2 ++ docs/20_Checks/check_gitlab_tokens.md | 4 +++- docs/20_Checks/check_haproxy_health.md | 2 ++ docs/20_Checks/check_haproxy_status.md | 2 ++ docs/20_Checks/check_http.md | 2 ++ docs/20_Checks/check_iml_backup_server.md | 2 ++ docs/20_Checks/check_journallog.md | 2 ++ docs/20_Checks/check_memory.md | 2 ++ docs/20_Checks/check_mysqlserver.md | 2 ++ docs/20_Checks/check_netio.md | 2 ++ docs/20_Checks/check_netstat.md | 2 ++ docs/20_Checks/check_onehost.md | 2 ++ docs/20_Checks/check_onevm.md | 2 ++ docs/20_Checks/check_opencpu.md | 2 ++ docs/20_Checks/check_packages2install.md | 2 ++ docs/20_Checks/check_php-fpm-status.md | 2 ++ docs/20_Checks/check_proc_mem.md | 2 ++ docs/20_Checks/check_proc_ressources.md | 2 ++ docs/20_Checks/check_proc_zombie.md | 2 ++ docs/20_Checks/check_psqlserver.md | 2 ++ docs/20_Checks/check_rearbackup.md | 2 ++ docs/20_Checks/check_reboot_required.md | 2 ++ docs/20_Checks/check_requirements.md | 2 ++ docs/20_Checks/check_smartstatus.md | 2 ++ docs/20_Checks/check_snmp_data.md | 2 ++ docs/20_Checks/check_snmp_synology.md | 2 ++ docs/20_Checks/check_ssl_certs.md | 2 ++ docs/20_Checks/check_systemdunit.md | 2 ++ 37 files changed, 73 insertions(+), 3 deletions(-) diff --git a/docs/20_Checks/check_clientbackup.md b/docs/20_Checks/check_clientbackup.md index 727f171..9fe6c3d 100644 --- a/docs/20_Checks/check_clientbackup.md +++ b/docs/20_Checks/check_clientbackup.md @@ -6,7 +6,7 @@ Script: `check_clientbackup` 📄 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_cronstatus.md b/docs/20_Checks/check_cronstatus.md index 8459cea..067a171 100644 --- a/docs/20_Checks/check_cronstatus.md +++ b/docs/20_Checks/check_cronstatus.md @@ -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 90e67e6..a881c48 100644 --- a/docs/20_Checks/check_disk_io.md +++ b/docs/20_Checks/check_disk_io.md @@ -1,5 +1,7 @@ ## CHECK_DISK-IO +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 2c9232d..19d0f15 100644 --- a/docs/20_Checks/check_dns_responsetime.md +++ b/docs/20_Checks/check_dns_responsetime.md @@ -1,5 +1,7 @@ ## CHECK_DNS_RESPONSETIME +Script: `check_dns_responsetime` + **check_dns_responsetime** check dns response time of all dns servers found in local /etc/resolv.conf ## Requirements diff --git a/docs/20_Checks/check_docker_info.md b/docs/20_Checks/check_docker_info.md index 0978217..f4cde8f 100644 --- a/docs/20_Checks/check_docker_info.md +++ b/docs/20_Checks/check_docker_info.md @@ -1,5 +1,7 @@ ## CHECK_DOCKER_INFO +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. This check sends performance data. diff --git a/docs/20_Checks/check_docker_stats.md b/docs/20_Checks/check_docker_stats.md index c0667fe..0d953bb 100644 --- a/docs/20_Checks/check_docker_stats.md +++ b/docs/20_Checks/check_docker_stats.md @@ -1,5 +1,7 @@ ## CHECK_DOCKER_STATS +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 30eb888..b734a21 100644 --- a/docs/20_Checks/check_dockercontainer_top.md +++ b/docs/20_Checks/check_dockercontainer_top.md @@ -1,5 +1,7 @@ ## CHECK_DOCKERCONTAINER_TOP +Script: `check_dockercontainer_top` + **check_dockercontaeiner_top** shows the docker top output for each container. ## Requirements diff --git a/docs/20_Checks/check_eol.md b/docs/20_Checks/check_eol.md index fb47429..06f50eb 100644 --- a/docs/20_Checks/check_eol.md +++ b/docs/20_Checks/check_eol.md @@ -1,5 +1,7 @@ ## Check EOL +Script: `check_eol` + **check_eol** is a plugin for Icinga/ Nagios. It detects the end of life of an OS or a product. You get a status "ok", "warning" or "critical" based on the limits. diff --git a/docs/20_Checks/check_fs_errors.md b/docs/20_Checks/check_fs_errors.md index 3c3eb28..718dfd5 100644 --- a/docs/20_Checks/check_fs_errors.md +++ b/docs/20_Checks/check_fs_errors.md @@ -1,5 +1,7 @@ ## Check filesystem errors +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 2bfba93..51ac133 100644 --- a/docs/20_Checks/check_fs_writable.md +++ b/docs/20_Checks/check_fs_writable.md @@ -1,5 +1,7 @@ ## Check writable filesystem +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 5b4c51f..4509c57 100644 --- a/docs/20_Checks/check_gitlab_tokens.md +++ b/docs/20_Checks/check_gitlab_tokens.md @@ -1,5 +1,7 @@ ## Check Gitlab tokens +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. Gitlab has an api requrest `/personal_access_tokens` but it doesn't have the information about the project or usergroup where it is defined. @@ -15,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 444232b..81287b4 100644 --- a/docs/20_Checks/check_haproxy_health.md +++ b/docs/20_Checks/check_haproxy_health.md @@ -1,5 +1,7 @@ ## Check HA-Proxy health +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 789c71b..0a0f5ec 100644 --- a/docs/20_Checks/check_haproxy_status.md +++ b/docs/20_Checks/check_haproxy_status.md @@ -1,5 +1,7 @@ ## Check HA-Proxy Status +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 e739583..cc43289 100644 --- a/docs/20_Checks/check_http.md +++ b/docs/20_Checks/check_http.md @@ -1,5 +1,7 @@ ## Check Httpd +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 5fd2212..a33c630 100644 --- a/docs/20_Checks/check_iml_backup_server.md +++ b/docs/20_Checks/check_iml_backup_server.md @@ -1,5 +1,7 @@ ## Check IML backup server +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 9b383f2..cd8528f 100644 --- a/docs/20_Checks/check_journallog.md +++ b/docs/20_Checks/check_journallog.md @@ -1,5 +1,7 @@ ## Check Systemd unit +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 6381670..a576581 100644 --- a/docs/20_Checks/check_memory.md +++ b/docs/20_Checks/check_memory.md @@ -1,5 +1,7 @@ ## Check Memory (RAM) +Script: `check_memory` + **check_memory** Check memory usage incl. free, used and total memory. It reads /proc/meminfo and fetches the needed values. diff --git a/docs/20_Checks/check_mysqlserver.md b/docs/20_Checks/check_mysqlserver.md index 00c763e..68fb818 100644 --- a/docs/20_Checks/check_mysqlserver.md +++ b/docs/20_Checks/check_mysqlserver.md @@ -1,5 +1,7 @@ ## Check Mysql / mariadb server +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 6975cb7..ce7f745 100644 --- a/docs/20_Checks/check_netio.md +++ b/docs/20_Checks/check_netio.md @@ -1,5 +1,7 @@ ## Check_netio +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. diff --git a/docs/20_Checks/check_netstat.md b/docs/20_Checks/check_netstat.md index df04c32..9274037 100644 --- a/docs/20_Checks/check_netstat.md +++ b/docs/20_Checks/check_netstat.md @@ -1,5 +1,7 @@ ## Check netstat +Script: `check_netstat` + Count number of network connections. ## Syntax diff --git a/docs/20_Checks/check_onehost.md b/docs/20_Checks/check_onehost.md index 34c2b79..e9b2be5 100644 --- a/docs/20_Checks/check_onehost.md +++ b/docs/20_Checks/check_onehost.md @@ -1,5 +1,7 @@ ## Check OpenNebula hosts +Script: `check_onehost` + **check_onevm** is a plugin to show count of hosts in OpenNebula and warn if a host is down. ## Requirements diff --git a/docs/20_Checks/check_onevm.md b/docs/20_Checks/check_onevm.md index da56a9e..4a42f19 100644 --- a/docs/20_Checks/check_onevm.md +++ b/docs/20_Checks/check_onevm.md @@ -1,5 +1,7 @@ ## Check OpenNebula virtual machines +Script: `check_onevm` + **check_onevm** is a plugin to show count of vms in OpenNebula - listed by state and by host. The version 1.4 identifies these status values: diff --git a/docs/20_Checks/check_opencpu.md b/docs/20_Checks/check_opencpu.md index 4013842..40e11ea 100644 --- a/docs/20_Checks/check_opencpu.md +++ b/docs/20_Checks/check_opencpu.md @@ -1,5 +1,7 @@ ## Check_opencpu +Script: `check_opencpu` + Test if OpenCpu is available via http and test if given packages are installed. ### Requirements diff --git a/docs/20_Checks/check_packages2install.md b/docs/20_Checks/check_packages2install.md index cde17d2..4e60971 100644 --- a/docs/20_Checks/check_packages2install.md +++ b/docs/20_Checks/check_packages2install.md @@ -1,5 +1,7 @@ ## Check_packages2install +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 5f614f2..837bbb5 100644 --- a/docs/20_Checks/check_php-fpm-status.md +++ b/docs/20_Checks/check_php-fpm-status.md @@ -1,5 +1,7 @@ ## Check_php-fpm-status +Script: `check_php-fpm-status` + The check fetches several counters from php-fm-status page. ## Requirements diff --git a/docs/20_Checks/check_proc_mem.md b/docs/20_Checks/check_proc_mem.md index 952ec92..7732c16 100644 --- a/docs/20_Checks/check_proc_mem.md +++ b/docs/20_Checks/check_proc_mem.md @@ -1,5 +1,7 @@ ## Check memory consuming processes +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 99489c3..d26ab3e 100644 --- a/docs/20_Checks/check_proc_ressources.md +++ b/docs/20_Checks/check_proc_ressources.md @@ -1,5 +1,7 @@ ## Check process resources regarding cpu and memory +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 e9aa946..1c1706b 100644 --- a/docs/20_Checks/check_proc_zombie.md +++ b/docs/20_Checks/check_proc_zombie.md @@ -1,5 +1,7 @@ ## Check_proc_zombie +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 2329bc3..8945998 100644 --- a/docs/20_Checks/check_psqlserver.md +++ b/docs/20_Checks/check_psqlserver.md @@ -1,5 +1,7 @@ ## Check PostgreSql server +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 f4d97f4..acb88d6 100644 --- a/docs/20_Checks/check_rearbackup.md +++ b/docs/20_Checks/check_rearbackup.md @@ -1,5 +1,7 @@ ## Check Rear backup +Script: `check_rearbackup` + This check can verify the age of all iso files in the backup target directory. ## Requirements diff --git a/docs/20_Checks/check_reboot_required.md b/docs/20_Checks/check_reboot_required.md index 25e066d..47deb3c 100644 --- a/docs/20_Checks/check_reboot_required.md +++ b/docs/20_Checks/check_reboot_required.md @@ -1,5 +1,7 @@ ## Check Reboot required +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 15d5ed8..feef6f7 100644 --- a/docs/20_Checks/check_requirements.md +++ b/docs/20_Checks/check_requirements.md @@ -1,5 +1,7 @@ ## Check_requirements +Script: `check_requirements` + **check_requirements** is a plugin to run different check to show the ability to run an application. You can these checks * Check if a process exists diff --git a/docs/20_Checks/check_smartstatus.md b/docs/20_Checks/check_smartstatus.md index 1fac6a4..fc1d399 100644 --- a/docs/20_Checks/check_smartstatus.md +++ b/docs/20_Checks/check_smartstatus.md @@ -1,5 +1,7 @@ ## Check_smartstatus +Script: `check_smartstatus` + **check_smartstatus** is a plugin run a smartctl check to verify the disk status of all local harddisks/ ssds. It works on physical machines only. diff --git a/docs/20_Checks/check_snmp_data.md b/docs/20_Checks/check_snmp_data.md index d54fb2d..807b560 100644 --- a/docs/20_Checks/check_snmp_data.md +++ b/docs/20_Checks/check_snmp_data.md @@ -1,5 +1,7 @@ ## Check SNMP data +Script: `check_snmp_data` + **check_snmp_data** is a plugin for fetching performance data with a set of given OIDs. It can handle current values (i.e. load / cpu usage / disc usage) and counter values (i.e. network io). diff --git a/docs/20_Checks/check_snmp_synology.md b/docs/20_Checks/check_snmp_synology.md index df59d94..bbbbbda 100644 --- a/docs/20_Checks/check_snmp_synology.md +++ b/docs/20_Checks/check_snmp_synology.md @@ -1,5 +1,7 @@ ## Check SNMP Synology +Script: `check_snmp_synology` + **check_snmp_data** is a plugin to check the status of a Synology storage using snmp v2 or v3. ## Syntax diff --git a/docs/20_Checks/check_ssl_certs.md b/docs/20_Checks/check_ssl_certs.md index 8fbed68..de9814f 100644 --- a/docs/20_Checks/check_ssl_certs.md +++ b/docs/20_Checks/check_ssl_certs.md @@ -1,5 +1,7 @@ ## Check ssl certs +Script: `check_ssl_certs` + **check_ssl_certs** is a plugin to check local certificats. It loops over 1 or multiple certificate files and reads the expiration date from is. diff --git a/docs/20_Checks/check_systemdunit.md b/docs/20_Checks/check_systemdunit.md index fbe1bcd..e23adeb 100644 --- a/docs/20_Checks/check_systemdunit.md +++ b/docs/20_Checks/check_systemdunit.md @@ -1,5 +1,7 @@ ## Check Systemd unit +Script: `check_systemdunit` + This check shows the status of a systemd unit. A unit is everything listed by systemctl command - services, timers, targets, ... -- GitLab