src/memcachec.c

   1 /**
   2  * collectd - src/memcachec.c
   3  * Copyright (C) 2009       Doug MacEachern
   4  * Copyright (C) 2006-2009  Florian octo 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  * Authors:
  20  *   Doug MacEachern <Doug.MacEachern at hyperic.com>
  21  *   Florian octo Forster <octo at verplant.org>
  22  **/
  23
  24 #include "collectd.h"
  25 #include "common.h"
  26 #include "plugin.h"
  27 #include "configfile.h"
  28 #include "utils_match.h"
  29
  30 #include <libmemcached/memcached.h>
  31
  32 /*
  33  * Data types
  34  */
  35 struct web_match_s;
  36 typedef struct web_match_s web_match_t;
  37 struct web_match_s /* {{{ */
  38 {
  39   char *regex;
  40   char *exclude_regex;
  41   int dstype;
  42   char *type;
  43   char *instance;
  44
  45   cu_match_t *match;
  46
  47   web_match_t *next;
  48 }; /* }}} */
  49
  50 struct web_page_s;
  51 typedef struct web_page_s web_page_t;
  52 struct web_page_s /* {{{ */
  53 {
  54   char *instance;
  55
  56   char *server;
  57   char *key;
  58
  59   memcached_st *memc;
  60   char *buffer;
  61
  62   web_match_t *matches;
  63
  64   web_page_t *next;
  65 }; /* }}} */
  66
  67 /*
  68  * Global variables;
  69  */
  70 static web_page_t *pages_g = NULL;
  71
  72 /*
  73  * Private functions
  74  */
  75 static void cmc_web_match_free (web_match_t *wm) /* {{{ */
  76 {
  77   if (wm == NULL)
  78     return;
  79
  80   sfree (wm->regex);
  81   sfree (wm->type);
  82   sfree (wm->instance);
  83   match_destroy (wm->match);
  84   cmc_web_match_free (wm->next);
  85   sfree (wm);
  86 } /* }}} void cmc_web_match_free */
  87
  88 static void cmc_web_page_free (web_page_t *wp) /* {{{ */
  89 {
  90   if (wp == NULL)
  91     return;
  92
  93   if (wp->memc != NULL)
  94     memcached_free(wp->memc);
  95   wp->memc = NULL;
  96
  97   sfree (wp->instance);
  98   sfree (wp->server);
  99   sfree (wp->key);
 100   sfree (wp->buffer);
 101
 102   cmc_web_match_free (wp->matches);
 103   cmc_web_page_free (wp->next);
 104   sfree (wp);
 105 } /* }}} void cmc_web_page_free */
 106
 107 static int cmc_page_init_memc (web_page_t *wp) /* {{{ */
 108 {
 109   memcached_server_st *server;
 110
 111   wp->memc = memcached_create(NULL);
 112   if (wp->memc == NULL)
 113   {
 114     ERROR ("memcachec plugin: memcached_create failed.");
 115     return (-1);
 116   }
 117
 118   server = memcached_servers_parse (wp->server);
 119   memcached_server_push (wp->memc, server);
 120   memcached_server_list_free (server);
 121
 122   return (0);
 123 } /* }}} int cmc_page_init_memc */
 124
 125 static int cmc_config_add_string (const char *name, char **dest, /* {{{ */
 126     oconfig_item_t *ci)
 127 {
 128   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 129   {
 130     WARNING ("memcachec plugin: `%s' needs exactly one string argument.", name);
 131     return (-1);
 132   }
 133
 134   sfree (*dest);
 135   *dest = strdup (ci->values[0].value.string);
 136   if (*dest == NULL)
 137     return (-1);
 138
 139   return (0);
 140 } /* }}} int cmc_config_add_string */
 141
 142 static int cmc_config_add_match_dstype (int *dstype_ret, /* {{{ */
 143     oconfig_item_t *ci)
 144 {
 145   int dstype;
 146
 147   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 148   {
 149     WARNING ("memcachec plugin: `DSType' needs exactly one string argument.");
 150     return (-1);
 151   }
 152
 153   if (strncasecmp ("Gauge", ci->values[0].value.string,
 154         strlen ("Gauge")) == 0)
 155   {
 156     dstype = UTILS_MATCH_DS_TYPE_GAUGE;
 157     if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
 158       dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
 159     else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
 160       dstype |= UTILS_MATCH_CF_GAUGE_MIN;
 161     else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
 162       dstype |= UTILS_MATCH_CF_GAUGE_MAX;
 163     else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
 164       dstype |= UTILS_MATCH_CF_GAUGE_LAST;
 165     else
 166       dstype = 0;
 167   }
 168   else if (strncasecmp ("Counter", ci->values[0].value.string,
 169         strlen ("Counter")) == 0)
 170   {
 171     dstype = UTILS_MATCH_DS_TYPE_COUNTER;
 172     if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
 173       dstype |= UTILS_MATCH_CF_COUNTER_SET;
 174     else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
 175       dstype |= UTILS_MATCH_CF_COUNTER_ADD;
 176     else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
 177       dstype |= UTILS_MATCH_CF_COUNTER_INC;
 178     else
 179       dstype = 0;
 180   }
 181   else
 182   {
 183     dstype = 0;
 184   }
 185
 186   if (dstype == 0)
 187   {
 188     WARNING ("memcachec plugin: `%s' is not a valid argument to `DSType'.",
 189         ci->values[0].value.string);
 190     return (-1);
 191   }
 192
 193   *dstype_ret = dstype;
 194   return (0);
 195 } /* }}} int cmc_config_add_match_dstype */
 196
 197 static int cmc_config_add_match (web_page_t *page, /* {{{ */
 198     oconfig_item_t *ci)
 199 {
 200   web_match_t *match;
 201   int status;
 202   int i;
 203
 204   if (ci->values_num != 0)
 205   {
 206     WARNING ("memcachec plugin: Ignoring arguments for the `Match' block.");
 207   }
 208
 209   match = (web_match_t *) malloc (sizeof (*match));
 210   if (match == NULL)
 211   {
 212     ERROR ("memcachec plugin: malloc failed.");
 213     return (-1);
 214   }
 215   memset (match, 0, sizeof (*match));
 216
 217   status = 0;
 218   for (i = 0; i < ci->children_num; i++)
 219   {
 220     oconfig_item_t *child = ci->children + i;
 221
 222     if (strcasecmp ("Regex", child->key) == 0)
 223       status = cmc_config_add_string ("Regex", &match->regex, child);
 224     else if (strcasecmp ("ExcludeRegex", child->key) == 0)
 225       status = cmc_config_add_string ("ExcludeRegex", &match->exclude_regex, child);
 226     else if (strcasecmp ("DSType", child->key) == 0)
 227       status = cmc_config_add_match_dstype (&match->dstype, child);
 228     else if (strcasecmp ("Type", child->key) == 0)
 229       status = cmc_config_add_string ("Type", &match->type, child);
 230     else if (strcasecmp ("Instance", child->key) == 0)
 231       status = cmc_config_add_string ("Instance", &match->instance, child);
 232     else
 233     {
 234       WARNING ("memcachec plugin: Option `%s' not allowed here.", child->key);
 235       status = -1;
 236     }
 237
 238     if (status != 0)
 239       break;
 240   } /* for (i = 0; i < ci->children_num; i++) */
 241
 242   while (status == 0)
 243   {
 244     if (match->regex == NULL)
 245     {
 246       WARNING ("memcachec plugin: `Regex' missing in `Match' block.");
 247       status = -1;
 248     }
 249
 250     if (match->type == NULL)
 251     {
 252       WARNING ("memcachec plugin: `Type' missing in `Match' block.");
 253       status = -1;
 254     }
 255
 256     if (match->dstype == 0)
 257     {
 258       WARNING ("memcachec plugin: `DSType' missing in `Match' block.");
 259       status = -1;
 260     }
 261
 262     break;
 263   } /* while (status == 0) */
 264
 265   if (status != 0)
 266     return (status);
 267
 268   match->match = match_create_simple (match->regex, match->exclude_regex,
 269       match->dstype);
 270   if (match->match == NULL)
 271   {
 272     ERROR ("memcachec plugin: tail_match_add_match_simple failed.");
 273     cmc_web_match_free (match);
 274     return (-1);
 275   }
 276   else
 277   {
 278     web_match_t *prev;
 279
 280     prev = page->matches;
 281     while ((prev != NULL) && (prev->next != NULL))
 282       prev = prev->next;
 283
 284     if (prev == NULL)
 285       page->matches = match;
 286     else
 287       prev->next = match;
 288   }
 289
 290   return (0);
 291 } /* }}} int cmc_config_add_match */
 292
 293 static int cmc_config_add_page (oconfig_item_t *ci) /* {{{ */
 294 {
 295   web_page_t *page;
 296   int status;
 297   int i;
 298
 299   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 300   {
 301     WARNING ("memcachec plugin: `Page' blocks need exactly one string argument.");
 302     return (-1);
 303   }
 304
 305   page = (web_page_t *) malloc (sizeof (*page));
 306   if (page == NULL)
 307   {
 308     ERROR ("memcachec plugin: malloc failed.");
 309     return (-1);
 310   }
 311   memset (page, 0, sizeof (*page));
 312   page->server = NULL;
 313   page->key = NULL;
 314
 315   page->instance = strdup (ci->values[0].value.string);
 316   if (page->instance == NULL)
 317   {
 318     ERROR ("memcachec plugin: strdup failed.");
 319     sfree (page);
 320     return (-1);
 321   }
 322
 323   /* Process all children */
 324   status = 0;
 325   for (i = 0; i < ci->children_num; i++)
 326   {
 327     oconfig_item_t *child = ci->children + i;
 328
 329     if (strcasecmp ("Server", child->key) == 0)
 330       status = cmc_config_add_string ("Server", &page->server, child);
 331     if (strcasecmp ("Key", child->key) == 0)
 332       status = cmc_config_add_string ("Key", &page->key, child);
 333     else if (strcasecmp ("Match", child->key) == 0)
 334       /* Be liberal with failing matches => don't set `status'. */
 335       cmc_config_add_match (page, child);
 336     else
 337     {
 338       WARNING ("memcachec plugin: Option `%s' not allowed here.", child->key);
 339       status = -1;
 340     }
 341
 342     if (status != 0)
 343       break;
 344   } /* for (i = 0; i < ci->children_num; i++) */
 345
 346   /* Additionial sanity checks and libmemcached initialization. */
 347   while (status == 0)
 348   {
 349     if (page->server == NULL)
 350     {
 351       WARNING ("memcachec plugin: `Server' missing in `Page' block.");
 352       status = -1;
 353     }
 354
 355     if (page->key == NULL)
 356     {
 357       WARNING ("memcachec plugin: `Key' missing in `Page' block.");
 358       status = -1;
 359     }
 360
 361     if (page->matches == NULL)
 362     {
 363       assert (page->instance != NULL);
 364       WARNING ("memcachec plugin: No (valid) `Match' block "
 365           "within `Page' block `%s'.", page->instance);
 366       status = -1;
 367     }
 368
 369     if (status == 0)
 370       status = cmc_page_init_memc (page);
 371
 372     break;
 373   } /* while (status == 0) */
 374
 375   if (status != 0)
 376   {
 377     cmc_web_page_free (page);
 378     return (status);
 379   }
 380
 381   /* Add the new page to the linked list */
 382   if (pages_g == NULL)
 383     pages_g = page;
 384   else
 385   {
 386     web_page_t *prev;
 387
 388     prev = pages_g;
 389     while ((prev != NULL) && (prev->next != NULL))
 390       prev = prev->next;
 391     prev->next = page;
 392   }
 393
 394   return (0);
 395 } /* }}} int cmc_config_add_page */
 396
 397 static int cmc_config (oconfig_item_t *ci) /* {{{ */
 398 {
 399   int success;
 400   int errors;
 401   int status;
 402   int i;
 403
 404   success = 0;
 405   errors = 0;
 406
 407   for (i = 0; i < ci->children_num; i++)
 408   {
 409     oconfig_item_t *child = ci->children + i;
 410
 411     if (strcasecmp ("Page", child->key) == 0)
 412     {
 413       status = cmc_config_add_page (child);
 414       if (status == 0)
 415         success++;
 416       else
 417         errors++;
 418     }
 419     else
 420     {
 421       WARNING ("memcachec plugin: Option `%s' not allowed here.", child->key);
 422       errors++;
 423     }
 424   }
 425
 426   if ((success == 0) && (errors > 0))
 427   {
 428     ERROR ("memcachec plugin: All statements failed.");
 429     return (-1);
 430   }
 431
 432   return (0);
 433 } /* }}} int cmc_config */
 434
 435 static int cmc_init (void) /* {{{ */
 436 {
 437   if (pages_g == NULL)
 438   {
 439     INFO ("memcachec plugin: No pages have been defined.");
 440     return (-1);
 441   }
 442   return (0);
 443 } /* }}} int cmc_init */
 444
 445 static void cmc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
 446     const cu_match_value_t *mv)
 447 {
 448   value_t values[1];
 449   value_list_t vl = VALUE_LIST_INIT;
 450
 451   values[0] = mv->value;
 452
 453   vl.values = values;
 454   vl.values_len = 1;
 455   vl.time = time (NULL);
 456   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 457   sstrncpy (vl.plugin, "memcachec", sizeof (vl.plugin));
 458   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
 459   sstrncpy (vl.type, wm->type, sizeof (vl.type));
 460   sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
 461
 462   plugin_dispatch_values (&vl);
 463 } /* }}} void cmc_submit */
 464
 465 static int cmc_read_page (web_page_t *wp) /* {{{ */
 466 {
 467   web_match_t *wm;
 468   memcached_return rc;
 469   size_t string_length;
 470   uint32_t flags;
 471   int status;
 472
 473   if (wp->memc == NULL)
 474     return (-1);
 475
 476   wp->buffer = memcached_get (wp->memc, wp->key, strlen (wp->key),
 477                               &string_length, &flags, &rc);
 478   if (rc != MEMCACHED_SUCCESS)
 479   {
 480     ERROR ("memcachec plugin: memcached_get failed: %s",
 481         memcached_strerror (wp->memc, rc));
 482     return (-1);
 483   }
 484
 485   for (wm = wp->matches; wm != NULL; wm = wm->next)
 486   {
 487     cu_match_value_t *mv;
 488
 489     status = match_apply (wm->match, wp->buffer);
 490     if (status != 0)
 491     {
 492       WARNING ("memcachec plugin: match_apply failed.");
 493       continue;
 494     }
 495
 496     mv = match_get_user_data (wm->match);
 497     if (mv == NULL)
 498     {
 499       WARNING ("memcachec plugin: match_get_user_data returned NULL.");
 500       continue;
 501     }
 502
 503     cmc_submit (wp, wm, mv);
 504   } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
 505
 506   sfree (wp->buffer);
 507
 508   return (0);
 509 } /* }}} int cmc_read_page */
 510
 511 static int cmc_read (void) /* {{{ */
 512 {
 513   web_page_t *wp;
 514
 515   for (wp = pages_g; wp != NULL; wp = wp->next)
 516     cmc_read_page (wp);
 517
 518   return (0);
 519 } /* }}} int cmc_read */
 520
 521 static int cmc_shutdown (void) /* {{{ */
 522 {
 523   cmc_web_page_free (pages_g);
 524   pages_g = NULL;
 525
 526   return (0);
 527 } /* }}} int cmc_shutdown */
 528
 529 void module_register (void)
 530 {
 531   plugin_register_complex_config ("memcachec", cmc_config);
 532   plugin_register_init ("memcachec", cmc_init);
 533   plugin_register_read ("memcachec", cmc_read);
 534   plugin_register_shutdown ("memcachec", cmc_shutdown);
 535 } /* void module_register */
 536
 537 /* vim: set sw=2 sts=2 et fdm=marker : */