diff options
-rw-r--r-- | doc/developer-guidelines.sgml | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 6b6f7357..599b2a16 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
@@ -83,10 +83,18 @@ | |||
83 | STDOUT and not print to STDERR.</para> | 83 | STDOUT and not print to STDERR.</para> |
84 | 84 | ||
85 | <section><title>Print only one line of text</title> | 85 | <section><title>Print only one line of text</title> |
86 | <para>Nagios will only grab the first line of text from STDOUT | 86 | <para>Starting with version 3, Nagios will process plugins' multiline |
87 | when it notifies contacts about potential problems. If you print | 87 | output, which should be formatted as:</para> |
88 | multiple lines, you're out of luck (though this will be a feature of | 88 | <literallayout> |
89 | Nagios 3). Remember, keep your output short and to the point.</para> | 89 | SERVICE STATUS: First line of output | First part of performance data |
90 | Any number of subsequent lines of output, but note that buffers | ||
91 | may have a limited size | Second part of performance data, which | ||
92 | may have continuation lines, too | ||
93 | </literallayout> | ||
94 | <para>Note, however, that the default configs still do not include | ||
95 | the output's continuation lines into the notifications sent when | ||
96 | Nagios notifies contacts about potential problems. | ||
97 | Thus, keep your output short and to the point.</para> | ||
90 | 98 | ||
91 | <para>Output should be in the format:</para> | 99 | <para>Output should be in the format:</para> |
92 | <literallayout> | 100 | <literallayout> |
@@ -315,10 +323,14 @@ | |||
315 | </section> | 323 | </section> |
316 | 324 | ||
317 | <section><title>Performance data</title> | 325 | <section><title>Performance data</title> |
318 | <para>Performance data is defined by Nagios as "everything after the | of the plugin output" - | 326 | <para>Nagios 3 and newer will concatenate the parts following a "|" in a) the first |
319 | please refer to Nagios documentation for information on capturing this data to logfiles. | 327 | line output by the plugin, and b) in the second to last line, into a string it |
320 | However, it is the responsibility of the plugin writer to ensure the | 328 | passes to whatever performance data processing it has configured. (Note that it |
321 | performance data is in a "Nagios plugins" format. | 329 | currently does not insert additional whitespace between both, so the plugin needs |
330 | to provide some to prevent the last pair of a) and the first of b) getting run | ||
331 | together.) Please refer to the Nagios documentation for information on how to | ||
332 | configure such processing. However, it is the responsibility of the plugin writer | ||
333 | to ensure the performance data is in a "Nagios plugins" format. | ||
322 | This is the expected format:</para> | 334 | This is the expected format:</para> |
323 | 335 | ||
324 | <literallayout> | 336 | <literallayout> |