src/target_set.c

   1 /**
   2  * collectd - src/target_set.c
   3  * Copyright (C) 2008       Florian 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 Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "filter_chain.h"
  31 #include "meta_data.h"
  32 #include "utils_subst.h"
  33
  34 struct ts_key_list_s
  35 {
  36   char *key;
  37   struct ts_key_list_s *next;
  38 };
  39 typedef struct ts_key_list_s ts_key_list_t;
  40
  41 static void ts_key_list_free (ts_key_list_t *l) /* {{{ */
  42 {
  43   if (l == NULL)
  44     return;
  45
  46   sfree (l->key);
  47
  48   if (l->next != NULL)
  49     ts_key_list_free (l->next);
  50
  51   sfree (l);
  52 } /* }}} void ts_name_list_free */
  53
  54 struct ts_data_s
  55 {
  56   char *host;
  57   char *plugin;
  58   char *plugin_instance;
  59   /* char *type; */
  60   char *type_instance;
  61   meta_data_t *meta;
  62   ts_key_list_t *meta_delete;
  63 };
  64 typedef struct ts_data_s ts_data_t;
  65
  66 static int ts_util_get_key_and_string_wo_strdup (const oconfig_item_t *ci, char **ret_key, char **ret_string) /* {{{ */
  67 {
  68   if ((ci->values_num != 2)
  69       || (ci->values[0].type != OCONFIG_TYPE_STRING)
  70       || (ci->values[1].type != OCONFIG_TYPE_STRING))
  71   {
  72     ERROR ("ts_util_get_key_and_string_wo_strdup: The %s option requires "
  73         "exactly two string arguments.", ci->key);
  74     return (-1);
  75   }
  76
  77   *ret_key = ci->values[0].value.string;
  78   *ret_string = ci->values[1].value.string;
  79
  80   return (0);
  81 } /* }}} int ts_util_get_key_and_string_wo_strdup */
  82
  83 static int ts_config_add_string (char **dest, /* {{{ */
  84     const oconfig_item_t *ci, int may_be_empty)
  85 {
  86   char *tmp = NULL;
  87   int status;
  88
  89   status = cf_util_get_string (ci, &tmp);
  90   if (status != 0)
  91     return (status);
  92
  93   if (!may_be_empty && (strlen (tmp) == 0))
  94   {
  95     ERROR ("Target `set': The `%s' option does not accept empty strings.",
  96         ci->key);
  97     sfree (tmp);
  98     return (-1);
  99   }
 100
 101   *dest = tmp;
 102   return (0);
 103 } /* }}} int ts_config_add_string */
 104
 105 static int ts_config_add_meta (meta_data_t **dest, /* {{{ */
 106     const oconfig_item_t *ci, int may_be_empty)
 107 {
 108   char *key = NULL;
 109   char *string = NULL;
 110   int status;
 111
 112   status = ts_util_get_key_and_string_wo_strdup (ci, &key, &string);
 113   if (status != 0)
 114     return (status);
 115
 116   if (strlen (key) == 0)
 117   {
 118     ERROR ("Target `set': The `%s' option does not accept empty string as "
 119         "first argument.", ci->key);
 120     return (-1);
 121   }
 122
 123   if (!may_be_empty && (strlen (string) == 0))
 124   {
 125     ERROR ("Target `set': The `%s' option does not accept empty string as "
 126         "second argument.", ci->key);
 127     return (-1);
 128   }
 129
 130   if ((*dest) == NULL)
 131   {
 132     /* Create a new meta_data_t */
 133     if ((*dest = meta_data_create()) == NULL)
 134     {
 135       ERROR ("Target `set': failed to create a meta data for `%s'.", ci->key);
 136       return (-ENOMEM);
 137     }
 138   }
 139
 140   return (meta_data_add_string (*dest, key, string));
 141 } /* }}} int ts_config_add_meta */
 142
 143 static int ts_config_add_meta_delete (ts_key_list_t **dest, /* {{{ */
 144     const oconfig_item_t *ci)
 145 {
 146   ts_key_list_t *entry = NULL;
 147
 148   entry = calloc (1, sizeof (*entry));
 149   if (entry == NULL)
 150   {
 151     ERROR ("ts_config_add_meta_delete: calloc failed.");
 152     return (-ENOMEM);
 153   }
 154
 155   if (cf_util_get_string (ci, &entry->key) != 0)
 156   {
 157     ts_key_list_free (entry);
 158     return (-1);  /* An error has already been reported. */
 159   }
 160
 161   if (strlen (entry->key) == 0)
 162   {
 163     ERROR ("Target `set': The `%s' option does not accept empty string as "
 164         "first argument.", ci->key);
 165     ts_key_list_free (entry);
 166     return (-1);
 167   }
 168
 169   entry->next = *dest;
 170   *dest = entry;
 171
 172   return (0);
 173 } /* }}} int ts_config_add_meta_delete */
 174
 175 static void ts_subst (char *dest, size_t size, const char *string, /* {{{ */
 176     const value_list_t *vl)
 177 {
 178   char temp[DATA_MAX_NAME_LEN];
 179
 180   /* Initialize the field with the template. */
 181   sstrncpy (dest, string, size);
 182
 183   if (strchr (dest, '%') == NULL)
 184     return;
 185
 186 #define REPLACE_FIELD(t, v) \
 187   if (subst_string (temp, sizeof (temp), dest, t, v) != NULL) \
 188     sstrncpy (dest, temp, size);
 189   REPLACE_FIELD ("%{host}", vl->host);
 190   REPLACE_FIELD ("%{plugin}", vl->plugin);
 191   REPLACE_FIELD ("%{plugin_instance}", vl->plugin_instance);
 192   REPLACE_FIELD ("%{type}", vl->type);
 193   REPLACE_FIELD ("%{type_instance}", vl->type_instance);
 194
 195   if (vl->meta != NULL)
 196   {
 197     char **meta_toc;
 198     int meta_entries = meta_data_toc (vl->meta, &meta_toc);
 199     for (int i = 0; i < meta_entries; i++)
 200     {
 201       char meta_name[DATA_MAX_NAME_LEN];
 202       char *value_str;
 203       const char *key = meta_toc[i];
 204
 205       ssnprintf (meta_name, sizeof (meta_name), "%%{meta:%s}", key);
 206       if (meta_data_as_string (vl->meta, key, &value_str) != 0)
 207         continue;
 208
 209       REPLACE_FIELD (meta_name, value_str);
 210       sfree (value_str);
 211     }
 212
 213     strarray_free (meta_toc, (size_t) meta_entries);
 214   }
 215 } /* }}} int ts_subst */
 216
 217 static int ts_destroy (void **user_data) /* {{{ */
 218 {
 219   ts_data_t *data;
 220
 221   if (user_data == NULL)
 222     return (-EINVAL);
 223
 224   data = *user_data;
 225   if (data == NULL)
 226     return (0);
 227
 228   free (data->host);
 229   free (data->plugin);
 230   free (data->plugin_instance);
 231   /* free (data->type); */
 232   free (data->type_instance);
 233   meta_data_destroy(data->meta);
 234   ts_key_list_free (data->meta_delete);
 235   free (data);
 236
 237   return (0);
 238 } /* }}} int ts_destroy */
 239
 240 static int ts_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
 241 {
 242   ts_data_t *data;
 243   int status;
 244
 245   data = calloc (1, sizeof (*data));
 246   if (data == NULL)
 247   {
 248     ERROR ("ts_create: calloc failed.");
 249     return (-ENOMEM);
 250   }
 251
 252   data->host = NULL;
 253   data->plugin = NULL;
 254   data->plugin_instance = NULL;
 255   /* data->type = NULL; */
 256   data->type_instance = NULL;
 257   data->meta = NULL;
 258   data->meta_delete = NULL;
 259
 260   status = 0;
 261   for (int i = 0; i < ci->children_num; i++)
 262   {
 263     oconfig_item_t *child = ci->children + i;
 264
 265     if ((strcasecmp ("Host", child->key) == 0)
 266         || (strcasecmp ("Hostname", child->key) == 0))
 267       status = ts_config_add_string (&data->host, child,
 268           /* may be empty = */ 0);
 269     else if (strcasecmp ("Plugin", child->key) == 0)
 270       status = ts_config_add_string (&data->plugin, child,
 271           /* may be empty = */ 0);
 272     else if (strcasecmp ("PluginInstance", child->key) == 0)
 273       status = ts_config_add_string (&data->plugin_instance, child,
 274           /* may be empty = */ 1);
 275 #if 0
 276     else if (strcasecmp ("Type", child->key) == 0)
 277       status = ts_config_add_string (&data->type, child,
 278           /* may be empty = */ 0);
 279 #endif
 280     else if (strcasecmp ("TypeInstance", child->key) == 0)
 281       status = ts_config_add_string (&data->type_instance, child,
 282           /* may be empty = */ 1);
 283     else if (strcasecmp ("MetaData", child->key) == 0)
 284       status = ts_config_add_meta (&data->meta, child,
 285           /* may be empty = */ 1);
 286     else if (strcasecmp ("DeleteMetaData", child->key) == 0)
 287       status = ts_config_add_meta_delete (&data->meta_delete, child);
 288     else
 289     {
 290       ERROR ("Target `set': The `%s' configuration option is not understood "
 291           "and will be ignored.", child->key);
 292       status = 0;
 293     }
 294
 295     if (status != 0)
 296       break;
 297   }
 298
 299   /* Additional sanity-checking */
 300   while (status == 0)
 301   {
 302     if ((data->host == NULL)
 303         && (data->plugin == NULL)
 304         && (data->plugin_instance == NULL)
 305         /* && (data->type == NULL) */
 306         && (data->type_instance == NULL)
 307         && (data->meta == NULL)
 308         && (data->meta_delete == NULL))
 309     {
 310       ERROR ("Target `set': You need to set at least one of `Host', "
 311           "`Plugin', `PluginInstance', `TypeInstance', "
 312           "`MetaData', or `DeleteMetaData'.");
 313       status = -1;
 314     }
 315
 316     if (data->meta != NULL)
 317     {
 318       /* If data->meta_delete is NULL, this loop is a no-op. */
 319       for (ts_key_list_t *l=data->meta_delete; l != NULL; l = l->next)
 320       {
 321         if (meta_data_type (data->meta, l->key) != 0)
 322         {
 323           /* MetaData and DeleteMetaData for the same key. */
 324           ERROR ("Target `set': Can only have one of `MetaData' or "
 325               "`DeleteMetaData' for any given key.");
 326           status = -1;
 327         }
 328       }
 329     }
 330
 331     break;
 332   }
 333
 334   if (status != 0)
 335   {
 336     ts_destroy ((void *) &data);
 337     return (status);
 338   }
 339
 340   *user_data = data;
 341   return (0);
 342 } /* }}} int ts_create */
 343
 344 static int ts_invoke (const data_set_t *ds, value_list_t *vl, /* {{{ */
 345     notification_meta_t __attribute__((unused)) **meta, void **user_data)
 346 {
 347   ts_data_t *data;
 348   value_list_t orig;
 349   meta_data_t *new_meta = NULL;
 350
 351   if ((ds == NULL) || (vl == NULL) || (user_data == NULL))
 352     return (-EINVAL);
 353
 354   data = *user_data;
 355   if (data == NULL)
 356   {
 357     ERROR ("Target `set': Invoke: `data' is NULL.");
 358     return (-EINVAL);
 359   }
 360
 361   orig = *vl;
 362
 363   if (data->meta != NULL)
 364   {
 365     char temp[DATA_MAX_NAME_LEN*2];
 366     int meta_entries;
 367     char **meta_toc;
 368
 369     if ((new_meta = meta_data_create()) == NULL)
 370     {
 371       ERROR ("Target `set': failed to create replacement metadata.");
 372       return (-ENOMEM);
 373     }
 374
 375     meta_entries = meta_data_toc (data->meta, &meta_toc);
 376     for (int i = 0; i < meta_entries; i++)
 377     {
 378       const char *key = meta_toc[i];
 379       char *string;
 380       int status;
 381
 382       status = meta_data_get_string (data->meta, key, &string);
 383       if (status)
 384       {
 385         ERROR ("Target `set': Unable to get replacement metadata value `%s'.",
 386             key);
 387         strarray_free (meta_toc, (size_t) meta_entries);
 388         return (status);
 389       }
 390
 391       ts_subst (temp, sizeof (temp), string, &orig);
 392
 393       DEBUG ("target_set: ts_invoke: setting metadata value for key `%s': "
 394           "`%s'.", key, temp);
 395
 396       sfree (string);
 397
 398       status = meta_data_add_string (new_meta, key, temp);
 399       if (status)
 400       {
 401         ERROR ("Target `set': Unable to set metadata value `%s'.", key);
 402         strarray_free (meta_toc, (size_t) meta_entries);
 403         return (status);
 404       }
 405     }
 406
 407     strarray_free (meta_toc, (size_t) meta_entries);
 408   }
 409
 410 #define SUBST_FIELD(f) \
 411   if (data->f != NULL) { \
 412     ts_subst (vl->f, sizeof (vl->f), data->f, &orig); \
 413     DEBUG ("target_set: ts_invoke: setting "#f": `%s'.", vl->f); \
 414   }
 415   SUBST_FIELD (host);
 416   SUBST_FIELD (plugin);
 417   SUBST_FIELD (plugin_instance);
 418   /* SUBST_FIELD (type); */
 419   SUBST_FIELD (type_instance);
 420
 421   /* Need to merge the metadata in now, because of the shallow copy. */
 422   if (new_meta != NULL)
 423   {
 424     meta_data_clone_merge(&(vl->meta), new_meta);
 425     meta_data_destroy(new_meta);
 426   }
 427
 428   /* If data->meta_delete is NULL, this loop is a no-op. */
 429   for (ts_key_list_t *l=data->meta_delete; l != NULL; l = l->next)
 430   {
 431     DEBUG ("target_set: ts_invoke: deleting metadata value for key `%s'.",
 432         l->key);
 433     meta_data_delete(vl->meta, l->key);
 434   }
 435
 436   return (FC_TARGET_CONTINUE);
 437 } /* }}} int ts_invoke */
 438
 439 void module_register (void)
 440 {
 441         target_proc_t tproc = { 0 };
 442
 443         tproc.create  = ts_create;
 444         tproc.destroy = ts_destroy;
 445         tproc.invoke  = ts_invoke;
 446         fc_register_target ("set", tproc);
 447 } /* module_register */
 448
 449 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */
 450