src/utils_tail_match.c

   1 /*
   2  * collectd - src/utils_tail_match.c
   3  * Copyright (C) 2007-2008  C-Ware, Inc.
   4  * Copyright (C) 2008       Florian Forster
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; only version 2 of the License is applicable.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Author:
  20  *   Luke Heberling <lukeh at c-ware.com>
  21  *   Florian Forster <octo at verplant.org>
  22  *
  23  * Description:
  24  *   Encapsulates useful code to plugins which must parse a log file.
  25  */
  26
  27 #include "collectd.h"
  28 #include "common.h"
  29 #include "plugin.h"
  30 #include "utils_match.h"
  31 #include "utils_tail.h"
  32 #include "utils_tail_match.h"
  33
  34 struct cu_tail_match_simple_s
  35 {
  36   char plugin[DATA_MAX_NAME_LEN];
  37   char plugin_instance[DATA_MAX_NAME_LEN];
  38   char type[DATA_MAX_NAME_LEN];
  39   char type_instance[DATA_MAX_NAME_LEN];
  40 };
  41 typedef struct cu_tail_match_simple_s cu_tail_match_simple_t;
  42
  43 struct cu_tail_match_match_s
  44 {
  45   cu_match_t *match;
  46   void *user_data;
  47   int (*submit) (cu_match_t *match, void *user_data);
  48   void (*free) (void *user_data);
  49 };
  50 typedef struct cu_tail_match_match_s cu_tail_match_match_t;
  51
  52 struct cu_tail_match_s
  53 {
  54   int flags;
  55   cu_tail_t *tail;
  56
  57   cu_tail_match_match_t *matches;
  58   size_t matches_num;
  59 };
  60
  61 /*
  62  * Private functions
  63  */
  64 static int simple_submit_match (cu_match_t *match, void *user_data)
  65 {
  66   cu_tail_match_simple_t *data = (cu_tail_match_simple_t *) user_data;
  67   cu_match_value_t *match_value;
  68   value_list_t vl = VALUE_LIST_INIT;
  69   value_t values[1];
  70
  71   match_value = (cu_match_value_t *) match_get_user_data (match);
  72   if (match_value == NULL)
  73     return (-1);
  74
  75   values[0] = match_value->value;
  76
  77   vl.values = values;
  78   vl.values_len = 1;
  79   vl.time = time (NULL);
  80   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
  81   sstrncpy (vl.plugin, data->plugin, sizeof (vl.plugin));
  82   sstrncpy (vl.plugin_instance, data->plugin_instance,
  83       sizeof (vl.plugin_instance));
  84   sstrncpy (vl.type_instance, data->type_instance,
  85       sizeof (vl.type_instance));
  86
  87   plugin_dispatch_values (data->type, &vl);
  88
  89   if (match_value->ds_type & UTILS_MATCH_DS_TYPE_GAUGE)
  90   {
  91     match_value->value.gauge = NAN;
  92     match_value->values_num = 0;
  93   }
  94
  95   return (0);
  96 } /* int simple_submit_match */
  97
  98 static int tail_callback (void *data, char *buf, int buflen)
  99 {
 100   cu_tail_match_t *obj = (cu_tail_match_t *) data;
 101   int i;
 102
 103   for (i = 0; i < obj->matches_num; i++)
 104     match_apply (obj->matches[i].match, buf);
 105
 106   return (0);
 107 } /* int tail_callback */
 108
 109 /*
 110  * Public functions
 111  */
 112 cu_tail_match_t *tail_match_create (const char *filename)
 113 {
 114   cu_tail_match_t *obj;
 115
 116   obj = (cu_tail_match_t *) malloc (sizeof (cu_tail_match_t));
 117   if (obj == NULL)
 118     return (NULL);
 119   memset (obj, '\0', sizeof (cu_tail_match_t));
 120
 121   obj->tail = cu_tail_create (filename);
 122   if (obj->tail == NULL)
 123   {
 124     sfree (obj);
 125     return (NULL);
 126   }
 127
 128   return (obj);
 129 } /* cu_tail_match_t *tail_match_create */
 130
 131 void tail_match_destroy (cu_tail_match_t *obj)
 132 {
 133   int i;
 134
 135   if (obj == NULL)
 136     return;
 137
 138   if (obj->tail != NULL)
 139   {
 140     cu_tail_destroy (obj->tail);
 141     obj->tail = NULL;
 142   }
 143
 144   for (i = 0; i < obj->matches_num; i++)
 145   {
 146     cu_tail_match_match_t *match = obj->matches + i;
 147     if (match->match != NULL)
 148     {
 149       match_destroy (match->match);
 150       match->match = NULL;
 151     }
 152
 153     if ((match->user_data != NULL)
 154         && (match->free != NULL))
 155       (*match->free) (match->user_data);
 156     match->user_data = NULL;
 157   }
 158
 159   sfree (obj->matches);
 160   sfree (obj);
 161 } /* void tail_match_destroy */
 162
 163 int tail_match_add_match (cu_tail_match_t *obj, cu_match_t *match,
 164     int (*submit_match) (cu_match_t *match, void *user_data),
 165     void *user_data,
 166     void (*free_user_data) (void *user_data))
 167 {
 168   cu_tail_match_match_t *temp;
 169
 170   temp = (cu_tail_match_match_t *) realloc (obj->matches,
 171       sizeof (cu_tail_match_match_t) * (obj->matches_num + 1));
 172   if (temp == NULL)
 173     return (-1);
 174
 175   obj->matches = temp;
 176   obj->matches_num++;
 177
 178   temp = obj->matches + (obj->matches_num - 1);
 179
 180   temp->match = match;
 181   temp->user_data = user_data;
 182   temp->submit = submit_match;
 183   temp->free = free_user_data;
 184
 185   return (0);
 186 } /* int tail_match_add_match */
 187
 188 int tail_match_add_match_simple (cu_tail_match_t *obj,
 189     const char *regex, int ds_type,
 190     const char *plugin, const char *plugin_instance,
 191     const char *type, const char *type_instance)
 192 {
 193   cu_match_t *match;
 194   cu_tail_match_simple_t *user_data;
 195   int status;
 196
 197   match = match_create_simple (regex, ds_type);
 198   if (match == NULL)
 199     return (-1);
 200
 201   user_data = (cu_tail_match_simple_t *) malloc (sizeof (cu_tail_match_simple_t));
 202   if (user_data == NULL)
 203   {
 204     match_destroy (match);
 205     return (-1);
 206   }
 207   memset (user_data, '\0', sizeof (cu_tail_match_simple_t));
 208
 209   sstrncpy (user_data->plugin, plugin, sizeof (user_data->plugin));
 210   if (plugin_instance != NULL)
 211     sstrncpy (user_data->plugin_instance, plugin_instance,
 212         sizeof (user_data->plugin_instance));
 213
 214   sstrncpy (user_data->type, type, sizeof (user_data->type));
 215   if (type_instance != NULL)
 216     sstrncpy (user_data->type_instance, type_instance,
 217         sizeof (user_data->type_instance));
 218
 219   status = tail_match_add_match (obj, match, simple_submit_match,
 220       user_data, free);
 221
 222   if (status != 0)
 223   {
 224     match_destroy (match);
 225     sfree (user_data);
 226   }
 227
 228   return (status);
 229 } /* int tail_match_add_match_simple */
 230
 231 int tail_match_read (cu_tail_match_t *obj)
 232 {
 233   char buffer[4096];
 234   int status;
 235   int i;
 236
 237   status = cu_tail_read (obj->tail, buffer, sizeof (buffer), tail_callback,
 238       (void *) obj);
 239   if (status != 0)
 240   {
 241     ERROR ("tail_match: cu_tail_read failed.");
 242     return (status);
 243   }
 244
 245   for (i = 0; i < obj->matches_num; i++)
 246   {
 247     cu_tail_match_match_t *lt_match = obj->matches + i;
 248
 249     if (lt_match->submit == NULL)
 250       continue;
 251
 252     (*lt_match->submit) (lt_match->match, lt_match->user_data);
 253   }
 254
 255   return (0);
 256 } /* int tail_match_read */
 257
 258 /* vim: set sw=2 sts=2 ts=8 : */