diff options
Diffstat (limited to 'doc/developer-guidelines.sgml')
| -rw-r--r-- | doc/developer-guidelines.sgml | 52 |
1 files changed, 51 insertions, 1 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 6500297f..9e1da501 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
| @@ -189,7 +189,7 @@ | |||
| 189 | occurred and error code is 138 or 255 or some such number. These | 189 | occurred and error code is 138 or 255 or some such number. These |
| 190 | are usually caused by plugins using system commands and having not | 190 | are usually caused by plugins using system commands and having not |
| 191 | enough checks to catch unexpected output. Developers should include a | 191 | enough checks to catch unexpected output. Developers should include a |
| 192 | default catch-all for system command output that returns an UNKOWN | 192 | default catch-all for system command output that returns an UNKNOWN |
| 193 | return code.</para> | 193 | return code.</para> |
| 194 | 194 | ||
| 195 | <table id="ReturnCodes"><title>Plugin Return Codes</title> | 195 | <table id="ReturnCodes"><title>Plugin Return Codes</title> |
| @@ -235,7 +235,57 @@ | |||
| 235 | 235 | ||
| 236 | </section> | 236 | </section> |
| 237 | 237 | ||
| 238 | <section><title>Performance data</title> | ||
| 239 | <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. | ||
| 241 | However, it is the responsibility of the plugin writer to ensure the | ||
| 242 | performance data is in a "Nagios plugins" format. | ||
| 243 | This is the expected format:</para> | ||
| 238 | 244 | ||
| 245 | <literallayout> | ||
| 246 | 'label'=value[UOM];[crit];[warn][;[max];[min]] | ||
| 247 | </literallayout> | ||
| 248 | |||
| 249 | <para>Notes:</para> | ||
| 250 | <orderedlist> | ||
| 251 | <listitem><para>space separated list of label/value pairs</para> | ||
| 252 | </listitem> | ||
| 253 | <listitem><para>label can contain any characters</para> | ||
| 254 | </listitem> | ||
| 255 | <listitem><para>the single quotes for the label are optional. Required if | ||
| 256 | spaces, = or ' are in the label</para> | ||
| 257 | </listitem> | ||
| 258 | <listitem><para>label length is arbitrary, but ideally the first 19 characters | ||
| 259 | are unique (due to a limitation in RRD). Be aware of a limitation in the | ||
| 260 | amount of data that NRPE returns to Nagios</para> | ||
| 261 | </listitem> | ||
| 262 | <listitem><para>to specify a quote character, use two single quotes</para> | ||
| 263 | </listitem> | ||
| 264 | <listitem><para>crit or warn may be null (if the threshold is not defined)</para> | ||
| 265 | </listitem> | ||
| 266 | <listitem><para>max and min are optional. Holds maximum values for the | ||
| 267 | particular UOM (not required if UOM=%)</para> | ||
| 268 | </listitem> | ||
| 269 | <listitem><para>value, crit, warn, max and min in class [-0-9.]. Must all be the | ||
| 270 | same UOM</para> | ||
| 271 | </listitem> | ||
| 272 | <listitem><para>UOM (unit of measurement) is one of:</para> | ||
| 273 | <orderedlist> | ||
| 274 | <listitem><para>no unit specified - assume a number (int or float) | ||
| 275 | of things (eg, users, processes, load averages)</para> | ||
| 276 | </listitem> | ||
| 277 | <listitem><para>s - seconds (also us, ms)</para></listitem> | ||
| 278 | <listitem><para>% - percentage</para></listitem> | ||
| 279 | <listitem><para>B - bytes (also KB, MB, TB)</para></listitem> | ||
| 280 | <listitem><para>c - a continous counter (such as bytes | ||
| 281 | transmitted on an interface)</para></listitem> | ||
| 282 | </orderedlist> | ||
| 283 | </listitem> | ||
| 284 | </orderedlist> | ||
| 285 | |||
| 286 | <para>It is up to third party programs to convert the Nagios plugins | ||
| 287 | performance data into graphs.</para> | ||
| 288 | </section> | ||
| 239 | </section> | 289 | </section> |
| 240 | 290 | ||
| 241 | <section id="SysCmdAuxFiles"><title>System Commands and Auxiliary Files</title> | 291 | <section id="SysCmdAuxFiles"><title>System Commands and Auxiliary Files</title> |