2 * collectd - src/aggregation.c
3 * Copyright (C) 2012 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>
30 #include "configfile.h"
31 #include "meta_data.h"
32 #include "utils_cache.h" /* for uc_get_rate() */
33 #include "utils_vl_lookup.h"
37 struct aggregation_s /* {{{ */
48 typedef struct aggregation_s aggregation_t;
50 struct agg_instance_s;
51 typedef struct agg_instance_s agg_instance_t;
52 struct agg_instance_s /* {{{ */
66 rate_to_value_state_t *state_num;
67 rate_to_value_state_t *state_sum;
68 rate_to_value_state_t *state_average;
69 rate_to_value_state_t *state_min;
70 rate_to_value_state_t *state_max;
71 rate_to_value_state_t *state_stddev;
76 static lookup_t *lookup = NULL;
78 static pthread_mutex_t agg_instance_list_lock = PTHREAD_MUTEX_INITIALIZER;
79 static agg_instance_t *agg_instance_list_head = NULL;
81 static void agg_destroy (aggregation_t *agg) /* {{{ */
84 } /* }}} void agg_destroy */
86 /* Frees all dynamically allocated memory within the instance. */
87 static void agg_instance_destroy (agg_instance_t *inst) /* {{{ */
92 /* Remove this instance from the global list of instances. */
93 pthread_mutex_lock (&agg_instance_list_lock);
94 if (agg_instance_list_head == inst)
95 agg_instance_list_head = inst->next;
96 else if (agg_instance_list_head != NULL)
98 agg_instance_t *prev = agg_instance_list_head;
99 while ((prev != NULL) && (prev->next != inst))
102 prev->next = inst->next;
104 pthread_mutex_unlock (&agg_instance_list_lock);
106 sfree (inst->state_num);
107 sfree (inst->state_sum);
108 sfree (inst->state_average);
109 sfree (inst->state_min);
110 sfree (inst->state_max);
111 sfree (inst->state_stddev);
113 memset (inst, 0, sizeof (*inst));
117 } /* }}} void agg_instance_destroy */
119 /* Create a new aggregation instance. */
120 static agg_instance_t *agg_instance_create (data_set_t const *ds, /* {{{ */
121 value_list_t const *vl, aggregation_t *agg)
123 agg_instance_t *inst;
125 DEBUG ("aggregation plugin: Creating new instance.");
127 inst = malloc (sizeof (*inst));
130 ERROR ("aggregation plugin: malloc() failed.");
133 memset (inst, 0, sizeof (*inst));
134 pthread_mutex_init (&inst->lock, /* attr = */ NULL);
136 inst->ds_type = ds->ds[0].type;
138 #define COPY_FIELD(fld) do { \
139 sstrncpy (inst->ident.fld, \
140 LU_IS_ANY (agg->ident.fld) ? vl->fld : agg->ident.fld, \
141 sizeof (inst->ident.fld)); \
146 COPY_FIELD (plugin_instance);
148 COPY_FIELD (type_instance);
155 #define INIT_STATE(field) do { \
156 inst->state_ ## field = NULL; \
157 if (agg->calc_ ## field) { \
158 inst->state_ ## field = malloc (sizeof (*inst->state_ ## field)); \
159 if (inst->state_ ## field == NULL) { \
160 agg_instance_destroy (inst); \
161 ERROR ("aggregation plugin: malloc() failed."); \
164 memset (inst->state_ ## field, 0, sizeof (*inst->state_ ## field)); \
170 INIT_STATE (average);
177 pthread_mutex_lock (&agg_instance_list_lock);
178 inst->next = agg_instance_list_head;
179 agg_instance_list_head = inst;
180 pthread_mutex_unlock (&agg_instance_list_lock);
183 } /* }}} agg_instance_t *agg_instance_create */
185 /* Update the num, sum, min, max, ... fields of the aggregation instance, if
186 * the rate of the value list is available. Value lists with more than one data
187 * source are not supported and will return an error. Returns zero on success
188 * and non-zero otherwise. */
189 static int agg_instance_update (agg_instance_t *inst, /* {{{ */
190 data_set_t const *ds, value_list_t const *vl)
196 ERROR ("aggregation plugin: The \"%s\" type (data set) has more than one "
197 "data source. This is currently not supported by this plugin. "
202 rate = uc_get_rate (ds, vl);
205 char ident[6 * DATA_MAX_NAME_LEN];
206 FORMAT_VL (ident, sizeof (ident), vl);
207 ERROR ("aggregation plugin: Unable to read the current rate of \"%s\".",
218 pthread_mutex_lock (&inst->lock);
221 inst->sum += rate[0];
222 inst->squares_sum += (rate[0] * rate[0]);
224 if (isnan (inst->min) || (inst->min > rate[0]))
226 if (isnan (inst->max) || (inst->max < rate[0]))
229 pthread_mutex_unlock (&inst->lock);
233 } /* }}} int agg_instance_update */
235 static int agg_instance_read_func (agg_instance_t *inst, /* {{{ */
236 char const *func, gauge_t rate, rate_to_value_state_t *state,
237 value_list_t *vl, char const *pi_prefix, cdtime_t t)
242 if (pi_prefix[0] != 0)
243 ssnprintf (vl->plugin_instance, sizeof (vl->plugin_instance), "%s-%s",
246 sstrncpy (vl->plugin_instance, func, sizeof (vl->plugin_instance));
248 memset (&v, 0, sizeof (v));
249 status = rate_to_value (&v, rate, state, inst->ds_type, t);
252 /* If this is the first iteration and rate_to_value() was asked to return a
253 * COUNTER or a DERIVE, it will return EAGAIN. Catch this and handle
255 if (status == EAGAIN)
258 WARNING ("aggregation plugin: rate_to_value failed with status %i.",
266 plugin_dispatch_values_secure (vl);
272 } /* }}} int agg_instance_read_func */
274 static int agg_instance_read (agg_instance_t *inst, cdtime_t t) /* {{{ */
276 value_list_t vl = VALUE_LIST_INIT;
277 char pi_prefix[DATA_MAX_NAME_LEN];
279 /* Pre-set all the fields in the value list that will not change per
280 * aggregation type (sum, average, ...). The struct will be re-used and must
281 * therefore be dispatched using the "secure" function. */
286 vl.meta = meta_data_create ();
289 ERROR ("aggregation plugin: meta_data_create failed.");
292 meta_data_add_boolean (vl.meta, "aggregation:created", 1);
294 if (LU_IS_ALL (inst->ident.host))
295 sstrncpy (vl.host, "global", sizeof (vl.host));
297 sstrncpy (vl.host, inst->ident.host, sizeof (vl.host));
299 sstrncpy (vl.plugin, "aggregation", sizeof (vl.plugin));
301 if (LU_IS_ALL (inst->ident.plugin))
303 if (LU_IS_ALL (inst->ident.plugin_instance))
304 sstrncpy (pi_prefix, "", sizeof (pi_prefix));
306 sstrncpy (pi_prefix, inst->ident.plugin_instance, sizeof (pi_prefix));
310 if (LU_IS_ALL (inst->ident.plugin_instance))
311 sstrncpy (pi_prefix, inst->ident.plugin, sizeof (pi_prefix));
313 ssnprintf (pi_prefix, sizeof (pi_prefix),
314 "%s-%s", inst->ident.plugin, inst->ident.plugin_instance);
317 sstrncpy (vl.type, inst->ident.type, sizeof (vl.type));
319 if (!LU_IS_ALL (inst->ident.type_instance))
320 sstrncpy (vl.type_instance, inst->ident.type_instance,
321 sizeof (vl.type_instance));
323 #define READ_FUNC(func, rate) do { \
324 if (inst->state_ ## func != NULL) { \
325 agg_instance_read_func (inst, #func, rate, \
326 inst->state_ ## func, &vl, pi_prefix, t); \
330 pthread_mutex_lock (&inst->lock);
332 READ_FUNC (num, (gauge_t) inst->num);
334 /* All other aggregations are only defined when there have been any values
338 READ_FUNC (sum, inst->sum);
339 READ_FUNC (average, (inst->sum / ((gauge_t) inst->num)));
340 READ_FUNC (min, inst->min);
341 READ_FUNC (max, inst->max);
342 READ_FUNC (stddev, sqrt((((gauge_t) inst->num) * inst->squares_sum)
343 - (inst->sum * inst->sum)) / ((gauge_t) inst->num));
346 /* Reset internal state. */
349 inst->squares_sum = 0.0;
353 pthread_mutex_unlock (&inst->lock);
355 meta_data_destroy (vl.meta);
359 } /* }}} int agg_instance_read */
361 /* lookup_class_callback_t for utils_vl_lookup */
362 static void *agg_lookup_class_callback ( /* {{{ */
363 __attribute__((unused)) data_set_t const *ds,
364 value_list_t const *vl, void *user_class)
366 return (agg_instance_create (ds, vl, (aggregation_t *) user_class));
367 } /* }}} void *agg_class_callback */
369 /* lookup_obj_callback_t for utils_vl_lookup */
370 static int agg_lookup_obj_callback (data_set_t const *ds, /* {{{ */
371 value_list_t const *vl,
372 __attribute__((unused)) void *user_class,
375 return (agg_instance_update ((agg_instance_t *) user_obj, ds, vl));
376 } /* }}} int agg_lookup_obj_callback */
378 /* lookup_free_class_callback_t for utils_vl_lookup */
379 static void agg_lookup_free_class_callback (void *user_class) /* {{{ */
381 agg_destroy ((aggregation_t *) user_class);
382 } /* }}} void agg_lookup_free_class_callback */
384 /* lookup_free_obj_callback_t for utils_vl_lookup */
385 static void agg_lookup_free_obj_callback (void *user_obj) /* {{{ */
387 agg_instance_destroy ((agg_instance_t *) user_obj);
388 } /* }}} void agg_lookup_free_obj_callback */
391 * <Plugin "aggregation">
397 * GroupBy TypeInstance
401 * CalculateAverage true
402 * CalculateMinimum true
403 * CalculateMaximum true
404 * CalculateStddev true
408 static int agg_config_handle_group_by (oconfig_item_t const *ci, /* {{{ */
413 for (i = 0; i < ci->values_num; i++)
417 if (ci->values[i].type != OCONFIG_TYPE_STRING)
419 ERROR ("aggregation plugin: Argument %i of the \"GroupBy\" option "
420 "is not a string.", i + 1);
424 value = ci->values[i].value.string;
426 if (strcasecmp ("Host", value) == 0)
427 sstrncpy (agg->ident.host, LU_ANY, sizeof (agg->ident.host));
428 else if (strcasecmp ("Plugin", value) == 0)
429 sstrncpy (agg->ident.plugin, LU_ANY, sizeof (agg->ident.plugin));
430 else if (strcasecmp ("PluginInstance", value) == 0)
431 sstrncpy (agg->ident.plugin_instance, LU_ANY,
432 sizeof (agg->ident.plugin_instance));
433 else if (strcasecmp ("TypeInstance", value) == 0)
434 sstrncpy (agg->ident.type_instance, LU_ANY, sizeof (agg->ident.type_instance));
435 else if (strcasecmp ("Type", value) == 0)
436 ERROR ("aggregation plugin: Grouping by type is not supported.");
438 WARNING ("aggregation plugin: The \"%s\" argument to the \"GroupBy\" "
439 "option is invalid and will be ignored.", value);
440 } /* for (ci->values) */
443 } /* }}} int agg_config_handle_group_by */
445 static int agg_config_aggregation (oconfig_item_t *ci) /* {{{ */
452 agg = malloc (sizeof (*agg));
455 ERROR ("aggregation plugin: malloc failed.");
458 memset (agg, 0, sizeof (*agg));
460 sstrncpy (agg->ident.host, LU_ALL, sizeof (agg->ident.host));
461 sstrncpy (agg->ident.plugin, LU_ALL, sizeof (agg->ident.plugin));
462 sstrncpy (agg->ident.plugin_instance, LU_ALL,
463 sizeof (agg->ident.plugin_instance));
464 sstrncpy (agg->ident.type, LU_ALL, sizeof (agg->ident.type));
465 sstrncpy (agg->ident.type_instance, LU_ALL,
466 sizeof (agg->ident.type_instance));
468 for (i = 0; i < ci->children_num; i++)
470 oconfig_item_t *child = ci->children + i;
472 if (strcasecmp ("Host", child->key) == 0)
473 cf_util_get_string_buffer (child, agg->ident.host,
474 sizeof (agg->ident.host));
475 else if (strcasecmp ("Plugin", child->key) == 0)
476 cf_util_get_string_buffer (child, agg->ident.plugin,
477 sizeof (agg->ident.plugin));
478 else if (strcasecmp ("PluginInstance", child->key) == 0)
479 cf_util_get_string_buffer (child, agg->ident.plugin_instance,
480 sizeof (agg->ident.plugin_instance));
481 else if (strcasecmp ("Type", child->key) == 0)
482 cf_util_get_string_buffer (child, agg->ident.type,
483 sizeof (agg->ident.type));
484 else if (strcasecmp ("TypeInstance", child->key) == 0)
485 cf_util_get_string_buffer (child, agg->ident.type_instance,
486 sizeof (agg->ident.type_instance));
487 else if (strcasecmp ("GroupBy", child->key) == 0)
488 agg_config_handle_group_by (child, agg);
489 else if (strcasecmp ("CalculateNum", child->key) == 0)
490 cf_util_get_boolean (child, &agg->calc_num);
491 else if (strcasecmp ("CalculateSum", child->key) == 0)
492 cf_util_get_boolean (child, &agg->calc_sum);
493 else if (strcasecmp ("CalculateAverage", child->key) == 0)
494 cf_util_get_boolean (child, &agg->calc_average);
495 else if (strcasecmp ("CalculateMinimum", child->key) == 0)
496 cf_util_get_boolean (child, &agg->calc_min);
497 else if (strcasecmp ("CalculateMaximum", child->key) == 0)
498 cf_util_get_boolean (child, &agg->calc_max);
499 else if (strcasecmp ("CalculateStddev", child->key) == 0)
500 cf_util_get_boolean (child, &agg->calc_stddev);
502 WARNING ("aggregation plugin: The \"%s\" key is not allowed inside "
503 "<Aggregation /> blocks and will be ignored.", child->key);
506 /* Sanity checking */
508 if (LU_IS_ALL (agg->ident.type)) /* {{{ */
510 ERROR ("aggregation plugin: It appears you did not specify the required "
511 "\"Type\" option in this aggregation. "
512 "(Host \"%s\", Plugin \"%s\", PluginInstance \"%s\", "
513 "Type \"%s\", TypeInstance \"%s\")",
514 agg->ident.host, agg->ident.plugin, agg->ident.plugin_instance,
515 agg->ident.type, agg->ident.type_instance);
518 else if (strchr (agg->ident.type, '/') != NULL)
520 ERROR ("aggregation plugin: The \"Type\" may not contain the '/' "
521 "character. Especially, it may not be a wildcard. The current "
522 "value is \"%s\".", agg->ident.type);
526 if (!LU_IS_ALL (agg->ident.host) /* {{{ */
527 && !LU_IS_ALL (agg->ident.plugin)
528 && !LU_IS_ALL (agg->ident.plugin_instance)
529 && !LU_IS_ALL (agg->ident.type_instance))
531 ERROR ("aggregation plugin: An aggregation must contain at least one "
532 "wildcard. This is achieved by leaving at least one of the \"Host\", "
533 "\"Plugin\", \"PluginInstance\" and \"TypeInstance\" options blank "
534 "and not grouping by that field. "
535 "(Host \"%s\", Plugin \"%s\", PluginInstance \"%s\", "
536 "Type \"%s\", TypeInstance \"%s\")",
537 agg->ident.host, agg->ident.plugin, agg->ident.plugin_instance,
538 agg->ident.type, agg->ident.type_instance);
542 if (!agg->calc_num && !agg->calc_sum && !agg->calc_average /* {{{ */
543 && !agg->calc_min && !agg->calc_max && !agg->calc_stddev)
545 ERROR ("aggregation plugin: No aggregation function has been specified. "
546 "Without this, I don't know what I should be calculating. "
547 "(Host \"%s\", Plugin \"%s\", PluginInstance \"%s\", "
548 "Type \"%s\", TypeInstance \"%s\")",
549 agg->ident.host, agg->ident.plugin, agg->ident.plugin_instance,
550 agg->ident.type, agg->ident.type_instance);
554 if (!is_valid) /* {{{ */
560 status = lookup_add (lookup, &agg->ident, agg);
563 ERROR ("aggregation plugin: lookup_add failed with status %i.", status);
568 DEBUG ("aggregation plugin: Successfully added aggregation: "
569 "(Host \"%s\", Plugin \"%s\", PluginInstance \"%s\", "
570 "Type \"%s\", TypeInstance \"%s\")",
571 agg->ident.host, agg->ident.plugin, agg->ident.plugin_instance,
572 agg->ident.type, agg->ident.type_instance);
574 } /* }}} int agg_config_aggregation */
576 static int agg_config (oconfig_item_t *ci) /* {{{ */
580 pthread_mutex_lock (&agg_instance_list_lock);
584 lookup = lookup_create (agg_lookup_class_callback,
585 agg_lookup_obj_callback,
586 agg_lookup_free_class_callback,
587 agg_lookup_free_obj_callback);
590 pthread_mutex_unlock (&agg_instance_list_lock);
591 ERROR ("aggregation plugin: lookup_create failed.");
596 for (i = 0; i < ci->children_num; i++)
598 oconfig_item_t *child = ci->children + i;
600 if (strcasecmp ("Aggregation", child->key) == 0)
601 agg_config_aggregation (child);
603 WARNING ("aggregation plugin: The \"%s\" key is not allowed inside "
604 "<Plugin aggregation /> blocks and will be ignored.", child->key);
607 pthread_mutex_unlock (&agg_instance_list_lock);
610 } /* }}} int agg_config */
612 static int agg_read (void) /* {{{ */
614 agg_instance_t *this;
621 pthread_mutex_lock (&agg_instance_list_lock);
623 /* agg_instance_list_head only holds data, after the "write" callback has
624 * been called with a matching value list at least once. So on startup,
625 * there's a race between the aggregations read() and write() callback. If
626 * the read() callback is called first, agg_instance_list_head is NULL and
627 * "success" may be zero. This is expected and should not result in an error.
628 * Therefore we need to handle this case separately. */
629 if (agg_instance_list_head == NULL)
631 pthread_mutex_unlock (&agg_instance_list_lock);
635 for (this = agg_instance_list_head; this != NULL; this = this->next)
639 status = agg_instance_read (this, t);
641 WARNING ("aggregation plugin: Reading an aggregation instance "
642 "failed with status %i.", status);
647 pthread_mutex_unlock (&agg_instance_list_lock);
649 return ((success > 0) ? 0 : -1);
650 } /* }}} int agg_read */
652 static int agg_write (data_set_t const *ds, value_list_t const *vl, /* {{{ */
653 __attribute__((unused)) user_data_t *user_data)
655 _Bool created_by_aggregation = 0;
658 /* Ignore values that were created by the aggregation plugin to avoid weird
660 (void) meta_data_get_boolean (vl->meta, "aggregation:created",
661 &created_by_aggregation);
662 if (created_by_aggregation)
669 status = lookup_search (lookup, ds, vl);
675 } /* }}} int agg_write */
677 void module_register (void)
679 plugin_register_complex_config ("aggregation", agg_config);
680 plugin_register_read ("aggregation", agg_read);
681 plugin_register_write ("aggregation", agg_write, /* user_data = */ NULL);
684 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */