Merge pull request #1278 from waja/github1227
[monitoring-plugins.git] / FAQ
blob20b837c6e941d9d50606f513e866b752c671af15
1 Frequently Asked Questions
2 **************************
4 Q: Where can I find documentation for <insert name> plugin?
6 A: All plugins that comply with minimal development guideline for
7    this project include internal documentation.  The documentation
8    can be read executing plugin with the -h or --help option. If 
9    the '-h' option does not work, that is a bug.
12 Q: What version of <insert name> plugin am I running?
14 A: All plugins that comply with minimal development guideline for
15    this project include detailed version information.  When executed
16    with the '-V' option, a version string will be printed:
18    check_radius v1.4.16 (monitoring-plugins 1.4.16)
20    All bug reports and help requests should reference this
21    information.
24 Q: What information do I need to include when asking for help or
25    submitting a bug report?
27 A: At a minimum, the output from 'uname -a' and the version string
28    from '<plugin_name> -V' and, of course, a description of the
29    problem and any solution/patch.
32 Q: I'm using Redhat Linux (or some other RPM-based distribution).
33    Which packages should I install?
35 A: The package monitoring-plugins-<version>.<arch>.rpm contains only
36    those plugins that should work on any POSIX compliant system.  In
37    other words, you should be able to install this package on your
38    system, no matter what else is or in not installed.
40    However, most of us have more complex systems than barebones
41    POSIX.  We tried creating a variety of separate packages so
42    each dependency could be installed cleanly, but many people
43    found that this resulted in too many packages.  So in the end,
44    all the non-POSIX plugins were folded into one RPM 
45    (monitoring-plugins-<version>.<arch>.rpm).  Most people will need to
46    use RPM's '--nodeps' option to install this package.
49 Q: My system uses the .deb package format. What packages should I
50    install?
52 A: We strive for cooperation between all packagers and developers.
53    The answers for .deb are the same as for RPM, after changing the
54    package name suffixes accordingly.
57 Q: I prefer to build my own RPMs. Do I need to install all of the
58    various dependencies?
60 A: Beginning with the 1.2.9-1 release, you may run
62    rpm --define 'custom 1' -ta monitoring-plugins-<release>.tar.gz
64    In prior releases, you must unpack the tarball and build the
65    RPM using monitoring-custom.spec with 'rpm -ba'.
68 Q: I get an error like
70    Warning: Return code of 127 for check of service 'PING' on host 'anyhost' was out of bounds.
72    when I run Nagios. (Often check_ping runs just fine on the
73    command line).
75 A: Commonly, system administrators will make security as tight as
76    possible on the monitoring system. Sometimes this includes OS
77    options or hardening scripts that prevent unprivileged users from
78    running the ping command. Nagios runs with no more privileges
79    than 'nobody' -- check to be sure that the nagios user can
80    actually run check ping.  (This can also happen with other binaries
81    executed by nagios, but ping seems to be far and away the biggest
82    offender.)
85 Q: I have a plugin to offer. What can I do?
87 A: You can make it available on MonitoringExchange (http://monitoringexchange.org)
88    where other people can find it for use.
90    You can also get feedback on improving the plugin via the 
91    devel@monitoring-plugins.org mailing list.