Changeset 265

Timestamp:

Jun 26, 2018, 6:54:14 PM (7 years ago)

Author:

g7moreau

Message:

• Add a lot of doc !

File:

• trunk/nagios-velvice/velvice.cgi (modified) (3 diffs)

trunk/nagios-velvice/velvice.cgi

@@ -15 +15 @@
 use strict;
 use warnings;
-use version; our $VERSION = version->declare('0.7.2');
+use version; our $VERSION = version->declare('0.7.3');
 
 use CGI;
@@ -304 +304 @@
 velvice.cgi - nagios velvice alert panel
 
+=head1 USAGE
+
+ velvice.cgi
+ velvice.cgi?check=XXX
+
 
 =head1 DESCRIPTION
 
 Nagios VELVICE is an acronym for "Nagios leVEL serVICE status".
-Homepage: http://servforge.legi.grenoble-inp.fr/projects/soft-trokata/wiki/SoftWare/NagiosVelvice
-
-=head1 AUTHORS
-
-Written by Gabriel Moreau - Grenoble - France
+
+The Nagios web page is sometimes very graphically charged
+and does not necessarily contain the information you need at a glance.
+For example, it is quite complicated to restart controls on multiple hosts in one click.
+
+For example, a server that is down should take only one line and not one per service...
+Similarly, a service that has been down for 5 minutes or since yesterday
+has more weight than a service that has fallen for 15 days.
+
+With Velvice Panel, a broken down server takes only one line.
+Services that have been falling for a long time gradually lose their color and become pastel colors.
+
+With Velvice Panel, it is possible through a single click
+to redo a check of all services that are in the CRITICAL state.
+Similarly, it is possible to restart a check on all SSH services in breakdowns ...
+In order not to clog the Nagios server, checks are shifted by 2 seconds in time.
+
+There is also a link to the web page of the main Nagios server.
+For each computer, you have a direct link to its dedicated web page on this server.
+
+
+=head1 CONFIGURATION FILE SPECIFICATION
+
+The configuration file must be F</etc/nagios3/velvice.yml>.
+This is not a required file.
+The file is in YAML format because this is a human-readable text file style.
+Other formats could have been Plain XML, RDF, JSON... but they are much less readable.
+
+You can find in the software nagios-velvice an example of configuration:
+L<velvice.sample.yml|http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/nagios-velvice/velvice.sample.yml>.
+This one is in fact the master reference specification!
+
+The main keys C<nagios-server> and C<color-downtime> have good default values.
+No secondary key is required...
+
+With key C<host-mapping>,
+it's good to map C<localhost> to the real name of the computer (hostname).
+
+The only important key is C<remote-action>.
+You can affiliate as many subkeys as you want.
+Let's take an example:
+
+ remote-action:
+   oom-killer:
+     regex: ^OOM Killer
+     title:  OOM Killer
+     command:     tssh -c 'sudo rm /var/lib/nagios3/nagios_oom_killer.log' %m
+     command-one: ssh %m 'sudo rm /var/lib/nagios3/nagios_oom_killer.log'
+     depend: ^SSH
+     status: ALL
+     style: bold
+
+C<oom-killer> is just a key for your remote action.
+The regex is used to find which service has a problem...
+The title is use in the result web page (not mandatory - otherwise, it will be C<Action: oom-killer>).
+The C<command> is just written on this web page.
+You have the responsibility to copy / cut it on a terminal.
+For security reasons, the nagios server does not have the right to launch the command on the remote host.
+The wildcard C<%m> is replaced by the list of the host (separated by the space).
+Sometime, the command could be different if there is only one computer (just SSH and no parallel SSH).
+If your command is based on SSH,
+you can have an SSH action only if the remote SSH is running.
+So you can make the remote action depend on the SSH service through a regular expression of your choice.
+
+The last two keys.
+The C<status> key is for CRITICAL or WARNING (or ALL).
+The key C<style> is there to mark in bold the service in error on the web page.
+
+=head1 SEE ALSO
+
+yamllint(1), ysh(1), YAML, Nagios::StatusLog, Color::Calc
+
+In Debian GNU/Linux distribution, packages for C<yamllint> and C<ysh> are:
+
+=over
+
+=item * C<yamllint> - Linter for YAML files (Python)
+
+=item * C<libyaml-shell-perl> - YAML test shell (Perl)
+
+=back
+
+
+Own project ressources:
+
+=over
+
+=item * L<Web site|http://servforge.legi.grenoble-inp.fr/projects/soft-trokata/wiki/SoftWare/NagiosVelvice>
+
+=item * L<Online Manual|http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/nagios-velvice/velvice.html>
+
+=item * L<SVN repository|http://servforge.legi.grenoble-inp.fr/svn/soft-trokata/trunk/nagios-velvice>
+
+=back
+
+
+=head1 VERSION
+
+$Id: klask 397 2018-02-28 18:53:47Z g7moreau $
+
+
+=head1 AUTHOR
+
+Written by Gabriel Moreau <Gabriel.Moreau(A)univ-grenoble-alpes.fr>, LEGI UMR 5519, CNRS, Grenoble - France
 
 
@@ -319 +423 @@
 Licence GNU GPL version 2 or later and Perl equivalent
 
-Copyright (C) 2014-2018 Gabriel Moreau <Gabriel.Moreau(A)univ-grenoble-alpes.fr>.
+Copyright (C) 2014-2018, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France