diff options
Diffstat (limited to 'web/input/doc')
-rw-r--r-- | web/input/doc/check-many.md | 90 | ||||
-rw-r--r-- | web/input/doc/index.md | 12 |
2 files changed, 102 insertions, 0 deletions
diff --git a/web/input/doc/check-many.md b/web/input/doc/check-many.md new file mode 100644 index 0000000..b34869c --- /dev/null +++ b/web/input/doc/check-many.md | |||
@@ -0,0 +1,90 @@ | |||
1 | title: Check Aggregation | ||
2 | parent: Documentation | ||
3 | --- | ||
4 | |||
5 | # Check Aggregation: check\_many | ||
6 | |||
7 | _Thomas Guyot-Sionnest, June 9, 2009_ | ||
8 | |||
9 | ## Overview | ||
10 | |||
11 | This proposal is for a simple plugin wrapper allowing aggregation and | ||
12 | serialization of multiple checks. | ||
13 | |||
14 | ## Problem | ||
15 | |||
16 | There is no easy way to configure a single Nagios service that aggregates | ||
17 | multiple results together. Taking for example a standard `check_nagios` | ||
18 | between servers, how can such checks be extended to cover additional | ||
19 | components? Usually it involves writing a custom shell wrapper around them, | ||
20 | or configuring all the checks separately and using `check_cluster` to | ||
21 | aggregate them. There ought to be a better way … | ||
22 | |||
23 | ## Proposal | ||
24 | |||
25 | Written in C, `check_many` would be a fairly simple and fast solution for this | ||
26 | issue. The idea is a plugin that takes checks commands from `STDIN`; one | ||
27 | command per line. It would run them and aggregate them according to | ||
28 | processing preferences as configured in the plugin arguments. | ||
29 | |||
30 | ## Check Options | ||
31 | |||
32 | The following options can be used to control plugin processing (grouped by | ||
33 | category): | ||
34 | |||
35 | ### Command Parsing | ||
36 | |||
37 | -s, --shell=<always|never|auto> | ||
38 | Specify when a shell should be invoked for executing commands. "always" | ||
39 | invokes the shell for every command, "never" forces commands to be executed | ||
40 | directly, and "auto" (default) invokes the shell only if shell meta | ||
41 | characters are present in the check command. Unless -d (--delimiter) is | ||
42 | specified, any whitespace is used for separating arguments. | ||
43 | |||
44 | -d, --delimiter=CHARACTER | ||
45 | Delimiter to use for separating command arguments when shell is not used. | ||
46 | Implies --shell=never and is mutually exclusive with any other shell option. | ||
47 | Standard backslash escapes are allowed, except "\n". | ||
48 | |||
49 | *Note:* Should we allow strings as delimiters? | ||
50 | |||
51 | ### Processing Option | ||
52 | |||
53 | -P, --process=<all|first-fail|first-ok> | ||
54 | By default, all commands are processed and the worst state is returned | ||
55 | ("all"). "first-fail" stops at the first non-ok check and returns it, while | ||
56 | "first-ok" stops at the first successful check and returns it. The latter | ||
57 | two override --status and --output and return the plugins's instead. | ||
58 | |||
59 | -f, --file=FILE | ||
60 | Read checks from FILE instead of STDIN. | ||
61 | |||
62 | ### Output Options | ||
63 | |||
64 | --output=<normal|oneline|status> | ||
65 | "normal" outputs Nagios v3+ multi-line result, first line being a summary of | ||
66 | the checks performed; "oneline" squeezes everything into a single line; and | ||
67 | "status" returns only a status line. This option has no effect with | ||
68 | --process=first-fail|first-ok. | ||
69 | |||
70 | *Note:* How about allowing *n*th result? | ||
71 | |||
72 | ## Examples | ||
73 | |||
74 | Aggregate multiple checks together: | ||
75 | |||
76 | $ echo '/path/check_http -H www.example.com | ||
77 | /path/check_http -H www.example.com -p 443' | /path/check_many | ||
78 | |||
79 | Get list of checks from a file: | ||
80 | |||
81 | $ /path/check_many <~nagios/multiple_checks.txt | ||
82 | $ /path/check_many -f /home/nagios/multiple_checks.txt | ||
83 | |||
84 | Using a delimiter: | ||
85 | |||
86 | $ echo '/path/check_foo:-H:example.com | ||
87 | /path/check_bar:-H:example.com:-s:$string with special chars;' \ | ||
88 | | /path/check_many -d: | ||
89 | |||
90 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||
diff --git a/web/input/doc/index.md b/web/input/doc/index.md index 9d659fe..763f04c 100644 --- a/web/input/doc/index.md +++ b/web/input/doc/index.md | |||
@@ -30,11 +30,23 @@ These documents cover specific topics that go beyond the basics: | |||
30 | * **[Nagios Plugin Development Guidelines][guidelines]** | 30 | * **[Nagios Plugin Development Guidelines][guidelines]** |
31 | Reference documentation for plugin developers. | 31 | Reference documentation for plugin developers. |
32 | 32 | ||
33 | ## Proposals | ||
34 | |||
35 | The following ideas are not yet implemented (and might never be): | ||
36 | |||
37 | * **[New Specification Method for Thresholds][new-threshold]** | ||
38 | A different way of specifying thresholds on the command line. | ||
39 | |||
40 | * **[Check Aggregation: check\_many][check-many]** | ||
41 | A plugin wrapper allowing aggregation and serialization of multiple checks. | ||
42 | |||
33 | [man]: doc/man/index.html "Manual Pages" | 43 | [man]: doc/man/index.html "Manual Pages" |
34 | [faq]: doc/faq/index.html "Frequently Asked Questions" | 44 | [faq]: doc/faq/index.html "Frequently Asked Questions" |
35 | [opts]: doc/extra-opts.html | 45 | [opts]: doc/extra-opts.html |
36 | [video]: doc/presentation.html "Nagios::Plugin Presentation" | 46 | [video]: doc/presentation.html "Nagios::Plugin Presentation" |
37 | [module]: http://search.cpan.org/dist/Nagios-Plugin/ "Nagios::Plugin" | 47 | [module]: http://search.cpan.org/dist/Nagios-Plugin/ "Nagios::Plugin" |
38 | [guidelines]: doc/guidelines.html | 48 | [guidelines]: doc/guidelines.html |
49 | [new-threshold]: doc/new-threshold-syntax.html | ||
50 | [check-many]: doc/check-many.html | ||
39 | 51 | ||
40 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | 52 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> |