/* * collectd - src/utils_tail_match.c * Copyright (C) 2007-2008 C-Ware, Inc. * Copyright (C) 2008 Florian Forster * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. * * Author: * Luke Heberling * Florian Forster * * Description: * Encapsulates useful code to plugins which must parse a log file. */ #include "collectd.h" #include "plugin.h" #include "utils/common/common.h" #include "utils/latency/latency_config.h" #include "utils/match/match.h" #include "utils/tail/tail.h" #include "utils_tail_match.h" struct cu_tail_match_simple_s { char plugin[DATA_MAX_NAME_LEN]; char plugin_instance[DATA_MAX_NAME_LEN]; char type[DATA_MAX_NAME_LEN]; char type_instance[DATA_MAX_NAME_LEN]; latency_config_t latency_config; }; typedef struct cu_tail_match_simple_s cu_tail_match_simple_t; struct cu_tail_match_match_s { cu_match_t *match; void *user_data; int (*submit)(cu_match_t *match, void *user_data); void (*free)(void *user_data); }; typedef struct cu_tail_match_match_s cu_tail_match_match_t; struct cu_tail_match_s { cu_tail_t *tail; cu_tail_match_match_t *matches; size_t matches_num; }; /* * Private functions */ static int simple_submit_match(cu_match_t *match, void *user_data) { cu_tail_match_simple_t *data = (cu_tail_match_simple_t *)user_data; cu_match_value_t *match_value; value_list_t vl = VALUE_LIST_INIT; value_t values[1]; match_value = (cu_match_value_t *)match_get_user_data(match); if (match_value == NULL) return -1; if ((match_value->ds_type & UTILS_MATCH_DS_TYPE_GAUGE) && (match_value->values_num == 0)) values[0].gauge = NAN; else values[0] = match_value->value; vl.values = values; vl.values_len = 1; sstrncpy(vl.plugin, data->plugin, sizeof(vl.plugin)); sstrncpy(vl.plugin_instance, data->plugin_instance, sizeof(vl.plugin_instance)); sstrncpy(vl.type, data->type, sizeof(vl.type)); sstrncpy(vl.type_instance, data->type_instance, sizeof(vl.type_instance)); plugin_dispatch_values(&vl); match_value_reset(match_value); return 0; } /* int simple_submit_match */ static int latency_submit_match(cu_match_t *match, void *user_data) { cu_tail_match_simple_t *data = (cu_tail_match_simple_t *)user_data; cu_match_value_t *match_value; value_list_t vl = VALUE_LIST_INIT; match_value = (cu_match_value_t *)match_get_user_data(match); if (match_value == NULL) return -1; sstrncpy(vl.plugin, data->plugin, sizeof(vl.plugin)); sstrncpy(vl.plugin_instance, data->plugin_instance, sizeof(vl.plugin_instance)); vl.time = cdtime(); /* Submit percentiles */ sstrncpy(vl.type, data->type, sizeof(vl.type)); for (size_t i = 0; i < data->latency_config.percentile_num; i++) { if (strlen(data->type_instance) != 0) snprintf(vl.type_instance, sizeof(vl.type_instance), "%.50s-%.5g", data->type_instance, data->latency_config.percentile[i]); else snprintf(vl.type_instance, sizeof(vl.type_instance), "%.5g", data->latency_config.percentile[i]); vl.values = &(value_t){ .gauge = (match_value->values_num != 0) ? CDTIME_T_TO_DOUBLE(latency_counter_get_percentile( match_value->latency, data->latency_config.percentile[i])) : NAN, }; vl.values_len = 1; plugin_dispatch_values(&vl); } /* Submit buckets */ if (data->latency_config.bucket_type != NULL) sstrncpy(vl.type, data->latency_config.bucket_type, sizeof(vl.type)); else sstrncpy(vl.type, "bucket", sizeof(vl.type)); for (size_t i = 0; i < data->latency_config.buckets_num; i++) { latency_bucket_t bucket = data->latency_config.buckets[i]; double lower_bound = CDTIME_T_TO_DOUBLE(bucket.lower_bound); double upper_bound = bucket.upper_bound ? CDTIME_T_TO_DOUBLE(bucket.upper_bound) : INFINITY; if (strlen(data->type_instance) != 0) snprintf(vl.type_instance, sizeof(vl.type_instance), "%.50s-%.50s-%g_%g", data->type, data->type_instance, lower_bound, upper_bound); else snprintf(vl.type_instance, sizeof(vl.type_instance), "%.50s-%g_%g", data->type, lower_bound, upper_bound); vl.values = &(value_t){ .gauge = latency_counter_get_rate(match_value->latency, bucket.lower_bound, bucket.upper_bound, vl.time), }; vl.values_len = 1; plugin_dispatch_values(&vl); } match_value->value.gauge = NAN; match_value->values_num = 0; latency_counter_reset(match_value->latency); return 0; } /* int latency_submit_match */ static int tail_callback(void *data, char *buf, int __attribute__((unused)) buflen) { cu_tail_match_t *obj = (cu_tail_match_t *)data; for (size_t i = 0; i < obj->matches_num; i++) match_apply(obj->matches[i].match, buf); return 0; } /* int tail_callback */ static void tail_match_simple_free(void *data) { cu_tail_match_simple_t *user_data = (cu_tail_match_simple_t *)data; latency_config_free(user_data->latency_config); sfree(user_data); } /* void tail_match_simple_free */ /* * Public functions */ cu_tail_match_t *tail_match_create(const char *filename) { cu_tail_match_t *obj; obj = calloc(1, sizeof(*obj)); if (obj == NULL) return NULL; obj->tail = cu_tail_create(filename); if (obj->tail == NULL) { sfree(obj); return NULL; } return obj; } /* cu_tail_match_t *tail_match_create */ void tail_match_destroy(cu_tail_match_t *obj) { if (obj == NULL) return; if (obj->tail != NULL) { cu_tail_destroy(obj->tail); obj->tail = NULL; } for (size_t i = 0; i < obj->matches_num; i++) { cu_tail_match_match_t *match = obj->matches + i; if (match->match != NULL) { match_destroy(match->match); match->match = NULL; } if ((match->user_data != NULL) && (match->free != NULL)) (*match->free)(match->user_data); match->user_data = NULL; } sfree(obj->matches); sfree(obj); } /* void tail_match_destroy */ int tail_match_add_match(cu_tail_match_t *obj, cu_match_t *match, int (*submit_match)(cu_match_t *match, void *user_data), void *user_data, void (*free_user_data)(void *user_data)) { cu_tail_match_match_t *temp; temp = realloc(obj->matches, sizeof(cu_tail_match_match_t) * (obj->matches_num + 1)); if (temp == NULL) return -1; obj->matches = temp; obj->matches_num++; temp = obj->matches + (obj->matches_num - 1); temp->match = match; temp->user_data = user_data; temp->submit = submit_match; temp->free = free_user_data; return 0; } /* int tail_match_add_match */ int tail_match_add_match_simple(cu_tail_match_t *obj, const char *regex, const char *excluderegex, int ds_type, const char *plugin, const char *plugin_instance, const char *type, const char *type_instance, const latency_config_t latency_cfg) { cu_match_t *match; cu_tail_match_simple_t *user_data; int status; match = match_create_simple(regex, excluderegex, ds_type); if (match == NULL) return -1; user_data = calloc(1, sizeof(*user_data)); if (user_data == NULL) { match_destroy(match); return -1; } sstrncpy(user_data->plugin, plugin, sizeof(user_data->plugin)); if (plugin_instance != NULL) sstrncpy(user_data->plugin_instance, plugin_instance, sizeof(user_data->plugin_instance)); sstrncpy(user_data->type, type, sizeof(user_data->type)); if (type_instance != NULL) sstrncpy(user_data->type_instance, type_instance, sizeof(user_data->type_instance)); if ((ds_type & UTILS_MATCH_DS_TYPE_GAUGE) && (ds_type & UTILS_MATCH_CF_GAUGE_DIST)) { status = latency_config_copy(&user_data->latency_config, latency_cfg); if (status != 0) { ERROR("tail_match_add_match_simple: latency_config_copy() failed."); status = -1; goto out; } status = tail_match_add_match(obj, match, latency_submit_match, user_data, tail_match_simple_free); } else { status = tail_match_add_match(obj, match, simple_submit_match, user_data, free); } out: if (status != 0) { tail_match_simple_free(user_data); match_destroy(match); } return status; } /* int tail_match_add_match_simple */ int tail_match_read(cu_tail_match_t *obj, bool force_rewind) { char buffer[4096]; int status; status = cu_tail_read(obj->tail, buffer, sizeof(buffer), tail_callback, (void *)obj, force_rewind); if (status != 0) { ERROR("tail_match: cu_tail_read failed."); return status; } for (size_t i = 0; i < obj->matches_num; i++) { cu_tail_match_match_t *lt_match = obj->matches + i; if (lt_match->submit == NULL) continue; (*lt_match->submit)(lt_match->match, lt_match->user_data); } return 0; } /* int tail_match_read */