diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/developer-guidelines.sgml | 43 |
1 files changed, 41 insertions, 2 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 6e35615..f5e376a 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
@@ -99,7 +99,7 @@ | |||
99 | <literallayout> | 99 | <literallayout> |
100 | gnu make 3.79 | 100 | gnu make 3.79 |
101 | automake 1.6 | 101 | automake 1.6 |
102 | autoconf 2.52 | 102 | autoconf 2.54 |
103 | gettext 0.11.5 | 103 | gettext 0.11.5 |
104 | </literallayout> | 104 | </literallayout> |
105 | 105 | ||
@@ -235,6 +235,42 @@ | |||
235 | 235 | ||
236 | </section> | 236 | </section> |
237 | 237 | ||
238 | <section id="thresholdformat"><title>Threshold range format</title> | ||
239 | <para>Thresholds ranges define the warning and critical levels for plugins to | ||
240 | alert on. The theory is that the plugin will do some sort of check which returns | ||
241 | back a numerical value, or metric, which is then compared to the warning and | ||
242 | critical thresholds. | ||
243 | This is the generalised format for threshold ranges:</para> | ||
244 | |||
245 | <literallayout> | ||
246 | [@]start:end | ||
247 | </literallayout> | ||
248 | |||
249 | <para>Notes:</para> | ||
250 | <orderedlist> | ||
251 | <listitem><para>start < end</para> | ||
252 | </listitem> | ||
253 | <listitem><para>start and ":" is not required if start=0</para> | ||
254 | </listitem> | ||
255 | <listitem><para>if range is of format "start:" and end is not specified, | ||
256 | assume end is infinity</para> | ||
257 | </listitem> | ||
258 | <listitem><para>to specify negative infinity, use "~"</para> | ||
259 | </listitem> | ||
260 | <listitem><para>alert is raised if metric is outside start and end range | ||
261 | (inclusive of endpoints)</para> | ||
262 | </listitem> | ||
263 | <listitem><para>if range starts with "@", then alert if inside this range | ||
264 | (inclusive of endpoints)</para> | ||
265 | </listitem> | ||
266 | </orderedlist> | ||
267 | |||
268 | <para>Note: Not all plugins are coded to expect ranges in this format. It is | ||
269 | planned for a future release to | ||
270 | provide standard libraries to parse and compare metrics against ranges. There | ||
271 | will also be some work in providing multiple metrics.</para> | ||
272 | </section> | ||
273 | |||
238 | <section><title>Performance data</title> | 274 | <section><title>Performance data</title> |
239 | <para>Performance data is defined by Nagios as "everything after the | of the plugin output" - | 275 | <para>Performance data is defined by Nagios as "everything after the | of the plugin output" - |
240 | please refer to Nagios documentation for information on capturing this data to logfiles. | 276 | please refer to Nagios documentation for information on capturing this data to logfiles. |
@@ -267,9 +303,12 @@ | |||
267 | </listitem> | 303 | </listitem> |
268 | <listitem><para>min and max are not required if UOM=%</para> | 304 | <listitem><para>min and max are not required if UOM=%</para> |
269 | </listitem> | 305 | </listitem> |
270 | <listitem><para>value, crit, warn, max and min in class [-0-9.]. Must all be the | 306 | <listitem><para>value, min and max in class [-0-9.]. Must all be the |
271 | same UOM</para> | 307 | same UOM</para> |
272 | </listitem> | 308 | </listitem> |
309 | <listitem><para>warn and crit are in the range format (see | ||
310 | <xref linkend="thresholdformat">)</para> | ||
311 | </listitem> | ||
273 | <listitem><para>UOM (unit of measurement) is one of:</para> | 312 | <listitem><para>UOM (unit of measurement) is one of:</para> |
274 | <orderedlist> | 313 | <orderedlist> |
275 | <listitem><para>no unit specified - assume a number (int or float) | 314 | <listitem><para>no unit specified - assume a number (int or float) |