Collection of standard plugins to discover and gather cloud-to-edge metrics and status across your whole IT infrastructure.
Go to file
Kevin Duret 9c4e15e1f1
fix(ci): detect properly plugin changes in lib directory (#4264)
2023-03-08 10:35:39 +01:00
.github fix(ci): detect properly plugin changes in lib directory (#4264) 2023-03-08 10:35:39 +01:00
doc
packaging (plugin) hardware::ups::riello::snmp - new (#4223) 2023-02-16 09:09:18 +01:00
src fix(ci): detect properly plugin changes in lib directory (#4264) 2023-03-08 10:35:39 +01:00
LICENSE.txt
README.md
changelog update changelog 20230118 (#4158) 2023-01-18 15:50:07 +01:00

README.md

centreon-plugins

License

Contributors Stars Forks Issues

“centreon-plugins” is a free and open source project to monitor systems. The project can be used with Centreon and all monitoring softwares compatible with Nagios plugins.

You can monitor many systems:

  • application: Apache, Asterisk, Elasticsearch, Github, Jenkins, Kafka, Nginx, Pfsense, Redis, Tomcat, Varnish,...
  • cloud: AWS, Azure, Docker, Office365, Nutanix, Prometheus,...
  • database: Firebird, Informix, MS SQL, MySQL, Oracle, Postgres, Cassandra
  • hardware: printers (rfc3805), UPS (Powerware, Mge, Standard), Sun Hardware, Cisco UCS, SensorIP, HP Proliant, HP Bladechassis, Dell Openmanage, Dell CMC, Raritan,...
  • network: Aruba, Brocade, Bluecoat, Brocade, Checkpoint, Cisco AP/IronPort/ASA/Standard, Extreme, Fortigate, H3C, Hirschmann, HP Procurve, F5 BIG-IP, Juniper, PaloAlto, Redback, Riverbed, Ruggedcom, Stonesoft,...
  • os: Linux (SNMP, NRPE), Freebsd (SNMP), AIX (SNMP), Solaris (SNMP)...
  • storage: EMC Clariion, Netapp, Nimble, HP MSA p2000, Dell EqualLogic, Qnap, Panzura, Synology...

Basic Usage

We'll use a basic example to show you how to monitor a system. I have finished the install section and I want to monitor a Linux in SNMP. First, I need to find the plugin to use in the list:

$ perl centreon_plugins.pl --list-plugin | grep -i linux | grep 'PLUGIN'
PLUGIN: os::linux::local::plugin
PLUGIN: os::linux::snmp::plugin

It seems that 'os::linux::snmp::plugin' is the good one. So I verify with the option --help to be sure:

$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --help
...
Plugin Description:
  Check Linux operating systems in SNMP.

It's exactly what I need. Now I'll add the option --list-mode to know what can I do with it:

$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --list-mode
...
Modes Available:
 processcount
 time
 list-storages
 disk-usage
 diskio
 uptime
 swap
 cpu-detailed
 load
 traffic
 cpu
 inodes
 list-diskspath
 list-interfaces
 packet-errors
 memory
 tcpcon
 storage

I would like to test the 'load' mode:

$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load
UNKNOWN: Missing parameter --hostname.

It's not working because some options are missing. I can have a description of the mode and options with the option --help:

$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --help

Eventually, I have to configure some SNMP options:

$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public
OK: Load average: 0.00, 0.00, 0.00 | 'load1'=0.00;;;0; 'load5'=0.00;;;0; 'load15'=0.00;;;0;

I can set threshold with options --warning and --critical:

$ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --warning=1,2,3 --critical=2,3,4
OK: Load average: 0.00, 0.00, 0.00 | 'load1'=0.00;0:1;0:2;0; 'load5'=0.00;0:2;0:3;0; 'load15'=0.00;0:3;0:4;0;

For more information or help, please read 'doc/en/user/guide.rst'.

Continuous integration

Please follow documentation here