summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-guidelines.sgml10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 951f167b..718bd02a 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -114,7 +114,7 @@
114<section id="PlugOutput"><title>Plugin Output for Nagios</title> 114<section id="PlugOutput"><title>Plugin Output for Nagios</title>
115 115
116 <para>You should always print something to STDOUT that tells if the 116 <para>You should always print something to STDOUT that tells if the
117 service is working or why its failing. Try to keep the output short - 117 service is working or why it is failing. Try to keep the output short -
118 probably less that 80 characters. Remember that you ideally would like 118 probably less that 80 characters. Remember that you ideally would like
119 the entire output to appear in a pager message, which will get chopped 119 the entire output to appear in a pager message, which will get chopped
120 off after a certain length.</para> 120 off after a certain length.</para>
@@ -124,6 +124,14 @@
124 when it notifies contacts about potential problems. If you print 124 when it notifies contacts about potential problems. If you print
125 multiple lines, you're out of luck. Remember, keep it short and 125 multiple lines, you're out of luck. Remember, keep it short and
126 to the point.</para> 126 to the point.</para>
127
128 <para>Output should be in the format:</para>
129 <literallayout>
130 METRIC STATUS: Information text
131 </literallayout>
132 <para>However, note that this is not a requirement of the API, so you cannot depend on this
133 being an accurate reflection of the status of the service - the status should always
134 be determined by the return code.</para>
127 </section> 135 </section>
128 136
129 <section><title>Verbose output</title> 137 <section><title>Verbose output</title>