diff options
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r-- | doc/developer-guidelines.sgml | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index ad6f59e..82dbeca 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
@@ -196,12 +196,18 @@ | |||
196 | 196 | ||
197 | </section> | 197 | </section> |
198 | 198 | ||
199 | <section id="thresholdformat"><title>Threshold range format</title> | 199 | <section id="thresholdformat"><title>Threshold and ranges</title> |
200 | <para>Thresholds ranges define the warning and critical levels for plugins to | 200 | <para>A range is defined as a start and end point (inclusive) on a numeric scale (possibly |
201 | alert on. The theory is that the plugin will do some sort of check which returns | 201 | negative or positive infinity). |
202 | </para> | ||
203 | <para>A threshold is a range with an alert level (either warning or critical). Use the | ||
204 | set_thresholds(thresholds *, char *, char *) function to set the thresholds. | ||
205 | </para> | ||
206 | <para>The theory is that the plugin will do some sort of check which returns | ||
202 | back a numerical value, or metric, which is then compared to the warning and | 207 | back a numerical value, or metric, which is then compared to the warning and |
203 | critical thresholds. | 208 | critical thresholds. Use the get_status(double, thresholds *) function to |
204 | This is the generalised format for threshold ranges:</para> | 209 | compare the value against the thresholds.</para> |
210 | <para>This is the generalised format for ranges:</para> | ||
205 | 211 | ||
206 | <literallayout> | 212 | <literallayout> |
207 | [@]start:end | 213 | [@]start:end |
@@ -226,10 +232,8 @@ | |||
226 | </listitem> | 232 | </listitem> |
227 | </orderedlist> | 233 | </orderedlist> |
228 | 234 | ||
229 | <para>Note: Not all plugins are coded to expect ranges in this format. It is | 235 | <para>Note: Not all plugins are coded to expect ranges in this format yet. |
230 | planned for a future release to | 236 | There will be some work in providing multiple metrics.</para> |
231 | provide standard libraries to parse and compare metrics against ranges. There | ||
232 | will also be some work in providing multiple metrics.</para> | ||
233 | </section> | 237 | </section> |
234 | 238 | ||
235 | <section><title>Performance data</title> | 239 | <section><title>Performance data</title> |