src/tail.c

   1 /**
   2  * collectd - src/tail.c
   3  * Copyright (C) 2008       Florian octo Forster
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "plugin.h"
  31 #include "utils_tail_match.h"
  32
  33 /*
  34  *  <Plugin tail>
  35  *    <File "/var/log/exim4/mainlog">
  36  *      Instance "exim"
  37  *      Interval 60
  38  *      <Match>
  39  *        Regex "S=([1-9][0-9]*)"
  40  *        ExcludeRegex "U=root.*S="
  41  *        DSType "CounterAdd"
  42  *        Type "ipt_bytes"
  43  *        Instance "total"
  44  *      </Match>
  45  *    </File>
  46  *  </Plugin>
  47  */
  48
  49 struct ctail_config_match_s
  50 {
  51   char *regex;
  52   char *excluderegex;
  53   int flags;
  54   char *type;
  55   char *type_instance;
  56   cdtime_t interval;
  57 };
  58 typedef struct ctail_config_match_s ctail_config_match_t;
  59
  60 static cu_tail_match_t **tail_match_list = NULL;
  61 static size_t tail_match_list_num = 0;
  62 static cdtime_t tail_match_list_intervals[255];
  63
  64 static int ctail_config_add_match_dstype (ctail_config_match_t *cm,
  65     oconfig_item_t *ci)
  66 {
  67   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
  68   {
  69     WARNING ("tail plugin: `DSType' needs exactly one string argument.");
  70     return (-1);
  71   }
  72
  73   if (strncasecmp ("Gauge", ci->values[0].value.string, strlen ("Gauge")) == 0)
  74   {
  75     cm->flags = UTILS_MATCH_DS_TYPE_GAUGE;
  76     if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
  77       cm->flags |= UTILS_MATCH_CF_GAUGE_AVERAGE;
  78     else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
  79       cm->flags |= UTILS_MATCH_CF_GAUGE_MIN;
  80     else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
  81       cm->flags |= UTILS_MATCH_CF_GAUGE_MAX;
  82     else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
  83       cm->flags |= UTILS_MATCH_CF_GAUGE_LAST;
  84     else if (strcasecmp ("GaugeInc", ci->values[0].value.string) == 0)
  85       cm->flags |= UTILS_MATCH_CF_GAUGE_INC;
  86     else if (strcasecmp ("GaugeAdd", ci->values[0].value.string) == 0)
  87       cm->flags |= UTILS_MATCH_CF_GAUGE_ADD;
  88     else
  89       cm->flags = 0;
  90   }
  91   else if (strncasecmp ("Counter", ci->values[0].value.string, strlen ("Counter")) == 0)
  92   {
  93     cm->flags = UTILS_MATCH_DS_TYPE_COUNTER;
  94     if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
  95       cm->flags |= UTILS_MATCH_CF_COUNTER_SET;
  96     else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
  97       cm->flags |= UTILS_MATCH_CF_COUNTER_ADD;
  98     else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
  99       cm->flags |= UTILS_MATCH_CF_COUNTER_INC;
 100     else
 101       cm->flags = 0;
 102   }
 103   else if (strncasecmp ("Derive", ci->values[0].value.string, strlen ("Derive")) == 0)
 104   {
 105     cm->flags = UTILS_MATCH_DS_TYPE_DERIVE;
 106     if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
 107       cm->flags |= UTILS_MATCH_CF_DERIVE_SET;
 108     else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
 109       cm->flags |= UTILS_MATCH_CF_DERIVE_ADD;
 110     else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
 111       cm->flags |= UTILS_MATCH_CF_DERIVE_INC;
 112     else
 113       cm->flags = 0;
 114   }
 115   else if (strncasecmp ("Absolute", ci->values[0].value.string, strlen ("Absolute")) == 0)
 116   {
 117     cm->flags = UTILS_MATCH_DS_TYPE_ABSOLUTE;
 118     if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0)
 119       cm->flags |= UTILS_MATCH_CF_ABSOLUTE_SET;
 120     else
 121       cm->flags = 0;
 122   }
 123   else
 124   {
 125     cm->flags = 0;
 126   }
 127
 128   if (cm->flags == 0)
 129   {
 130     WARNING ("tail plugin: `%s' is not a valid argument to `DSType'.",
 131         ci->values[0].value.string);
 132     return (-1);
 133   }
 134
 135   return (0);
 136 } /* int ctail_config_add_match_dstype */
 137
 138 static int ctail_config_add_match (cu_tail_match_t *tm,
 139     const char *plugin_instance, oconfig_item_t *ci, cdtime_t interval)
 140 {
 141   ctail_config_match_t cm = { 0 };
 142   int status;
 143   int i;
 144
 145   if (ci->values_num != 0)
 146   {
 147     WARNING ("tail plugin: Ignoring arguments for the `Match' block.");
 148   }
 149
 150   status = 0;
 151   for (i = 0; i < ci->children_num; i++)
 152   {
 153     oconfig_item_t *option = ci->children + i;
 154
 155     if (strcasecmp ("Regex", option->key) == 0)
 156       status = cf_util_get_string (option, &cm.regex);
 157     else if (strcasecmp ("ExcludeRegex", option->key) == 0)
 158       status = cf_util_get_string (option, &cm.excluderegex);
 159     else if (strcasecmp ("DSType", option->key) == 0)
 160       status = ctail_config_add_match_dstype (&cm, option);
 161     else if (strcasecmp ("Type", option->key) == 0)
 162       status = cf_util_get_string (option, &cm.type);
 163     else if (strcasecmp ("Instance", option->key) == 0)
 164       status = cf_util_get_string (option, &cm.type_instance);
 165     else
 166     {
 167       WARNING ("tail plugin: Option `%s' not allowed here.", option->key);
 168       status = -1;
 169     }
 170
 171     if (status != 0)
 172       break;
 173   } /* for (i = 0; i < ci->children_num; i++) */
 174
 175   while (status == 0)
 176   {
 177     if (cm.regex == NULL)
 178     {
 179       WARNING ("tail plugin: `Regex' missing in `Match' block.");
 180       status = -1;
 181       break;
 182     }
 183
 184     if (cm.type == NULL)
 185     {
 186       WARNING ("tail plugin: `Type' missing in `Match' block.");
 187       status = -1;
 188       break;
 189     }
 190
 191     if (cm.flags == 0)
 192     {
 193       WARNING ("tail plugin: `DSType' missing in `Match' block.");
 194       status = -1;
 195       break;
 196     }
 197
 198     break;
 199   } /* while (status == 0) */
 200
 201   if (status == 0)
 202   {
 203     status = tail_match_add_match_simple (tm, cm.regex, cm.excluderegex,
 204         cm.flags, "tail", plugin_instance, cm.type, cm.type_instance, interval);
 205
 206     if (status != 0)
 207     {
 208       ERROR ("tail plugin: tail_match_add_match_simple failed.");
 209     }
 210   }
 211
 212   sfree (cm.regex);
 213   sfree (cm.excluderegex);
 214   sfree (cm.type);
 215   sfree (cm.type_instance);
 216
 217   return (status);
 218 } /* int ctail_config_add_match */
 219
 220 static int ctail_config_add_file (oconfig_item_t *ci)
 221 {
 222   cu_tail_match_t *tm;
 223   cdtime_t interval = 0;
 224   char *plugin_instance = NULL;
 225   int num_matches = 0;
 226   int i;
 227
 228   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 229   {
 230     WARNING ("tail plugin: `File' needs exactly one string argument.");
 231     return (-1);
 232   }
 233
 234   tm = tail_match_create (ci->values[0].value.string);
 235   if (tm == NULL)
 236   {
 237     ERROR ("tail plugin: tail_match_create (%s) failed.",
 238         ci->values[0].value.string);
 239     return (-1);
 240   }
 241
 242   for (i = 0; i < ci->children_num; i++)
 243   {
 244     oconfig_item_t *option = ci->children + i;
 245     int status = 0;
 246
 247     if (strcasecmp ("Instance", option->key) == 0)
 248       status = cf_util_get_string (option, &plugin_instance);
 249     else if (strcasecmp ("Interval", option->key) == 0)
 250       cf_util_get_cdtime (option, &interval);
 251     else if (strcasecmp ("Match", option->key) == 0)
 252     {
 253       status = ctail_config_add_match (tm, plugin_instance, option, interval);
 254       if (status == 0)
 255         num_matches++;
 256       /* Be mild with failed matches.. */
 257       status = 0;
 258     }
 259     else
 260     {
 261       status = -1;
 262     }
 263
 264     if (status != 0)
 265       break;
 266   } /* for (i = 0; i < ci->children_num; i++) */
 267
 268   sfree (plugin_instance);
 269
 270   if (num_matches == 0)
 271   {
 272     ERROR ("tail plugin: No (valid) matches found for file `%s'.",
 273         ci->values[0].value.string);
 274     tail_match_destroy (tm);
 275     return (-1);
 276   }
 277   else
 278   {
 279     cu_tail_match_t **temp;
 280
 281     temp = realloc (tail_match_list,
 282         sizeof (cu_tail_match_t *) * (tail_match_list_num + 1));
 283     if (temp == NULL)
 284     {
 285       ERROR ("tail plugin: realloc failed.");
 286       tail_match_destroy (tm);
 287       return (-1);
 288     }
 289
 290     tail_match_list = temp;
 291     tail_match_list[tail_match_list_num] = tm;
 292     tail_match_list_intervals[tail_match_list_num] = interval;
 293     tail_match_list_num++;
 294   }
 295
 296   return (0);
 297 } /* int ctail_config_add_file */
 298
 299 static int ctail_config (oconfig_item_t *ci)
 300 {
 301   int i;
 302
 303   for (i = 0; i < ci->children_num; i++)
 304   {
 305     oconfig_item_t *option = ci->children + i;
 306
 307     if (strcasecmp ("File", option->key) == 0)
 308       ctail_config_add_file (option);
 309     else
 310     {
 311       WARNING ("tail plugin: Option `%s' not allowed here.", option->key);
 312     }
 313   } /* for (i = 0; i < ci->children_num; i++) */
 314
 315   return (0);
 316 } /* int ctail_config */
 317
 318 static int ctail_read (user_data_t *ud)
 319 {
 320   int status;
 321
 322   status = tail_match_read ((cu_tail_match_t *)ud->data);
 323   if (status != 0)
 324   {
 325     ERROR ("tail plugin: tail_match_read failed.");
 326     return (-1);
 327   }
 328
 329   return (0);
 330 } /* int ctail_read */
 331
 332 static int ctail_init (void)
 333 {
 334   char str[255];
 335   user_data_t ud = { 0 };
 336   size_t i;
 337
 338   if (tail_match_list_num == 0)
 339   {
 340     WARNING ("tail plugin: File list is empty. Returning an error.");
 341     return (-1);
 342   }
 343
 344   for (i = 0; i < tail_match_list_num; i++)
 345   {
 346     ud.data = (void *)tail_match_list[i];
 347     ssnprintf(str, sizeof(str), "tail-%zu", i);
 348     plugin_register_complex_read (NULL, str, ctail_read, tail_match_list_intervals[i], &ud);
 349   }
 350
 351   return (0);
 352 } /* int ctail_init */
 353
 354 static int ctail_shutdown (void)
 355 {
 356   size_t i;
 357
 358   for (i = 0; i < tail_match_list_num; i++)
 359   {
 360     tail_match_destroy (tail_match_list[i]);
 361     tail_match_list[i] = NULL;
 362   }
 363   sfree (tail_match_list);
 364   tail_match_list_num = 0;
 365
 366   return (0);
 367 } /* int ctail_shutdown */
 368
 369 void module_register (void)
 370 {
 371   plugin_register_complex_config ("tail", ctail_config);
 372   plugin_register_init ("tail", ctail_init);
 373   plugin_register_shutdown ("tail", ctail_shutdown);
 374 } /* void module_register */
 375
 376 /* vim: set sw=2 sts=2 ts=8 : */