blob: 667abceafe4eeb66f609a41f0254df7d7ba3af8a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
title: Documentation
parent: Home
menu: 4
---
# Documentation
## Basics
The main Monitoring Plugins documentation is split into two parts:
1. **[Manual Pages][man]**
This part provides documentation for each individual plugin.
2. **[FAQ][faq]**
The FAQ section offers information on the Monitoring Plugins package as a
whole.
## Advanced Topics
These documents cover specific topics that go beyond the basics:
* **[Extra-Opts][extra-opts]**
Telling plugins to read options from a configuration file.
* **[Writing Perl Plugins][perl-plugins]**
This is a video that shows how to write your own check using the
[Monitoring::Plugin][module] Perl module.
* **[Monitoring Plugin Development Guidelines][guidelines]**
Reference documentation for plugin developers.
## Proposals
The following ideas are not yet implemented (and might never be):
* **[New Specification Method for Thresholds][new-threshold]**
A different way of specifying thresholds on the command line.
* **[Check Aggregation: check\_many][check-many]**
A plugin wrapper allowing aggregation and serialization of multiple checks.
* **[State Retention Routines][retention-rfc]**
Saving state information between plugin invocations. This is actually
[implemented][retention-api] by now.
[man]: doc/man/index.html "Manual Pages"
[faq]: doc/faq/index.html "Frequently Asked Questions"
[extra-opts]: doc/extra-opts.html "Extra-Opts"
[perl-plugins]: doc/writing-perl-plugins.html "Monitoring::Plugin Presentation"
[module]: http://search.cpan.org/dist/Monitoring-Plugin/ "Monitoring::Plugin"
[guidelines]: doc/guidelines.html "Monitoring Plugin Development Guidelines"
[new-threshold]: doc/new-threshold-syntax.html "Proposal for New Threshold Syntax"
[check-many]: doc/check-many.html "Proposal for Check Aggregation Plugin"
[retention-rfc]: doc/state-retention.html "Proposal for State Retention Routines"
[retention-api]: doc/faq/private-c-api.html#state-information "State Retention API"
<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->
|
