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
 144   if (ci->values_num != 0)
 145   {
 146     WARNING ("tail plugin: Ignoring arguments for the `Match' block.");
 147   }
 148
 149   status = 0;
 150   for (int 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
 226   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 227   {
 228     WARNING ("tail plugin: `File' needs exactly one string argument.");
 229     return (-1);
 230   }
 231
 232   tm = tail_match_create (ci->values[0].value.string);
 233   if (tm == NULL)
 234   {
 235     ERROR ("tail plugin: tail_match_create (%s) failed.",
 236         ci->values[0].value.string);
 237     return (-1);
 238   }
 239
 240   for (int i = 0; i < ci->children_num; i++)
 241   {
 242     oconfig_item_t *option = ci->children + i;
 243     int status = 0;
 244
 245     if (strcasecmp ("Instance", option->key) == 0)
 246       status = cf_util_get_string (option, &plugin_instance);
 247     else if (strcasecmp ("Interval", option->key) == 0)
 248       cf_util_get_cdtime (option, &interval);
 249     else if (strcasecmp ("Match", option->key) == 0)
 250     {
 251       status = ctail_config_add_match (tm, plugin_instance, option, interval);
 252       if (status == 0)
 253         num_matches++;
 254       /* Be mild with failed matches.. */
 255       status = 0;
 256     }
 257     else
 258     {
 259       status = -1;
 260     }
 261
 262     if (status != 0)
 263       break;
 264   } /* for (i = 0; i < ci->children_num; i++) */
 265
 266   sfree (plugin_instance);
 267
 268   if (num_matches == 0)
 269   {
 270     ERROR ("tail plugin: No (valid) matches found for file `%s'.",
 271         ci->values[0].value.string);
 272     tail_match_destroy (tm);
 273     return (-1);
 274   }
 275   else
 276   {
 277     cu_tail_match_t **temp;
 278
 279     temp = realloc (tail_match_list,
 280         sizeof (cu_tail_match_t *) * (tail_match_list_num + 1));
 281     if (temp == NULL)
 282     {
 283       ERROR ("tail plugin: realloc failed.");
 284       tail_match_destroy (tm);
 285       return (-1);
 286     }
 287
 288     tail_match_list = temp;
 289     tail_match_list[tail_match_list_num] = tm;
 290     tail_match_list_intervals[tail_match_list_num] = interval;
 291     tail_match_list_num++;
 292   }
 293
 294   return (0);
 295 } /* int ctail_config_add_file */
 296
 297 static int ctail_config (oconfig_item_t *ci)
 298 {
 299   for (int i = 0; i < ci->children_num; i++)
 300   {
 301     oconfig_item_t *option = ci->children + i;
 302
 303     if (strcasecmp ("File", option->key) == 0)
 304       ctail_config_add_file (option);
 305     else
 306     {
 307       WARNING ("tail plugin: Option `%s' not allowed here.", option->key);
 308     }
 309   } /* for (i = 0; i < ci->children_num; i++) */
 310
 311   return (0);
 312 } /* int ctail_config */
 313
 314 static int ctail_read (user_data_t *ud)
 315 {
 316   int status;
 317
 318   status = tail_match_read ((cu_tail_match_t *)ud->data);
 319   if (status != 0)
 320   {
 321     ERROR ("tail plugin: tail_match_read failed.");
 322     return (-1);
 323   }
 324
 325   return (0);
 326 } /* int ctail_read */
 327
 328 static int ctail_init (void)
 329 {
 330   char str[255];
 331
 332   if (tail_match_list_num == 0)
 333   {
 334     WARNING ("tail plugin: File list is empty. Returning an error.");
 335     return (-1);
 336   }
 337
 338   for (size_t i = 0; i < tail_match_list_num; i++)
 339   {
 340     ssnprintf(str, sizeof(str), "tail-%zu", i);
 341
 342     user_data_t ud = {
 343      .data = tail_match_list[i]
 344     };
 345
 346     plugin_register_complex_read (NULL, str, ctail_read, tail_match_list_intervals[i], &ud);
 347   }
 348
 349   return (0);
 350 } /* int ctail_init */
 351
 352 static int ctail_shutdown (void)
 353 {
 354   for (size_t i = 0; i < tail_match_list_num; i++)
 355   {
 356     tail_match_destroy (tail_match_list[i]);
 357     tail_match_list[i] = NULL;
 358   }
 359   sfree (tail_match_list);
 360   tail_match_list_num = 0;
 361
 362   return (0);
 363 } /* int ctail_shutdown */
 364
 365 void module_register (void)
 366 {
 367   plugin_register_complex_config ("tail", ctail_config);
 368   plugin_register_init ("tail", ctail_init);
 369   plugin_register_shutdown ("tail", ctail_shutdown);
 370 } /* void module_register */
 371
 372 /* vim: set sw=2 sts=2 ts=8 : */