Nagios plugin for doing a GitLab health check.
Copyright (c) 2022 Dennis Neufeld Copyright (c) 2021 Hernán Collazo Copyright (c) 2020 Kevin Krumbiegel
- Download the check_gitlab.py file.
- Mark the file as executable (i.e. using
sudo chmod +x ~/check_gitlab.py) - Move the file to /usr/lib/nagios/plugins/ (i.e. using
mv ~/check_gitlab.py /usr/lib/nagios/plugins/check_gitlab.py)
- Download the check_gitlab.py file.
- Execute the file (Python 3 needs to be installed)
Usage:
check_gitlab.py [-h] -s <server_url> [-t <access_token>] [--check-all] [--check-cache] [--check-db] [--check-gitaly] [--check-master] [--check-queues] [--check-rate-limiting] [--check-sessions] [--check-shared-state] [--check-trace-chunks]
- General
-s <server_url>= URL of the server to be checked. (i.e. https://gitlab.example.org/)-t <access_token>= Access token for Gitlab Health Checks. (visit https://gitlab.example.org/admin/health_check)-h= This help screen
- Checks:
--check-all= Enable all checks--check-cache= Enable checking cache status--check-db= Enable checking database status--check-gitaly= Enable checking gitaly status--check-master= Enable checking master status--check-queues= Enable checking queues status--check-rate-limiting= Enable checking rate limiting status--check-sessions= Enable checking session status--check-shared-state= Enable checking shared state status--check-trace-chunks= Enable checking trace chunks status
The check_gitlab script queries the JSON-API endpoint of a GitLab server using the "Readiness" feature. By now it checks whether the status of all specified modules is "ok". In case the status is not okay, a cricital condition will be reported. If an exception occurs or the check is executed with bad parameter configuration, an unknown condition will be reported.
For further information see: