Code

README.Debian: Improved typesetting a bit ;-)
[pkg-pnp4nagios.git] / debian / README.Debian
1 PNP4Nagios for Debian
2 ---------------------
4 PNP4Nagios supports several modes of operation. They differ in the way how
5 performance data is being processed and, thus, the efficiency of PNP. Detailed
6 documentation is available at <http://docs.pnp4nagios.org/pnp-0.6/modes>.
8 Using bulk mode for Nagios3
9 ---------------------------
11 We recommend to use bulk mode with NPCD and npcdmod. This will facilitate an
12 easy installation and fast processing of performance data. To enable NPCD, set
13 'RUN' to 'yes' in /etc/default/npcd.
15 In order to enable processing of performance data in Nagios, please change the
16 "process_performance_data" statement in "/etc/nagios3/nagios.cfg" to
17 "process_performance_data=1".
19 To register the NPC event broker module (npcdmod), add the following line
20 (without quotes) to "/etc/nagios3/nagios.cfg":
22 "broker_module=/usr/lib/pnp4nagios/npcdmod.o config_file=/etc/pnp4nagios/npcd.cfg"
24 Finally reload your Nagios server by running "service nagios3 reload". All
25 performance data should be processed now.
27 Using bulk mode for Icinga
28 ---------------------------
30 We recommend to use bulk mode with NPCD and npcdmod. This will facilitate an
31 easy installation and fast processing of performance data. To enable NPCD, set
32 'RUN' to 'yes' in /etc/default/npcd.
34 In order to enable processing of performance data in Icinga, please change the
35 "process_performance_data" statement in "/etc/icinga/icinga.cfg" to
36 "process_performance_data=1".
38 To register the NPC event broker module (npcdmod), copy the file
39 "/usr/share/doc/pnp4nagios-web-config-icinga/examples/npcdmod.cfg" to
40 "/etc/icinga/modules"
42 Finally reload your Icinga server by running "service icinga reload". All
43 performance data should be processed now.
46 Add links for PNP4Nagios to Nagios / Icinga Webfrontend
47 -------------------------------------------------------
49 If you want links to PNP4Nagios for your monitored hosts and services in the
50 Nagios web frontend just add
52 - "action_url  /pnp4nagios/graph?host=$HOSTNAME$"
53   to your hosts or host template(s)
55 - "action_url  /pnp4nagios/graph?host=$HOSTNAME$&srv=$SERVICEDESC$"
56   to your services or service template(s)
58 For more information and different modes of operation, see
59 <http://docs.pnp4nagios.org/pnp-0.6/config>.
61  -- Sven Velt <sven@velt.de>  Wed, 30 Sep 2009 13:55:35 +0000
63 Using Gearman mode
64 ------------------
66 Starting with version 0.6.12, PNP4Nagios may operate as a Gearman worker. This
67 is useful in large, distributed setups using Nagios's mod_gearman. To use
68 the PNP Gearman worker, you'll need a running mod_gearman environment. See
69 <http://labs.consol.de/lang/en/nagios/mod-gearman/> for detailed setup
70 instructions.
72 In addition, the following configuration is required to get you started:
74 - Enable processing of performance data in Nagios: set
75   'process_performance_data=1' in "/etc/nagios3/nagios.cfg" or
76   "/etc/icinga/icinga.cfg" and reload your monitoring system:
77   "service icinga/nagios reload".
79 - Enable the PNP Gearman worker daemon by setting 'RUN' to 'yes' in
80   /etc/default/pnp_gearman_worker. Check the Gearman related options in
81   "/etc/pnp4nagios/process_perfdata.cfg" (GEARMAN_HOST and encryption
82   settings) and start the Gearman worker: /etc/init.d/pnp_gearman_worker start
84 - Enable distribution of performance data in mod_gearman by setting the
85   'perfdata=yes' option.
87 When operating in Gearman mode, process_perfdata.pl requires the
88 Gearman::Worker, MIME::Base64, and Crypt::Rijndael Perl modules. These are
89 available in the libgearman-client-perl, perl, and libcrypt-rijndael-perl
90 Debian packages (see packages suggested by pnp4nagios-bin).
92  -- Sebastian Harl <tokkee@debian.org>  Wed, 27 Apr 2011 09:32:52 +0200