From e0688a69114c95efaa0fbee8f8e91f6dcc21a1ee Mon Sep 17 00:00:00 2001 From: Ton Voon Date: Mon, 30 Jan 2006 22:24:31 +0000 Subject: Clearly defined thresholds & ranges in docs. Added get_status routine. Added set_thresholds routine. Tests enhanced to check new routines git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@1304 f882894a-f735-0410-b71e-b25c423dba1c 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 @@ -
Threshold range format - Thresholds ranges define the warning and critical levels for plugins to - alert on. The theory is that the plugin will do some sort of check which returns +
Threshold and ranges + A range is defined as a start and end point (inclusive) on a numeric scale (possibly + negative or positive infinity). + + A threshold is a range with an alert level (either warning or critical). Use the + set_thresholds(thresholds *, char *, char *) function to set the thresholds. + + The theory is that the plugin will do some sort of check which returns back a numerical value, or metric, which is then compared to the warning and - critical thresholds. - This is the generalised format for threshold ranges: + critical thresholds. Use the get_status(double, thresholds *) function to + compare the value against the thresholds. + This is the generalised format for ranges: [@]start:end @@ -226,10 +232,8 @@ - Note: Not all plugins are coded to expect ranges in this format. It is - planned for a future release to - provide standard libraries to parse and compare metrics against ranges. There - will also be some work in providing multiple metrics. + Note: Not all plugins are coded to expect ranges in this format yet. + There will be some work in providing multiple metrics.
Performance data diff --git a/plugins/tests/test_utils.c b/plugins/tests/test_utils.c index 1fda367..5604bac 100644 --- a/plugins/tests/test_utils.c +++ b/plugins/tests/test_utils.c @@ -29,77 +29,112 @@ const char *progname = "utils"; int main (int argc, char **argv) { - threshold *range; - double temp; + range *range; + double temp; + thresholds *thresholds; + int rc; - plan_tests(40); + plan_tests(66); - range = parse_threshold("6"); - ok( range != NULL, "'6' is valid threshold"); + range = parse_range_string("6"); + ok( range != NULL, "'6' is valid range"); ok( range->start == 0, "Start correct"); ok( range->start_infinity == FALSE, "Not using negative infinity"); ok( range->end == 6, "End correct"); ok( range->end_infinity == FALSE, "Not using infinity"); free(range); - range = parse_threshold("-7:23"); - ok( range != NULL, "'-7:23' is valid threshold"); + range = parse_range_string("-7:23"); + ok( range != NULL, "'-7:23' is valid range"); ok( range->start == -7, "Start correct"); ok( range->start_infinity == FALSE, "Not using negative infinity"); ok( range->end == 23, "End correct"); ok( range->end_infinity == FALSE, "Not using infinity"); free(range); - range = parse_threshold(":5.75"); - ok( range != NULL, "':5.75' is valid threshold"); + range = parse_range_string(":5.75"); + ok( range != NULL, "':5.75' is valid range"); ok( range->start == 0, "Start correct"); ok( range->start_infinity == FALSE, "Not using negative infinity"); ok( range->end == 5.75, "End correct"); ok( range->end_infinity == FALSE, "Not using infinity"); free(range); - range = parse_threshold("~:-95.99"); - ok( range != NULL, "~:-95.99' is valid threshold"); + range = parse_range_string("~:-95.99"); + ok( range != NULL, "~:-95.99' is valid range"); ok( range->start_infinity == TRUE, "Using negative infinity"); ok( range->end == -95.99, "End correct (with rounding errors)"); ok( range->end_infinity == FALSE, "Not using infinity"); free(range); - range = parse_threshold("12345678901234567890:"); + range = parse_range_string("12345678901234567890:"); temp = atof("12345678901234567890"); /* Can't just use this because number too large */ - ok( range != NULL, "'12345678901234567890:' is valid threshold"); + ok( range != NULL, "'12345678901234567890:' is valid range"); ok( range->start == temp, "Start correct"); ok( range->start_infinity == FALSE, "Not using negative infinity"); ok( range->end_infinity == TRUE, "Using infinity"); + /* Cannot do a "-1" on temp, as it appears to be same value */ + ok( check_range(temp/1.1, range) == TRUE, "12345678901234567890/1.1 - alert"); + ok( check_range(temp, range) == FALSE, "12345678901234567890 - no alert"); + ok( check_range(temp*2, range) == FALSE, "12345678901234567890*2 - no alert"); free(range); - range = parse_threshold("~:0"); - ok( range != NULL, "'~:0' is valid threshold"); + range = parse_range_string("~:0"); + ok( range != NULL, "'~:0' is valid range"); ok( range->start_infinity == TRUE, "Using negative infinity"); ok( range->end == 0, "End correct"); ok( range->end_infinity == FALSE, "Not using infinity"); ok( range->alert_on == OUTSIDE, "Will alert on outside of this range"); + ok( check_range(0.5, range) == TRUE, "0.5 - alert"); + ok( check_range(-10, range) == FALSE, "-10 - no alert"); + ok( check_range(0, range) == FALSE, "0 - no alert"); free(range); - range = parse_threshold("@0:657.8210567"); - ok( range != 0, "@0:657.8210567' is a valid threshold"); + range = parse_range_string("@0:657.8210567"); + ok( range != 0, "@0:657.8210567' is a valid range"); ok( range->start == 0, "Start correct"); ok( range->start_infinity == FALSE, "Not using negative infinity"); ok( range->end == 657.8210567, "End correct"); ok( range->end_infinity == FALSE, "Not using infinity"); ok( range->alert_on == INSIDE, "Will alert on inside of this range" ); + ok( check_range(32.88, range) == TRUE, "32.88 - alert"); + ok( check_range(-2, range) == FALSE, "-2 - no alert"); + ok( check_range(657.8210567, range) == TRUE, "657.8210567 - alert"); + ok( check_range(0, range) == TRUE, "0 - alert"); free(range); - range = parse_threshold("1:1"); - ok( range != NULL, "'1:1' is a valid threshold"); + range = parse_range_string("1:1"); + ok( range != NULL, "'1:1' is a valid range"); ok( range->start == 1, "Start correct"); ok( range->start_infinity == FALSE, "Not using negative infinity"); ok( range->end == 1, "End correct"); ok( range->end_infinity == FALSE, "Not using infinity"); + ok( check_range(0.5, range) == TRUE, "0.5 - alert"); + ok( check_range(1, range) == FALSE, "1 - no alert"); + ok( check_range(5.2, range) == TRUE, "5.2 - alert"); free(range); - range = parse_threshold("2:1"); - ok( range == NULL, "''2:1' rejected"); + range = parse_range_string("2:1"); + ok( range == NULL, "'2:1' rejected"); + + rc = _set_thresholds(&thresholds, NULL, "80"); + ok( rc == 0, "Thresholds (NULL, '80') set"); + ok( thresholds->warning == NULL, "Warning not set"); + ok( thresholds->critical->end == 80, "Critical set correctly"); + + rc = _set_thresholds(&thresholds, "5:33", NULL); + ok( rc == 0, "Thresholds ('5:33', NULL) set"); + ok( thresholds->warning->start == 5, "Warning start set"); + ok( thresholds->warning->end == 33, "Warning end set"); + ok( thresholds->critical == NULL, "Critical not set"); + + rc = _set_thresholds(&thresholds, "30", "60"); + ok( rc == 0, "Thresholds ('30', '60') set"); + ok( thresholds->warning->end == 30, "Warning set correctly"); + ok( thresholds->critical->end == 60, "Critical set correctly"); + ok( get_status(15.3, thresholds) == STATE_OK, "15.3 - ok"); + ok( get_status(30.0001, thresholds) == STATE_WARNING, "30.0001 - warning"); + ok( get_status(69, thresholds) == STATE_CRITICAL, "69 - critical"); return exit_status(); } diff --git a/plugins/utils.c b/plugins/utils.c index dbb2520..685a638 100644 --- a/plugins/utils.c +++ b/plugins/utils.c @@ -265,44 +265,44 @@ is_option (char *str) return FALSE; } -void set_threshold_start (threshold *this, double value) { +void set_range_start (range *this, double value) { this->start = value; this->start_infinity = FALSE; } -void set_threshold_end (threshold *this, double value) { +void set_range_end (range *this, double value) { this->end = value; this->end_infinity = FALSE; } -threshold -*parse_threshold (char *str) { - threshold *temp_threshold; +range +*parse_range_string (char *str) { + range *temp_range; double start; double end; char *end_str; - temp_threshold = (threshold *) malloc(sizeof(threshold)); + temp_range = (range *) malloc(sizeof(range)); /* Set defaults */ - temp_threshold->start = 0; - temp_threshold->start_infinity = FALSE; - temp_threshold->end = 0; - temp_threshold->end_infinity = TRUE; - temp_threshold->alert_on = OUTSIDE; + temp_range->start = 0; + temp_range->start_infinity = FALSE; + temp_range->end = 0; + temp_range->end_infinity = TRUE; + temp_range->alert_on = OUTSIDE; if (str[0] == '@') { - temp_threshold->alert_on = INSIDE; + temp_range->alert_on = INSIDE; str++; } end_str = index(str, ':'); if (end_str != NULL) { if (str[0] == '~') { - temp_threshold->start_infinity = TRUE; + temp_range->start_infinity = TRUE; } else { start = strtod(str, NULL); /* Will stop at the ':' */ - set_threshold_start(temp_threshold, start); + set_range_start(temp_range, start); } end_str++; /* Move past the ':' */ } else { @@ -310,18 +310,111 @@ threshold } end = strtod(end_str, NULL); if (strcmp(end_str, "") != 0) { - set_threshold_end(temp_threshold, end); + set_range_end(temp_range, end); } - if (temp_threshold->start_infinity == TRUE || - temp_threshold->end_infinity == TRUE || - temp_threshold->start <= temp_threshold->end) { - return temp_threshold; + if (temp_range->start_infinity == TRUE || + temp_range->end_infinity == TRUE || + temp_range->start <= temp_range->end) { + return temp_range; } - free(temp_threshold); + free(temp_range); return NULL; } +/* returns 0 if okay, otherwise 1 */ +int +_set_thresholds(thresholds **my_thresholds, char *warn_string, char *critical_string) +{ + thresholds *temp_thresholds = NULL; + + temp_thresholds = malloc(sizeof(temp_thresholds)); + + temp_thresholds->warning = NULL; + temp_thresholds->critical = NULL; + + if (warn_string != NULL) { + if ((temp_thresholds->warning = parse_range_string(warn_string)) == NULL) { + return 1; + } + } + if (critical_string != NULL) { + if ((temp_thresholds->critical = parse_range_string(critical_string)) == NULL) { + return 1; + } + } + + if (*my_thresholds != 0) { + /* printf("Freeing here: %d\n", *my_thresholds); */ + free(*my_thresholds); + } + *my_thresholds = temp_thresholds; + + return 0; +} + +void +set_thresholds(thresholds **my_thresholds, char *warn_string, char *critical_string) +{ + if (_set_thresholds(my_thresholds, warn_string, critical_string) == 0) { + return; + } else { + usage("Range format incorrect"); + } +} + +/* Returns TRUE if alert should be raised based on the range */ +int +check_range(double value, range *my_range) +{ + int false = FALSE; + int true = TRUE; + + if (my_range->alert_on == INSIDE) { + false = TRUE; + true = FALSE; + } + + if (my_range->end_infinity == FALSE && my_range->start_infinity == FALSE) { + if ((my_range->start <= value) && (value <= my_range->end)) { + return false; + } else { + return true; + } + } else if (my_range->start_infinity == FALSE && my_range->end_infinity == TRUE) { + if (my_range->start <= value) { + return false; + } else { + return true; + } + } else if (my_range->start_infinity == TRUE && my_range->end_infinity == FALSE) { + if (value <= my_range->end) { + return false; + } else { + return true; + } + } else { + return false; + } +} + +/* Returns status */ +int +get_status(double value, thresholds *my_thresholds) +{ + if (my_thresholds->critical != NULL) { + if (check_range(value, my_thresholds->critical) == TRUE) { + return STATE_CRITICAL; + } + } + if (my_thresholds->warning != NULL) { + if (check_range(value, my_thresholds->warning) == TRUE) { + return STATE_WARNING; + } + } + return STATE_OK; +} + #ifdef NEED_GETTIMEOFDAY int gettimeofday (struct timeval *tv, struct timezone *tz) diff --git a/plugins/utils.h b/plugins/utils.h index f47d053..ffcb39d 100644 --- a/plugins/utils.h +++ b/plugins/utils.h @@ -61,15 +61,24 @@ struct timeval { #define OUTSIDE 0 #define INSIDE 1 -typedef struct threshold_struct { +typedef struct range_struct { double start; int start_infinity; /* FALSE (default) or TRUE */ double end; int end_infinity; int alert_on; /* OUTSIDE (default) or INSIDE */ - } threshold; - -threshold *parse_threshold (char *); + } range; + +typedef struct thresholds_struct { + range *warning; + range *critical; + } thresholds; + +range *parse_range_string (char *); +int _set_thresholds(thresholds **, char *, char *); +void set_thresholds(thresholds **, char *, char *); +int check_range(double, range *); +int get_status(double, thresholds *); #ifndef HAVE_GETTIMEOFDAY int gettimeofday(struct timeval *, struct timezone *); -- cgit v0.10-9-g596f