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

Merge branch 'simple-task/7546-icinga-check-für-ablaufende-gitlab-tokens' into 'master'

OP#7559 Doku der Icinga checks - keine H1 Überschriften verwenden  https://projects.iml.unibe.ch/work_packages/7559

See merge request !284
parents 3440a724 a9ed9bda
No related branches found
No related tags found
1 merge request!284OP#7559 Doku der Icinga checks - keine H1 Überschriften verwenden https://projects.iml.unibe.ch/work_packages/7559
Showing
with 52 additions and 59 deletions
# Checks
## Shared functions
There is one include script used by all checks:
[inc_pluginfunctions](inc_pluginfunctions.md)
## Check scripts
* [about](about.md)
......
# About
## About
## Introduction
Script: `about`
This check shows a short summary for the current system.
Its status is always OK.
......
# Check_apache_requests
## Check_apache_requests
## Introduction
Script: `check_apache_requests`
After requesting the apache servre status page you get
......
# 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
......
# 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
......
# 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.
......
# 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.
......
# 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
......
# check_couchdb
## Check_couchdb
## Introduction
Script: `check_couchdb`
Check couchdb status.
......
# 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)
......
# 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
......
# 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.
......
# 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
......
# 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.
......
# 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.
......
# CHECK_DOCKERCONTAINER_TOP
## CHECK_DOCKERCONTAINER_TOP
## Introduction
Script: `check_dockercontainer_top`
**check_dockercontaeiner_top** shows the docker top output for each container.
......
## 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).
......
# 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
......
# 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.
......
# 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`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment