diff options
| -rw-r--r-- | doc/developer-guidelines.sgml | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 8c2f2b96..b332c277 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
| @@ -241,6 +241,83 @@ | |||
| 241 | 241 | ||
| 242 | <para>Note: Not all plugins are coded to expect ranges in this format yet. | 242 | <para>Note: Not all plugins are coded to expect ranges in this format yet. |
| 243 | There will be some work in providing multiple metrics.</para> | 243 | There will be some work in providing multiple metrics.</para> |
| 244 | |||
| 245 | <table id="ExampleRanges"><title>Example ranges</title> | ||
| 246 | <tgroup cols="2"> | ||
| 247 | <thead> | ||
| 248 | <row> | ||
| 249 | <entry><para>Range definition</para></entry> | ||
| 250 | <entry><para>Generate an alert if x...</para></entry> | ||
| 251 | </row> | ||
| 252 | </thead> | ||
| 253 | <tbody> | ||
| 254 | <row> | ||
| 255 | <entry>10</entry> | ||
| 256 | <entry>< 0 or > 10, (outside the range of {0 .. 10})</entry> | ||
| 257 | </row> | ||
| 258 | <row> | ||
| 259 | <entry>10:</entry> | ||
| 260 | <entry>< 10, (outside {10 .. ∞})</entry> | ||
| 261 | </row> | ||
| 262 | <row> | ||
| 263 | <entry>~:10</entry> | ||
| 264 | <entry>> 10, (outside the range of {-∞ .. 10})</entry> | ||
| 265 | </row> | ||
| 266 | <row> | ||
| 267 | <entry>10:20</entry> | ||
| 268 | <entry>< 10 or > 20, (outside the range of {10 .. 20})</entry> | ||
| 269 | </row> | ||
| 270 | <row> | ||
| 271 | <entry>@10:20</entry> | ||
| 272 | <entry>≥ 10 and ≤ 20, (inside the range of {10 .. 20})</entry> | ||
| 273 | </row> | ||
| 274 | <row> | ||
| 275 | <entry>10</entry> | ||
| 276 | <entry>< 0 or > 10, (outside the range of {0 .. 10})</entry> | ||
| 277 | </row> | ||
| 278 | </tbody> | ||
| 279 | </tgroup> | ||
| 280 | </table> | ||
| 281 | <table id="CommandLineExamples"><title>Command line examples</title> | ||
| 282 | <tgroup cols="2"> | ||
| 283 | <thead> | ||
| 284 | <row> | ||
| 285 | <entry><para>Command line</para></entry> | ||
| 286 | <entry><para>Meaning</para></entry> | ||
| 287 | </row> | ||
| 288 | </thead> | ||
| 289 | <tbody> | ||
| 290 | <row> | ||
| 291 | <entry>check_stuff -w10 -c20</entry> | ||
| 292 | <entry>Critical if "stuff" is over 20, else warn if over 10 (will be critical if "stuff" is less than 0)</entry> | ||
| 293 | </row> | ||
| 294 | <row> | ||
| 295 | <entry>check_stuff -w~:10 -c~:20</entry> | ||
| 296 | <entry>Same as above. Negative "stuff" is OK</entry> | ||
| 297 | </row> | ||
| 298 | <row> | ||
| 299 | <entry>check_stuff -w10: -c20</entry> | ||
| 300 | <entry>Critical if "stuff" is over 20, else warn if "stuff" is below 10 (will be critical if "stuff" is less than 0)</entry> | ||
| 301 | </row> | ||
| 302 | <row> | ||
| 303 | <entry>check_stuff -c1:</entry> | ||
| 304 | <entry>Critical if "stuff" is less than 1</entry> | ||
| 305 | </row> | ||
| 306 | <row> | ||
| 307 | <entry>check_stuff -w~:0 -c10</entry> | ||
| 308 | <entry>Critical if "stuff" is above 10; Warn if "stuff" is above zero</entry> | ||
| 309 | </row> | ||
| 310 | <row> | ||
| 311 | <entry>check_stuff -c5:6</entry> | ||
| 312 | <entry>The only noncritical range is 5:6</entry> | ||
| 313 | </row> | ||
| 314 | <row> | ||
| 315 | <entry>check_stuff -c10:20</entry> | ||
| 316 | <entry>Critical if "stuff" is 10 to 20</entry> | ||
| 317 | </row> | ||
| 318 | </tbody> | ||
| 319 | </tgroup> | ||
| 320 | </table> | ||
| 244 | </section> | 321 | </section> |
| 245 | 322 | ||
| 246 | <section><title>Performance data</title> | 323 | <section><title>Performance data</title> |