/**
* collectd - src/utils_threshold.c
- * Copyright (C) 2007 Florian octo Forster
+ * Copyright (C) 2007,2008 Florian octo Forster
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
/*
* Private data structures
- */
+ * {{{ */
+#define UT_FLAG_INVERT 0x01
+#define UT_FLAG_PERSIST 0x02
+
typedef struct threshold_s
{
char host[DATA_MAX_NAME_LEN];
char plugin_instance[DATA_MAX_NAME_LEN];
char type[DATA_MAX_NAME_LEN];
char type_instance[DATA_MAX_NAME_LEN];
- gauge_t min;
- gauge_t max;
- int invert;
+ gauge_t warning_min;
+ gauge_t warning_max;
+ gauge_t failure_min;
+ gauge_t failure_max;
+ int flags;
} threshold_t;
+/* }}} */
/*
* Private (static) variables
- */
-static avl_tree_t *threshold_tree = NULL;
+ * {{{ */
+static c_avl_tree_t *threshold_tree = NULL;
static pthread_mutex_t threshold_lock = PTHREAD_MUTEX_INITIALIZER;
+/* }}} */
/*
* Threshold management
* ====================
* The following functions add, delete, search, etc. configured thresholds to
* the underlying AVL trees.
- */
+ * {{{ */
static int ut_threshold_add (const threshold_t *th)
{
char name[6 * DATA_MAX_NAME_LEN];
DEBUG ("ut_threshold_add: Adding entry `%s'", name);
pthread_mutex_lock (&threshold_lock);
- status = avl_insert (threshold_tree, name_copy, th_copy);
+ status = c_avl_insert (threshold_tree, name_copy, th_copy);
pthread_mutex_unlock (&threshold_lock);
if (status != 0)
{
- ERROR ("ut_threshold_add: avl_insert (%s) failed.", name);
+ ERROR ("ut_threshold_add: c_avl_insert (%s) failed.", name);
sfree (name_copy);
sfree (th_copy);
}
} /* int ut_threshold_add */
/*
* End of the threshold management functions
- */
+ * }}} */
/*
* Configuration
* =============
- * The following approximately two hundred functions are used to convert the
- * threshold values..
- */
+ * The following approximately two hundred functions are used to handle the
+ * configuration and fill the threshold list.
+ * {{{ */
static int ut_config_type_instance (threshold_t *th, oconfig_item_t *ci)
{
if ((ci->values_num != 1)
if ((ci->values_num != 1)
|| (ci->values[0].type != OCONFIG_TYPE_NUMBER))
{
- WARNING ("threshold values: The `Max' option needs exactly one "
- "number argument.");
+ WARNING ("threshold values: The `%s' option needs exactly one "
+ "number argument.", ci->key);
return (-1);
}
- th->max = ci->values[0].value.number;
+ if (strcasecmp (ci->key, "WarningMax") == 0)
+ th->warning_max = ci->values[0].value.number;
+ else
+ th->failure_max = ci->values[0].value.number;
return (0);
} /* int ut_config_type_max */
if ((ci->values_num != 1)
|| (ci->values[0].type != OCONFIG_TYPE_NUMBER))
{
- WARNING ("threshold values: The `Min' option needs exactly one "
- "number argument.");
+ WARNING ("threshold values: The `%s' option needs exactly one "
+ "number argument.", ci->key);
return (-1);
}
- th->min = ci->values[0].value.number;
+ if (strcasecmp (ci->key, "WarningMin") == 0)
+ th->warning_min = ci->values[0].value.number;
+ else
+ th->failure_min = ci->values[0].value.number;
return (0);
} /* int ut_config_type_min */
return (-1);
}
- th->invert = (ci->values[0].value.boolean) ? 1 : 0;
+ if (ci->values[0].value.boolean)
+ th->flags |= UT_FLAG_INVERT;
+ else
+ th->flags &= ~UT_FLAG_INVERT;
return (0);
} /* int ut_config_type_invert */
+static int ut_config_type_persist (threshold_t *th, oconfig_item_t *ci)
+{
+ if ((ci->values_num != 1)
+ || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
+ {
+ WARNING ("threshold values: The `Persist' option needs exactly one "
+ "boolean argument.");
+ return (-1);
+ }
+
+ if (ci->values[0].value.boolean)
+ th->flags |= UT_FLAG_PERSIST;
+ else
+ th->flags &= ~UT_FLAG_PERSIST;
+
+ return (0);
+} /* int ut_config_type_persist */
+
static int ut_config_type (const threshold_t *th_orig, oconfig_item_t *ci)
{
int i;
strncpy (th.type, ci->values[0].value.string, sizeof (th.type));
th.type[sizeof (th.type) - 1] = '\0';
+ th.warning_min = NAN;
+ th.warning_max = NAN;
+ th.failure_min = NAN;
+ th.failure_max = NAN;
+
for (i = 0; i < ci->children_num; i++)
{
oconfig_item_t *option = ci->children + i;
if (strcasecmp ("Instance", option->key) == 0)
status = ut_config_type_instance (&th, option);
- else if (strcasecmp ("Max", option->key) == 0)
+ else if ((strcasecmp ("WarningMax", option->key) == 0)
+ || (strcasecmp ("FailureMax", option->key) == 0))
status = ut_config_type_max (&th, option);
- else if (strcasecmp ("Min", option->key) == 0)
+ else if ((strcasecmp ("WarningMin", option->key) == 0)
+ || (strcasecmp ("FailureMin", option->key) == 0))
status = ut_config_type_min (&th, option);
else if (strcasecmp ("Invert", option->key) == 0)
status = ut_config_type_invert (&th, option);
+ else if (strcasecmp ("Persist", option->key) == 0)
+ status = ut_config_type_persist (&th, option);
else
{
WARNING ("threshold values: Option `%s' not allowed inside a `Type' "
threshold_t th;
+ if (ci->values_num != 0)
+ {
+ ERROR ("threshold values: The `Threshold' block may not have any "
+ "arguments.");
+ return (-1);
+ }
+
+ if (threshold_tree == NULL)
+ {
+ threshold_tree = c_avl_create ((void *) strcmp);
+ if (threshold_tree == NULL)
+ {
+ ERROR ("ut_config: c_avl_create failed.");
+ return (-1);
+ }
+ }
+
memset (&th, '\0', sizeof (th));
- th.min = NAN;
- th.max = NAN;
+ th.warning_min = NAN;
+ th.warning_max = NAN;
+ th.failure_min = NAN;
+ th.failure_max = NAN;
for (i = 0; i < ci->children_num; i++)
{
/*
* End of the functions used to configure threshold values.
*/
+/* }}} */
+
+static threshold_t *threshold_get (const char *hostname,
+ const char *plugin, const char *plugin_instance,
+ const char *type, const char *type_instance)
+{
+ char name[6 * DATA_MAX_NAME_LEN];
+ threshold_t *th = NULL;
+
+ format_name (name, sizeof (name),
+ (hostname == NULL) ? "" : hostname,
+ (plugin == NULL) ? "" : plugin, plugin_instance,
+ (type == NULL) ? "" : type, type_instance);
+ name[sizeof (name) - 1] = '\0';
+
+ if (c_avl_get (threshold_tree, name, (void *) &th) == 0)
+ return (th);
+ else
+ return (NULL);
+} /* threshold_t *threshold_get */
+
+static threshold_t *threshold_search (const data_set_t *ds,
+ const value_list_t *vl)
+{
+ threshold_t *th;
+
+ if ((th = threshold_get (vl->host, vl->plugin, vl->plugin_instance,
+ ds->type, vl->type_instance)) != NULL)
+ return (th);
+ else if ((th = threshold_get (vl->host, vl->plugin, vl->plugin_instance,
+ ds->type, NULL)) != NULL)
+ return (th);
+ else if ((th = threshold_get (vl->host, vl->plugin, NULL,
+ ds->type, vl->type_instance)) != NULL)
+ return (th);
+ else if ((th = threshold_get (vl->host, vl->plugin, NULL,
+ ds->type, NULL)) != NULL)
+ return (th);
+ else if ((th = threshold_get (vl->host, "", NULL,
+ ds->type, vl->type_instance)) != NULL)
+ return (th);
+ else if ((th = threshold_get (vl->host, "", NULL,
+ ds->type, NULL)) != NULL)
+ return (th);
+ else if ((th = threshold_get ("", vl->plugin, vl->plugin_instance,
+ ds->type, vl->type_instance)) != NULL)
+ return (th);
+ else if ((th = threshold_get ("", vl->plugin, vl->plugin_instance,
+ ds->type, NULL)) != NULL)
+ return (th);
+ else if ((th = threshold_get ("", vl->plugin, NULL,
+ ds->type, vl->type_instance)) != NULL)
+ return (th);
+ else if ((th = threshold_get ("", vl->plugin, NULL,
+ ds->type, NULL)) != NULL)
+ return (th);
+ else if ((th = threshold_get ("", "", NULL,
+ ds->type, vl->type_instance)) != NULL)
+ return (th);
+ else if ((th = threshold_get ("", "", NULL,
+ ds->type, NULL)) != NULL)
+ return (th);
+
+ return (NULL);
+} /* threshold_t *threshold_search */
+
+int ut_check_threshold (const data_set_t *ds, const value_list_t *vl)
+{
+ notification_t n;
+ threshold_t *th;
+ gauge_t *values;
+ int i;
+
+ int state_orig;
+ int state_new = STATE_OKAY;
+ int ds_index = 0;
+
+ char *buf;
+ size_t bufsize;
+ int status;
+
+ if (threshold_tree == NULL)
+ return (0);
+
+ /* Is this lock really necessary? So far, thresholds are only inserted at
+ * startup. -octo */
+ pthread_mutex_lock (&threshold_lock);
+ th = threshold_search (ds, vl);
+ pthread_mutex_unlock (&threshold_lock);
+ if (th == NULL)
+ return (0);
+
+ DEBUG ("ut_check_threshold: Found matching threshold");
+
+ values = uc_get_rate (ds, vl);
+ if (values == NULL)
+ return (0);
+
+ state_orig = uc_get_state (ds, vl);
+
+ for (i = 0; i < ds->ds_num; i++)
+ {
+ int is_inverted = 0;
+ int is_warning = 0;
+ int is_failure = 0;
+
+ if ((th->flags & UT_FLAG_INVERT) != 0)
+ {
+ is_inverted = 1;
+ is_warning--;
+ is_failure--;
+ }
+ if ((!isnan (th->failure_min) && (th->failure_min > values[i]))
+ || (!isnan (th->failure_max) && (th->failure_max < values[i])))
+ is_failure++;
+ if ((!isnan (th->warning_min) && (th->warning_min > values[i]))
+ || (!isnan (th->warning_max) && (th->warning_max < values[i])))
+ is_warning++;
+
+ if ((is_failure != 0) && (state_new != STATE_ERROR))
+ {
+ state_new = STATE_ERROR;
+ ds_index = i;
+ }
+ else if ((is_warning != 0)
+ && (state_new != STATE_ERROR)
+ && (state_new != STATE_WARNING))
+ {
+ state_new = STATE_WARNING;
+ ds_index = i;
+ }
+ }
+
+ if (state_new != state_orig)
+ uc_set_state (ds, vl, state_new);
+
+ /* Return here if we're not going to send a notification */
+ if ((state_new == state_orig)
+ && ((state_new == STATE_OKAY)
+ || ((th->flags & UT_FLAG_PERSIST) == 0)))
+ {
+ sfree (values);
+ return (0);
+ }
+
+ NOTIFICATION_INIT_VL (&n, vl, ds);
+ {
+ /* Copy the associative members */
+ if (state_new == STATE_OKAY)
+ n.severity = NOTIF_OKAY;
+ else if (state_new == STATE_WARNING)
+ n.severity = NOTIF_WARNING;
+ else
+ n.severity = NOTIF_FAILURE;
+
+ n.time = vl->time;
+
+ buf = n.message;
+ bufsize = sizeof (n.message);
+
+ status = snprintf (buf, bufsize, "Host %s, plugin %s",
+ vl->host, vl->plugin);
+ buf += status;
+ bufsize -= status;
+
+ if (vl->plugin_instance[0] != '\0')
+ {
+ status = snprintf (buf, bufsize, " (instance %s)",
+ vl->plugin_instance);
+ buf += status;
+ bufsize -= status;
+ }
+
+ status = snprintf (buf, bufsize, " type %s", ds->type);
+ buf += status;
+ bufsize -= status;
+
+ if (vl->type_instance[0] != '\0')
+ {
+ status = snprintf (buf, bufsize, " (instance %s)",
+ vl->type_instance);
+ buf += status;
+ bufsize -= status;
+ }
+ }
+
+ /* Send a okay notification */
+ if (state_new == STATE_OKAY)
+ {
+ status = snprintf (buf, bufsize, ": All data sources are within range again.");
+ buf += status;
+ bufsize -= status;
+ }
+ else
+ {
+ double min;
+ double max;
+
+ min = (state_new == STATE_ERROR) ? th->failure_min : th->warning_min;
+ max = (state_new == STATE_ERROR) ? th->failure_max : th->warning_max;
+
+ if (th->flags & UT_FLAG_INVERT)
+ {
+ if (!isnan (min) && !isnan (max))
+ {
+ status = snprintf (buf, bufsize, ": Data source \"%s\" is currently "
+ "%f. That is within the %s region of %f and %f.",
+ ds->ds[ds_index].name, values[ds_index],
+ (state_new == STATE_ERROR) ? "failure" : "warning",
+ min, min);
+ }
+ else
+ {
+ status = snprintf (buf, bufsize, ": Data source \"%s\" is currently "
+ "%f. That is %s the %s threshold of %f.",
+ ds->ds[ds_index].name, values[ds_index],
+ isnan (min) ? "below" : "above",
+ (state_new == STATE_ERROR) ? "failure" : "warning",
+ isnan (min) ? max : min);
+ }
+ }
+ else /* is not inverted */
+ {
+ status = snprintf (buf, bufsize, ": Data source \"%s\" is currently "
+ "%f. That is %s the %s threshold of %f.",
+ ds->ds[ds_index].name, values[ds_index],
+ (values[ds_index] < min) ? "below" : "above",
+ (state_new == STATE_ERROR) ? "failure" : "warning",
+ (values[ds_index] < min) ? min : max);
+ }
+ buf += status;
+ bufsize -= status;
+ }
+
+ plugin_dispatch_notification (&n);
+
+ sfree (values);
+
+ return (0);
+} /* int ut_check_threshold */
+
+int ut_check_interesting (const char *name)
+{
+ char *name_copy = NULL;
+ char *host = NULL;
+ char *plugin = NULL;
+ char *plugin_instance = NULL;
+ char *type = NULL;
+ char *type_instance = NULL;
+ int status;
+ data_set_t ds;
+ value_list_t vl;
+ threshold_t *th;
+
+ /* If there is no tree nothing is interesting. */
+ if (threshold_tree == NULL)
+ return (0);
+
+ name_copy = strdup (name);
+ if (name_copy == NULL)
+ {
+ ERROR ("ut_check_interesting: strdup failed.");
+ return (-1);
+ }
+
+ status = parse_identifier (name_copy, &host,
+ &plugin, &plugin_instance, &type, &type_instance);
+ if (status != 0)
+ {
+ ERROR ("ut_check_interesting: parse_identifier failed.");
+ sfree (name_copy);
+ return (-1);
+ }
+
+ memset (&ds, '\0', sizeof (ds));
+ memset (&vl, '\0', sizeof (vl));
+
+ strncpy (vl.host, host, sizeof (vl.host));
+ vl.host[sizeof (vl.host) - 1] = '\0';
+ strncpy (vl.plugin, plugin, sizeof (vl.plugin));
+ vl.plugin[sizeof (vl.plugin) - 1] = '\0';
+ if (plugin_instance != NULL)
+ {
+ strncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
+ vl.plugin_instance[sizeof (vl.plugin_instance) - 1] = '\0';
+ }
+ strncpy (ds.type, type, sizeof (ds.type));
+ ds.type[sizeof (ds.type) - 1] = '\0';
+ if (type_instance != NULL)
+ {
+ strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
+ vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
+ }
+
+ sfree (name_copy);
+ host = plugin = plugin_instance = type = type_instance = NULL;
+
+ th = threshold_search (&ds, &vl);
+ if (th == NULL)
+ return (0);
+ if ((th->flags & UT_FLAG_PERSIST) == 0)
+ return (1);
+ return (2);
+} /* int ut_check_interesting */
-/* vim: set sw=2 ts=8 sts=2 tw=78 : */
+/* vim: set sw=2 ts=8 sts=2 tw=78 fdm=marker : */