From 08de031cb54caeb3d974141131a46ac978452b80 Mon Sep 17 00:00:00 2001 From: Peter Stevenson <2e0pgs@gmail.com> Date: Wed, 28 Nov 2018 03:19:21 +0000 Subject: [PATCH] Improve documentation for service plugins (#9414) * Begin adding preinstalled plugin documentation. Also add information about how the titles of the plugins are displayed and detected. Make page visible on the websites Table of Contents. * Add note about plugin loading based on file name. * Added all monitoring-plugins URLs. * Format URLs on the service plugin docs list. * Correct a URL on the plugins list. * Removed leftover text from plugin list docs. * Add pkg-nagios-plugins-contrib plugins to docs. * Add DSA pkg-nagios-plugins-contrib plugins to docs * Added a few missing lines of pkg-nagios-plugins-contrib text. * Remove links plugins we dont have URL for. Add a few more pkg-nagios-plugins-contrib ones. * Remove list. Point to the main sources directly. --- doc/Extensions/Services.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/Extensions/Services.md b/doc/Extensions/Services.md index d9c01029c3..3472cee0cf 100644 --- a/doc/Extensions/Services.md +++ b/doc/Extensions/Services.md @@ -1,12 +1,22 @@ source: Extensions/Services.md path: blob/master/doc/ -# Setting up Services +[TOC] + +# Setting up services Services within LibreNMS provides the ability to use Nagios plugins to perform additional monitoring outside of SNMP. **These services are tied into an existing device so you need at least one device to be able to add it to LibreNMS - localhost is a good one. This is needed in order for alerting to work properly.** +## Pre installed plugins + +Note: Plugins will only load if they are prefixed with "check_" and they have that prefix stripped out when displaying in the "Add Serice" GUI "Type" dropdown list. + +Plugins come from two main places [pkg-nagios-plugins-contrib](https://github.com/bzed/pkg-nagios-plugins-contrib) and [monitoring-plugins](https://www.monitoring-plugins.org). This is where you can find the documentation for most, if not all of the plugins. + +The plugins are bundled with the pre build VM images via the packge `monitoring-plugins` in Ubuntu and `nagios-plugins-all` in CentOS. + ## Setup > Service checks is now distributed aware. If you run a distributed setup then you can now run