2 * collectd - src/match_value.c
3 * Copyright (C) 2008 Florian Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian Forster <octo at collectd.org>
28 * This module allows to filter and rewrite value lists based on
29 * Perl-compatible regular expressions.
35 #include "utils_cache.h"
36 #include "filter_chain.h"
45 typedef struct mv_match_s mv_match_t;
54 size_t data_sources_num;
58 * internal helper functions
60 static void mv_free_match (mv_match_t *m) /* {{{ */
67 if (m->data_sources != NULL)
69 for (i = 0; i < m->data_sources_num; ++i)
70 free(m->data_sources[i]);
71 free(m->data_sources);
75 } /* }}} void mv_free_match */
77 static int mv_config_add_satisfy (mv_match_t *m, /* {{{ */
80 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
82 ERROR ("`value' match: `%s' needs exactly one string argument.",
87 if (strcasecmp ("All", ci->values[0].value.string) == 0)
88 m->satisfy = SATISFY_ALL;
89 else if (strcasecmp ("Any", ci->values[0].value.string) == 0)
90 m->satisfy = SATISFY_ANY;
93 ERROR ("`value' match: Passing `%s' to the `%s' option is invalid. "
94 "The argument must either be `All' or `Any'.",
95 ci->values[0].value.string, ci->key);
100 } /* }}} int mv_config_add_satisfy */
102 static int mv_config_add_data_source (mv_match_t *m, /* {{{ */
105 size_t new_data_sources_num;
109 /* Check number of arbuments. */
110 if (ci->values_num < 1)
112 ERROR ("`value' match: `%s' needs at least one argument.",
117 /* Check type of arguments */
118 for (i = 0; i < ci->values_num; i++)
120 if (ci->values[i].type == OCONFIG_TYPE_STRING)
123 ERROR ("`value' match: `%s' accepts only string arguments "
124 "(argument %i is a %s).",
126 (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
127 ? "truth value" : "number");
131 /* Allocate space for the char pointers */
132 new_data_sources_num = m->data_sources_num + ((size_t) ci->values_num);
133 temp = realloc (m->data_sources,
134 new_data_sources_num * sizeof (char *));
137 ERROR ("`value' match: realloc failed.");
140 m->data_sources = temp;
142 /* Copy the strings, allocating memory as needed. */
143 for (i = 0; i < ci->values_num; i++)
147 /* If we get here, there better be memory for us to write to. */
148 assert (m->data_sources_num < new_data_sources_num);
150 j = m->data_sources_num;
151 m->data_sources[j] = sstrdup (ci->values[i].value.string);
152 if (m->data_sources[j] == NULL)
154 ERROR ("`value' match: sstrdup failed.");
157 m->data_sources_num++;
161 } /* }}} int mv_config_add_data_source */
163 static int mv_config_add_gauge (gauge_t *ret_value, /* {{{ */
167 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
169 ERROR ("`value' match: `%s' needs exactly one numeric argument.",
174 *ret_value = ci->values[0].value.number;
177 } /* }}} int mv_config_add_gauge */
179 static int mv_config_add_boolean (int *ret_value, /* {{{ */
183 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
185 ERROR ("`value' match: `%s' needs exactly one boolean argument.",
190 if (ci->values[0].value.boolean)
196 } /* }}} int mv_config_add_boolean */
198 static int mv_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
204 m = calloc (1, sizeof (*m));
207 ERROR ("mv_create: calloc failed.");
214 m->satisfy = SATISFY_ALL;
215 m->data_sources = NULL;
216 m->data_sources_num = 0;
219 for (i = 0; i < ci->children_num; i++)
221 oconfig_item_t *child = ci->children + i;
223 if (strcasecmp ("Min", child->key) == 0)
224 status = mv_config_add_gauge (&m->min, child);
225 else if (strcasecmp ("Max", child->key) == 0)
226 status = mv_config_add_gauge (&m->max, child);
227 else if (strcasecmp ("Invert", child->key) == 0)
228 status = mv_config_add_boolean (&m->invert, child);
229 else if (strcasecmp ("Satisfy", child->key) == 0)
230 status = mv_config_add_satisfy (m, child);
231 else if (strcasecmp ("DataSource", child->key) == 0)
232 status = mv_config_add_data_source (m, child);
235 ERROR ("`value' match: The `%s' configuration option is not "
236 "understood and will be ignored.", child->key);
244 /* Additional sanity-checking */
247 if (isnan (m->min) && isnan (m->max))
249 ERROR ("`value' match: Neither minimum nor maximum are defined. "
250 "This match will be ignored.");
265 } /* }}} int mv_create */
267 static int mv_destroy (void **user_data) /* {{{ */
269 if ((user_data != NULL) && (*user_data != NULL))
270 mv_free_match (*user_data);
272 } /* }}} int mv_destroy */
274 static int mv_match (const data_set_t *ds, const value_list_t *vl, /* {{{ */
275 notification_meta_t __attribute__((unused)) **meta, void **user_data)
282 if ((user_data == NULL) || (*user_data == NULL))
287 values = uc_get_rate (ds, vl);
290 ERROR ("`value' match: Retrieving the current rate from the cache "
295 status = FC_MATCH_NO_MATCH;
297 for (i = 0; i < ds->ds_num; i++)
299 int value_matches = 0;
301 /* Check if this data source is relevant. */
302 if (m->data_sources != NULL)
306 for (j = 0; j < m->data_sources_num; j++)
307 if (strcasecmp (ds->ds[i].name, m->data_sources[j]) == 0)
310 /* No match, ignore this data source. */
311 if (j >= m->data_sources_num)
315 DEBUG ("`value' match: current = %g; min = %g; max = %g; invert = %s;",
316 values[i], m->min, m->max,
317 m->invert ? "true" : "false");
319 if ((!isnan (m->min) && (values[i] < m->min))
320 || (!isnan (m->max) && (values[i] > m->max)))
333 if (value_matches != 0)
335 status = FC_MATCH_MATCHES;
336 if (m->satisfy == SATISFY_ANY)
341 status = FC_MATCH_NO_MATCH;
342 if (m->satisfy == SATISFY_ALL)
345 } /* for (i = 0; i < ds->ds_num; i++) */
349 } /* }}} int mv_match */
351 void module_register (void)
353 match_proc_t mproc = { 0 };
355 mproc.create = mv_create;
356 mproc.destroy = mv_destroy;
357 mproc.match = mv_match;
358 fc_register_match ("value", mproc);
359 } /* module_register */
361 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */