Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/al2klimov/check_autoremove
https://github.com/al2klimov/check_autoremove
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/al2klimov/check_autoremove
- Owner: Al2Klimov
- License: mpl-2.0
- Created: 2019-09-14T10:49:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T19:57:05.000Z (over 3 years ago)
- Last Synced: 2023-08-06T23:11:21.301Z (over 1 year ago)
- Language: Go
- Size: 21.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
The check plugin **check\_autoremove** monitors whether
any software packages were just dependencies of others and may be removed.
## Usage
The [plug-and-play Linux binaries]
take the following CLI arguments and no environment variables:
```
$ ./check_autoremove [-warn THRESHOLD] [-crit THRESHOLD]
```
THRESHOLD specifies an alert threshold range
conforming to the [Nagio$ check plugin API],
e.g. `-warn @~:42` warns if there are <= 42 unneeded dependencies.
### Legal info
To print the legal info, execute the plugin in a terminal:
```
$ ./check_autoremove
```
In this case the program will always terminate with exit status 3 ("unknown")
without actually checking anything.
### Testing
If you want to actually execute a check inside a terminal,
you have to connect the standard output of the plugin to anything
other than a terminal – e.g. the standard input of another process:
```
$ ./check_autoremove |cat
```
In this case the exit code is likely to be the cat's one.
This can be worked around like this:
```
bash $ set -o pipefail
bash $ ./check_autoremove |cat
```
### Actual monitoring
Just integrate the plugin into the monitoring tool of your choice
like any other check plugin. (Consult that tool's manual on how to do that.)
It should work with any monitoring tool
supporting the [Nagio$ check plugin API].
Limitations:
* check\_autoremove must be run on the host to be checked –
either with an agent of your monitoring tool or by SSH.
Otherwise it will check the host your monitoring tool runs on.
* **The check\_autoremove binary must be owned by root
and the setuid bit must be set**, i.e.:
`chown root .../check_autoremove; chmod u+s .../check_autoremove`
#### Icinga 2
This repository ships the [check command definition]
as well as a [service template] and [host example] for [Icinga 2].
The service definition will work in both correctly set up [Icinga 2 clusters]
and Icinga 2 instances not being part of any cluster
as long as the [hosts] are named after the [endpoints].
[plug-and-play Linux binaries]: https://github.com/Al2Klimov/check_autoremove/releases
[Nagio$ check plugin API]: https://nagios-plugins.org/doc/guidelines.html#AEN78
[check command definition]: ./icinga2/check_autoremove.conf
[service template]: ./icinga2/check_autoremove-service.conf
[host example]: ./icinga2/check_autoremove-host.conf
[Icinga 2]: https://www.icinga.com/docs/icinga2/latest/doc/01-about/
[Icinga 2 clusters]: https://www.icinga.com/docs/icinga2/latest/doc/06-distributed-monitoring/
[hosts]: https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#host
[endpoints]: https://www.icinga.com/docs/icinga2/latest/doc/09-object-types/#endpoint