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