2 * collectd - src/threshold.c
3 * Copyright (C) 2007-2010 Florian Forster
4 * Copyright (C) 2008-2009 Sebastian Harl
5 * Copyright (C) 2009 Andrés J. Díaz
6 * Copyright (C) 2014 Pierre-Yves Ritschard
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; only version 2 of the License is applicable.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Pierre-Yves Ritschard <pyr at spootnik.org>
23 * Florian octo Forster <octo at collectd.org>
24 * Sebastian Harl <sh at tokkee.org>
25 * Andrés J. Díaz <ajdiaz at connectical.com>
31 #include "utils_avltree.h"
32 #include "utils_cache.h"
33 #include "utils_threshold.h"
39 * Threshold management
40 * ====================
41 * The following functions add, delete, etc. configured thresholds to
42 * the underlying AVL trees.
46 * int ut_check_one_data_source
48 * Checks one data source against the given threshold configuration. If the
49 * `DataSource' option is set in the threshold, and the name does NOT match,
50 * `okay' is returned. If the threshold does match, its failure and warning
51 * min and max values are checked and `failure' or `warning' is returned if
55 static int ut_check_one_data_source (const data_set_t *ds,
56 const value_list_t __attribute__((unused)) *vl,
57 const threshold_t *th,
58 const gauge_t *values,
64 int prev_state = STATE_OKAY;
66 /* check if this threshold applies to this data source */
69 ds_name = ds->ds[ds_index].name;
70 if ((th->data_source[0] != 0)
71 && (strcmp (ds_name, th->data_source) != 0))
75 if ((th->flags & UT_FLAG_INVERT) != 0)
81 /* XXX: This is an experimental code, not optimized, not fast, not reliable,
82 * and probably, do not work as you expect. Enjoy! :D */
83 if ( (th->hysteresis > 0) && ((prev_state = uc_get_state(ds,vl)) != STATE_OKAY) )
88 if ( (!isnan (th->failure_min) && ((th->failure_min + th->hysteresis) < values[ds_index])) ||
89 (!isnan (th->failure_max) && ((th->failure_max - th->hysteresis) > values[ds_index])) )
94 if ( (!isnan (th->warning_min) && ((th->warning_min + th->hysteresis) < values[ds_index])) ||
95 (!isnan (th->warning_max) && ((th->warning_max - th->hysteresis) > values[ds_index])) )
101 else { /* no hysteresis */
102 if ((!isnan (th->failure_min) && (th->failure_min > values[ds_index]))
103 || (!isnan (th->failure_max) && (th->failure_max < values[ds_index])))
106 if ((!isnan (th->warning_min) && (th->warning_min > values[ds_index]))
107 || (!isnan (th->warning_max) && (th->warning_max < values[ds_index])))
112 return (STATE_ERROR);
115 return (STATE_WARNING);
118 } /* }}} int ut_check_one_data_source */
121 * int ut_check_one_threshold
123 * Checks all data sources of a value list against the given threshold, using
124 * the ut_check_one_data_source function above. Returns the worst status,
125 * which is `okay' if nothing has failed.
126 * Returns less than zero if the data set doesn't have any data sources.
128 static int ut_check_one_threshold (const data_set_t *ds,
129 const value_list_t *vl,
130 const threshold_t *th,
131 const gauge_t *values,
137 gauge_t values_copy[ds->ds_num];
139 memcpy (values_copy, values, sizeof (values_copy));
141 if ((th->flags & UT_FLAG_PERCENTAGE) != 0)
148 WARNING ("ut_check_one_threshold: The %s type has only one data "
149 "source, but you have configured to check this as a percentage. "
150 "That doesn't make much sense, because the percentage will always "
151 "be 100%%!", ds->type);
154 /* Prepare `sum' and `num'. */
155 for (i = 0; i < ds->ds_num; i++)
156 if (!isnan (values[i]))
162 if ((num == 0) /* All data sources are undefined. */
163 || (sum == 0.0)) /* Sum is zero, cannot calculate percentage. */
165 for (i = 0; i < ds->ds_num; i++)
166 values_copy[i] = NAN;
168 else /* We can actually calculate the percentage. */
170 for (i = 0; i < ds->ds_num; i++)
171 values_copy[i] = 100.0 * values[i] / sum;
173 } /* if (UT_FLAG_PERCENTAGE) */
175 for (i = 0; i < ds->ds_num; i++)
177 status = ut_check_one_data_source (ds, vl, th, values_copy, i);
180 if (statuses[i] < status)
181 statuses[i] = status;
183 } /* for (ds->ds_num) */
186 } /* }}} int ut_check_one_threshold */
189 * int ut_check_threshold
191 * Gets a list of matching thresholds and searches for the worst status by one
192 * of the thresholds. Then reports that status using the ut_report_state
194 * Returns zero on success and if no threshold has been configured. Returns
195 * less than zero on failure.
197 int write_riemann_threshold_check (const data_set_t *ds, const value_list_t *vl,
204 assert (vl->values_len > 0);
205 memset(statuses, 0, vl->values_len * sizeof(*statuses));
207 if (threshold_tree == NULL)
210 /* Is this lock really necessary? So far, thresholds are only inserted at
212 pthread_mutex_lock (&threshold_lock);
213 th = threshold_search (vl);
214 pthread_mutex_unlock (&threshold_lock);
218 DEBUG ("ut_check_threshold: Found matching threshold(s)");
220 values = uc_get_rate (ds, vl);
226 status = ut_check_one_threshold (ds, vl, th, values, statuses);
229 ERROR ("ut_check_threshold: ut_check_one_threshold failed.");
240 } /* }}} int ut_check_threshold */
243 /* vim: set sw=2 ts=8 sts=2 tw=78 et fdm=marker : */