src/write_riemann_threshold.c

   1 /**
   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
   7  *
   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.
  11  *
  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.
  16  *
  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
  20  *
  21  * Author:
  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>
  26  **/
  27
  28 #include "collectd.h"
  29
  30 #include "common.h"
  31 #include "plugin.h"
  32 #include "utils_avltree.h"
  33 #include "utils_cache.h"
  34 #include "utils_threshold.h"
  35 #include "write_riemann_threshold.h"
  36
  37 #include <ltdl.h>
  38
  39 /*
  40  * Threshold management
  41  * ====================
  42  * The following functions add, delete, etc. configured thresholds to
  43  * the underlying AVL trees.
  44  */
  45
  46 /*
  47  * int ut_check_one_data_source
  48  *
  49  * Checks one data source against the given threshold configuration. If the
  50  * `DataSource' option is set in the threshold, and the name does NOT match,
  51  * `okay' is returned. If the threshold does match, its failure and warning
  52  * min and max values are checked and `failure' or `warning' is returned if
  53  * appropriate.
  54  * Does not fail.
  55  */
  56 static int ut_check_one_data_source(
  57     const data_set_t *ds, const value_list_t __attribute__((unused)) * vl,
  58     const threshold_t *th, const gauge_t *values, int ds_index) { /* {{{ */
  59   const char *ds_name;
  60   int is_warning = 0;
  61   int is_failure = 0;
  62   int prev_state = STATE_OKAY;
  63
  64   /* check if this threshold applies to this data source */
  65   if (ds != NULL) {
  66     ds_name = ds->ds[ds_index].name;
  67     if ((th->data_source[0] != 0) && (strcmp(ds_name, th->data_source) != 0))
  68       return (STATE_OKAY);
  69   }
  70
  71   if ((th->flags & UT_FLAG_INVERT) != 0) {
  72     is_warning--;
  73     is_failure--;
  74   }
  75
  76   /* XXX: This is an experimental code, not optimized, not fast, not reliable,
  77    * and probably, do not work as you expect. Enjoy! :D */
  78   if ((th->hysteresis > 0) &&
  79       ((prev_state = uc_get_state(ds, vl)) != STATE_OKAY)) {
  80     switch (prev_state) {
  81     case STATE_ERROR:
  82       if ((!isnan(th->failure_min) &&
  83            ((th->failure_min + th->hysteresis) < values[ds_index])) ||
  84           (!isnan(th->failure_max) &&
  85            ((th->failure_max - th->hysteresis) > values[ds_index])))
  86         return (STATE_OKAY);
  87       else
  88         is_failure++;
  89     case STATE_WARNING:
  90       if ((!isnan(th->warning_min) &&
  91            ((th->warning_min + th->hysteresis) < values[ds_index])) ||
  92           (!isnan(th->warning_max) &&
  93            ((th->warning_max - th->hysteresis) > values[ds_index])))
  94         return (STATE_OKAY);
  95       else
  96         is_warning++;
  97     }
  98   } else { /* no hysteresis */
  99     if ((!isnan(th->failure_min) && (th->failure_min > values[ds_index])) ||
 100         (!isnan(th->failure_max) && (th->failure_max < values[ds_index])))
 101       is_failure++;
 102
 103     if ((!isnan(th->warning_min) && (th->warning_min > values[ds_index])) ||
 104         (!isnan(th->warning_max) && (th->warning_max < values[ds_index])))
 105       is_warning++;
 106   }
 107
 108   if (is_failure != 0)
 109     return (STATE_ERROR);
 110
 111   if (is_warning != 0)
 112     return (STATE_WARNING);
 113
 114   return (STATE_OKAY);
 115 } /* }}} int ut_check_one_data_source */
 116
 117 /*
 118  * int ut_check_one_threshold
 119  *
 120  * Checks all data sources of a value list against the given threshold, using
 121  * the ut_check_one_data_source function above. Returns the worst status,
 122  * which is `okay' if nothing has failed.
 123  * Returns less than zero if the data set doesn't have any data sources.
 124  */
 125 static int ut_check_one_threshold(const data_set_t *ds, const value_list_t *vl,
 126                                   const threshold_t *th, const gauge_t *values,
 127                                   int *statuses) { /* {{{ */
 128   int ret = -1;
 129   int status;
 130   gauge_t values_copy[ds->ds_num];
 131
 132   memcpy(values_copy, values, sizeof(values_copy));
 133
 134   if ((th->flags & UT_FLAG_PERCENTAGE) != 0) {
 135     int num = 0;
 136     gauge_t sum = 0.0;
 137
 138     if (ds->ds_num == 1) {
 139       WARNING(
 140           "ut_check_one_threshold: The %s type has only one data "
 141           "source, but you have configured to check this as a percentage. "
 142           "That doesn't make much sense, because the percentage will always "
 143           "be 100%%!",
 144           ds->type);
 145     }
 146
 147     /* Prepare `sum' and `num'. */
 148     for (size_t i = 0; i < ds->ds_num; i++)
 149       if (!isnan(values[i])) {
 150         num++;
 151         sum += values[i];
 152       }
 153
 154     if ((num == 0)       /* All data sources are undefined. */
 155         || (sum == 0.0)) /* Sum is zero, cannot calculate percentage. */
 156     {
 157       for (size_t i = 0; i < ds->ds_num; i++)
 158         values_copy[i] = NAN;
 159     } else /* We can actually calculate the percentage. */
 160     {
 161       for (size_t i = 0; i < ds->ds_num; i++)
 162         values_copy[i] = 100.0 * values[i] / sum;
 163     }
 164   } /* if (UT_FLAG_PERCENTAGE) */
 165
 166   for (size_t i = 0; i < ds->ds_num; i++) {
 167     status = ut_check_one_data_source(ds, vl, th, values_copy, i);
 168     if (status != -1) {
 169       ret = 0;
 170       if (statuses[i] < status)
 171         statuses[i] = status;
 172     }
 173   } /* for (ds->ds_num) */
 174
 175   return (ret);
 176 } /* }}} int ut_check_one_threshold */
 177
 178 /*
 179  * int ut_check_threshold
 180  *
 181  * Gets a list of matching thresholds and searches for the worst status by one
 182  * of the thresholds. Then reports that status using the ut_report_state
 183  * function above.
 184  * Returns zero on success and if no threshold has been configured. Returns
 185  * less than zero on failure.
 186  */
 187 int write_riemann_threshold_check(const data_set_t *ds, const value_list_t *vl,
 188                                   int *statuses) { /* {{{ */
 189   threshold_t *th;
 190   gauge_t *values;
 191   int status;
 192
 193   assert(vl->values_len > 0);
 194   memset(statuses, 0, vl->values_len * sizeof(*statuses));
 195
 196   if (threshold_tree == NULL)
 197     return 0;
 198
 199   /* Is this lock really necessary? So far, thresholds are only inserted at
 200    * startup. -octo */
 201   pthread_mutex_lock(&threshold_lock);
 202   th = threshold_search(vl);
 203   pthread_mutex_unlock(&threshold_lock);
 204   if (th == NULL)
 205     return (0);
 206
 207   DEBUG("ut_check_threshold: Found matching threshold(s)");
 208
 209   values = uc_get_rate(ds, vl);
 210   if (values == NULL)
 211     return (0);
 212
 213   while (th != NULL) {
 214     status = ut_check_one_threshold(ds, vl, th, values, statuses);
 215     if (status < 0) {
 216       ERROR("ut_check_threshold: ut_check_one_threshold failed.");
 217       sfree(values);
 218       return (-1);
 219     }
 220
 221     th = th->next;
 222   } /* while (th) */
 223
 224   sfree(values);
 225
 226   return (0);
 227 } /* }}} int ut_check_threshold */