The Linuxfabrik Monitoring Plugins Collection

image

This Enterprise Class Check Plugin Collection made by Linuxfabrik offers a package of 200+ Python-based, Nagios-compatible check plugins for Icinga, Naemon, Nagios, OP5, Shinken, Sensu and other monitoring applications. Each plugin is a stand-alone command line tool that provides a specific type of check. Typically, your monitoring software will run these check plugins to determine the current status of hosts and services on your network.

The check plugins run on

  • Linux - Tested on RHEL 7+, Fedora 30+, Ubuntu Server 16+, Debian 9+, SLES 15+

  • Windows - Tested on Windows 10+ and Windows Server 2019+

All plugins are written in Python and licensed under the UNLICENSE, which is a license with no conditions whatsoever that dedicates works to the public domain.

The plugins are fast, reliable and use as few system resources as possible. They uniformly and consistently report the same metrics briefly and precisely on all platforms (for example, always „used“ instead of a mixture of „used“ and „free“). Automatic detection and Auto-Discovery mechanisms are built-in where possible. Using meaningful default settings, the plugins trigger WARNs and CRITs only where absolutely necessary. In addition they provide information for troubleshooting. We try to avoid dependencies on 3rd party system libraries where possible.

Support & Sponsoring

The source code is published here without support. If you need Enterprise Support, conclude a Service Contract.

If you simply like to support our work, please consider donating and become a sponsor:

  • GitHubSponsors

  • PayPal

Do you think more people should know about it? Sharing is caring, so feel free to spread the word. We would really appreciate if you share this on any social media, or link this site on any blog or forum. Or more specifically: It would be great if you could tell on GitHub discussions how you use the plugins.

Installation

  • Have a look at the INSTALL document for the various options, including SELinux etc.

  • For details on installing the plugins in Icinga Director, see ICINGA.

Reporting Issues

For now, there are two ways:

  1. Submit an issue (preferred).

  2. Contact us by email or web form and describe your problem.

Check Plugin Poster

See some of our check plugins at a glance on an Icinga server:

about-me   apache-httpd-status   apache-httpd-version   apache-solr-version   cpu-usage   crypto-policy   disk-io   disk-usage   dmesg   dns   fail2ban   file-age   file-count   file-descriptors   file-ownership   file-size   fs-inodes   fs-ro   githubstatus   gitlab-health   gitlab-liveness   gitlab-readiness   gitlab-version   grafana-version   infomaniak-events   infomaniak-swiss-backp-devices   infomaniak-swiss-backup-products   journald-query   journald-usage   keycloak-version   kvm-vm   librenms-alerts   librenms-health   librenms-version   load   mailq   matomo-version   memory-usage   mydumper-version   mysql-aria   mysql-connections   mysql-database-metrics   mysql-innodb-buffer-pool-instances   mysql-innodb-buffer-pool-size   mysql-innodb-log-waits   mysql-joins   mysql-logfile   mysql-memory   mysql-open-files   mysql-perf-metrics   mysql-slow-queries   mysql-sorts   mysql-storage-engines   mysql-system   mysql-table-cache   mysql-table-definition-cache   mysql-table-indexes   mysql-table-locks   mysql-temp-tables   mysql-thread-cache   mysql-traffic   mysql-user-security   mysql-version   network-connections   network-io   network-port-tcp   nextcloud-security-scan   nextcloud-stats   nextcloud-version   ntp-chronyd   openstack-nova-list   openstack-swift-stat   openvpn-client-list   path-rw-test   php-fpm-ping   php-fpm-status   php-status   php-version   ping   postfix-version   procs   redis-status   redis-version   rhel-version   rocketchat-stats   rocketchat-version   rpm-lastactivity   selinux-mode   service   starface-account-stats   starface-backup-status   starface-channel-status   starface-database-stats   starface-java-memory-usage   starface-peer-stats   starface-status   statuspal   swap-usage   systemd-unit   systemd-units-failed   tuned-profile   updates   uptime   users   wildfly-deployment-status   wildfly-gc-status   wildfly-memory-pool-usage   wildfly-memory-usage   wildfly-non-xa-datasource-stats   wildfly-server-status   wildfly-thread-usage   wildfly-uptime   wildfly-xa-datasources-stats   wordpress-version   xca-cert  

If you zoom in, for example on CPU Usage:

image

Feedback from our Community

Some comments from the community about our monitoring plugins:

Thanks again @linuxfabrik for writing the csv-values check the way you did and not what I originally requested ;-)

Dominik Riva

… the Linuxfabrik-Monitoring-Plugins are great, thanks for your effort, we are using them very much.

Patric Stiffel

… thanks for your awesome plugins.

Robert Christian

… Thanks for your awesome work & have a good day.

\Barney

… the Linux fabrik plugins are excellent.

u/exekewtable@reddit

… I can recommend this family of plugins, they are the highest quality I have seen around. …

u/exekewtable@reddit

Ich bin vor kurzem (via Video vom Icinga Camp) über Eure Monitoringplugins gestolpert. Ganz herzlichen Dank dafür, großartige Arbeit!!

– Christian Lox

… many thanks for your great collection of monitoring plugins! I’ve just found them - clean structure and output, cross-platform, Icinga Directory Basket configurations - loving it and currently migrating step by step most of my checks to use them where possible. 😍

Bernd Bestel

Nachdem ich beim Versuch, Nagios-Plugins auf VMwares Photon-OS zum laufen zu kriegen, graue Haare gekriegt habe, haben mir eure Plugins zum Ziel verholfen.

MajorTwip

A well engineered, regularly updated and maintained collection of plugins. Specially focused on Linux servers/VMs and used at large scale by the company developing it.

straessler

Hello, I stumbled across your collection and am thrilled! Especially the extensive documentary and the Director Baskets are a dream.

– Stefan Beining

Merchandise! ;-)

The „Linuxfabrik Monitoring Plugins“ on a card of our popular Open Source Quartet from 2023 🙂. Sold out, but there’s still more to discover in the Linuxfabrik Spreadshop.

image

Human Readable Numbers

Regarding the check plugin output, this is how we convert and append symbols to large numbers in a human-readable format (according to Wikipedia Names of large numbers, and other).

Since the primary hosting platform is Linux, which uses IEC, the plugins display byte sizes in powers of 2 (KiB, MiB, GiB etc.) - otherwise it would be very confusing to have the monitoring plugins said something different than the command line.

Value

Symbol

Origin

Type

Description

1000^1

K

Number

Thousand

1000^2

M

SI Symbol

Number

Million (1), Million (2)

1000^3

G

SI Symbol

Number

Milliard (1), Billion (2)

1000^4

T

SI Symbol

Number

Billion (1), Trillion (2)

1000^5

P

SI Symbol

Number

Billiard (1), Quadrillion (2)

1000^6

E

SI Symbol

Number

Trillion (1), Quintillion (2)

1000^7

Z

SI Symbol

Number

Trilliard (1), Sextillion (2)

1000^8

Y

SI Symbol

Number

Quadrillion (1), Septillion (2)

1024^0

B

Bytes

Bytes

1024^1

KiB

IEC unit

Bytes

Kibibytes

1024^2

MiB

IEC unit

Bytes

Mebibytes

1024^3

GiB

IEC unit

Bytes

Gibibytes

1024^4

TiB

IEC unit

Bytes

Tebibytes

1024^5

PiB

IEC unit

Bytes

Pebibytes

1024^6

EiB

IEC unit

Bytes

Exbibytes

1024^7

ZiB

IEC unit

Bytes

Zebibytes

1024^8

YiB

IEC unit

Bytes

Yobibytes

1000^1

KB

Bytes

Kilobytes

1000^2

MB

Bytes

Megabytes

1000^3

GB

Bytes

Gigabytes

1000^4

TB

Bytes

Terrabytes

1000^5

PB

Bytes

Petabytes

1000^6

EB

Bytes

Exabytes

1000^7

ZB

Bytes

Zetabytes

1000^8

YB

Bytes

Yottabytes

1000^1

Kbps

Bits per Second

Kilobits

1000^2

Mbps

Bits per Second

Megabits

1000^3

Gbps

Bits per Second

Gigabits

1000^4

Tbps

Bits per Second

Terrabits

1000^5

Pbps

Bits per Second

Petabits

1000^6

Ebps

Bits per Second

Exabits

1000^7

Zbps

Bits per Second

Zetabits

1000^8

Ybps

Bits per Second

Yottabits

1e-12

ps

Time

Picoseconds

1e-9

ns

Time

Nanoseconds

1e-6

us

Time

Microseconds

1e-3

ms

Time

Milliseconds

1..59

s

Time

Seconds

60

m

Time

Minutes

60*60

h

Time

Hours

60*60*24

D

Time

Days

60*60*24*7

W

Time

Weeks

60*60*24*30

M

Time

Months

60*60*24*365

Y

Time

Years

  • (1): Traditional European (Peletier, long scale)

  • (2): US, Canada and modern British (short scale)

Threshold and Ranges

If a check supports Nagios ranges, they can be used as follows:

  • Simple value: A range from 0 up to and including the value.

  • A „Range“ is the same as on nagios-plugins.org: … defined as a start and end point (inclusive) on a numeric scale (possibly negative or positive infinity)., in the format start:end.

  • Empty value after :: Positive infinity.

  • ~: Negative infinity.

  • @: Like a NOT for the whole expression. So if range starts with @, then alert if inside this range (including endpoints).

Examples:

-w, -c

OK if result is

WARN/CRIT if

10

in (0..10)

not in (0..10)

-10

in (-10..0)

not in (-10..0)

10:

in (10..inf)

not in (10..inf)

:

in (0..inf)

not in (0..inf)

~:10

in (-inf..10)

not in (-inf..10)

10:20

in (10..20)

not in (10..20)

@10:20

not in (10..20)

in 10..20

@~:20

not in (-inf..20)

in (-inf..20)

@

not in (0..inf)

in (0..inf)

Command, Parameters and Arguments

Shell commands like ./file-age --filename='/tmp/*' have two basic parts:

  • Command name of the program to run (./file-age). May be followed by one or more options, which adjust the behavior of the command or what it will do.

  • Options/Parameters normally start with one or two dashes to distinguish them from arguments (parameter --filename, value '/tmp/*'). They adjust the behavior of the command. Parameters may be short (-w) or long (--warning). We prefer and often offer only the long version.

Many shell commands may also be followed by one or more arguments, which often indicate a target that the command should operate upon (useradd linus for example) . This does not apply to the check-plugins.

To avoid problems when passing parameter values that start with a -, the command line call must look like this:

  • Long parameters: ./file-age --warning=-60:3600 (use --param=value instead of --param value).

  • Short parameters: ./file-age -w-60:3600 (so simply not putting any space nor escaping it in any special way).

Directory Layout explained

└── plugin-name
    ├── assets                      Additional ressources, for example helper scripts like monitoring.php
    ├── grafana                     Grafana dashboard definition
    ├── icingaweb2-module-director  Icinga Director basket definition
    ├── icingaweb2-module-grafana   Grafana panel definition for Icinga's Grafana module
    ├── lib                         Link to the Linuxfabrik Python libraries
    ├── unit-test                   File for unit tests
    │   ├── retc                    Files for simulating return codes
    │   ├── stdin                   Files for simulating output to STDOUT
    │   ├── stdout                  Files for simulating output to STDERR
    │   └── run                     The unit test
    └── plugin-name                 The monitoring plugin

Python

When running from source, almost all check plugins are happy with at least Python 3.6. All plugins define the #!/usr/bin/env python3 shebang.

Icons

You can download all check plugin icons from download.linuxfabrik.ch. For Icinga, put them in /usr/share/icingaweb2/public/img/icons/.

Grafana

See GRAFANA

Contributing

See CONTRIBUTING

Compiling

See BUILD

Tips & Tricks

Q: How can I remove the performance data after the | from the check output?

A: In Bash, use /usr/lib64/nagios/plugins/check-command | cut -f1 -d'|'

Q: Do the plugins also handle proxy environment variables like HTTP_PROXY?

A: Yes, HTTP_PROXY, HTTPS_PROXY, http_proxy and http_proxy are automatically used by the Linuxfabrik monitoring plugins if they are set.

Q: Icinga does not seem to pass the environment variable http_proxy to the plugins. What am i doing wrong?

This has nothing to do with the Linuxfabrik monitoring plugins - the Icinga configuration needs to be adjusted here. You need to do some additional configuration to make custom environment variables generally available. According to this Icinga community post you need to set them in /etc/icinga2/icinga2.conf:

template CheckCommand default {
  env.http_proxy = "http://username:password@proxy.example.com:port"
  env.https_proxy = "http://username:password@proxy.example.com:port"
}

If you are also using sudo to call some plugins from within Icinga, you will also need to set this in your /etc/sudoers.d/whatever.sudoers:

Defaults env_keep += "http_proxy https_proxy"

Pro tips:

  • Note that you can’t set environment variables in Icinga Director. Even if you are only using the Icinga Director, follow the steps above.

  • Environment variables with the same name in both /etc/environment and /etc/icinga2/icinga2.conf will be overwritten by /etc/icinga2/icinga2.conf.

Q: All pipe characters | in the output of any plugin are replaced with !. Why?

A: We have to. The output syntax of Nagios plugins is fixed and not very flexible:

Output lines | Performance data

So the | character is reserved to separate plugin output from performance data. There is no way to escape it - so we have to replace it with !.