src/memcached.c

   1 /**
   2  * collectd - src/memcached.c, based on src/hddtemp.c
   3  * Copyright (C) 2007       Antony Dovgal
   4  * Copyright (C) 2007-2012  Florian Forster
   5  * Copyright (C) 2009       Doug MacEachern
   6  * Copyright (C) 2009       Franck Lombardi
   7  * Copyright (C) 2012       Nicolas Szalay
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; either version 2 of the License, or (at your
  12  * option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  22  *
  23  * Authors:
  24  *   Antony Dovgal <tony at daylessday dot org>
  25  *   Florian octo Forster <octo at collectd.org>
  26  *   Doug MacEachern <dougm at hyperic.com>
  27  *   Franck Lombardi
  28  *   Nicolas Szalay
  29  **/
  30
  31 #include "collectd.h"
  32 #include "common.h"
  33 #include "plugin.h"
  34 #include "configfile.h"
  35
  36 #include <netdb.h>
  37 #include <sys/socket.h>
  38 #include <sys/un.h>
  39 #include <netinet/in.h>
  40 #include <netinet/tcp.h>
  41
  42 #define MEMCACHED_DEF_HOST "127.0.0.1"
  43 #define MEMCACHED_DEF_PORT "11211"
  44
  45 struct memcached_s
  46 {
  47   char *name;
  48   char *socket;
  49   char *host;
  50   char *port;
  51 };
  52 typedef struct memcached_s memcached_t;
  53
  54 static _Bool memcached_have_instances = 0;
  55
  56 static void memcached_free (memcached_t *st)
  57 {
  58   if (st == NULL)
  59     return;
  60
  61   sfree (st->name);
  62   sfree (st->socket);
  63   sfree (st->host);
  64   sfree (st->port);
  65 }
  66
  67 static int memcached_connect_unix (memcached_t *st)
  68 {
  69   struct sockaddr_un serv_addr;
  70   int fd;
  71
  72   memset (&serv_addr, 0, sizeof (serv_addr));
  73   serv_addr.sun_family = AF_UNIX;
  74   sstrncpy (serv_addr.sun_path, st->socket,
  75       sizeof (serv_addr.sun_path));
  76
  77   /* create our socket descriptor */
  78   fd = socket (AF_UNIX, SOCK_STREAM, 0);
  79   if (fd < 0)
  80   {
  81     char errbuf[1024];
  82     ERROR ("memcached: memcached_connect_unix: socket(2) failed: %s",
  83         sstrerror (errno, errbuf, sizeof (errbuf)));
  84     return (-1);
  85   }
  86
  87   return (fd);
  88 } /* int memcached_connect_unix */
  89
  90 static int memcached_connect_inet (memcached_t *st)
  91 {
  92   char *host;
  93   char *port;
  94
  95   struct addrinfo  ai_hints;
  96   struct addrinfo *ai_list, *ai_ptr;
  97   int status;
  98   int fd = -1;
  99
 100   memset (&ai_hints, 0, sizeof (ai_hints));
 101   ai_hints.ai_flags    = 0;
 102 #ifdef AI_ADDRCONFIG
 103   ai_hints.ai_flags   |= AI_ADDRCONFIG;
 104 #endif
 105   ai_hints.ai_family   = AF_UNSPEC;
 106   ai_hints.ai_socktype = SOCK_STREAM;
 107   ai_hints.ai_protocol = 0;
 108
 109   host = (st->host != NULL) ? st->host : MEMCACHED_DEF_HOST;
 110   port = (st->port != NULL) ? st->port : MEMCACHED_DEF_PORT;
 111
 112   ai_list = NULL;
 113   status = getaddrinfo (host, port, &ai_hints, &ai_list);
 114   if (status != 0)
 115   {
 116     char errbuf[1024];
 117     ERROR ("memcached: memcached_connect_inet: getaddrinfo(%s,%s) failed: %s",
 118         host, port,
 119         (status == EAI_SYSTEM)
 120         ? sstrerror (errno, errbuf, sizeof (errbuf))
 121         : gai_strerror (status));
 122     return (-1);
 123   }
 124
 125   for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 126   {
 127     /* create our socket descriptor */
 128     fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
 129     if (fd < 0)
 130     {
 131       char errbuf[1024];
 132       WARNING ("memcached: memcached_connect_inet: socket(2) failed: %s",
 133           sstrerror (errno, errbuf, sizeof (errbuf)));
 134       continue;
 135     }
 136
 137     /* connect to the memcached daemon */
 138     status = (int) connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 139     if (status != 0)
 140     {
 141       shutdown (fd, SHUT_RDWR);
 142       close (fd);
 143       fd = -1;
 144       continue;
 145     }
 146
 147     /* A socket could be opened and connecting succeeded. We're done. */
 148     break;
 149   }
 150
 151   freeaddrinfo (ai_list);
 152   return (fd);
 153 } /* int memcached_connect_inet */
 154
 155 static int memcached_connect (memcached_t *st)
 156 {
 157   if (st->socket != NULL)
 158     return (memcached_connect_unix (st));
 159   else
 160     return (memcached_connect_inet (st));
 161 }
 162
 163 static int memcached_query_daemon (char *buffer, size_t buffer_size, memcached_t *st)
 164 {
 165   int fd = -1;
 166   int status;
 167   size_t buffer_fill;
 168
 169   fd = memcached_connect (st);
 170   if (fd < 0) {
 171     ERROR ("memcached: Could not connect to daemon.");
 172     return -1;
 173   }
 174
 175   status = (int) swrite (fd, "stats\r\n", strlen ("stats\r\n"));
 176   if (status != 0)
 177   {
 178     char errbuf[1024];
 179     ERROR ("memcached plugin: write(2) failed: %s",
 180         sstrerror (errno, errbuf, sizeof (errbuf)));
 181     shutdown(fd, SHUT_RDWR);
 182     close (fd);
 183     return (-1);
 184   }
 185
 186   /* receive data from the memcached daemon */
 187   memset (buffer, 0, buffer_size);
 188
 189   buffer_fill = 0;
 190   while ((status = (int) recv (fd, buffer + buffer_fill,
 191           buffer_size - buffer_fill, /* flags = */ 0)) != 0)
 192   {
 193     char const end_token[5] = {'E', 'N', 'D', '\r', '\n'};
 194     if (status < 0)
 195     {
 196       char errbuf[1024];
 197
 198       if ((errno == EAGAIN) || (errno == EINTR))
 199           continue;
 200
 201       ERROR ("memcached: Error reading from socket: %s",
 202           sstrerror (errno, errbuf, sizeof (errbuf)));
 203       shutdown(fd, SHUT_RDWR);
 204       close (fd);
 205       return (-1);
 206     }
 207
 208     buffer_fill += (size_t) status;
 209     if (buffer_fill > buffer_size)
 210     {
 211       buffer_fill = buffer_size;
 212       WARNING ("memcached plugin: Message was truncated.");
 213       break;
 214     }
 215
 216     /* If buffer ends in end_token, we have all the data. */
 217     if (memcmp (buffer + buffer_fill - sizeof (end_token),
 218           end_token, sizeof (end_token)) == 0)
 219       break;
 220   } /* while (recv) */
 221
 222   status = 0;
 223   if (buffer_fill == 0)
 224   {
 225     WARNING ("memcached plugin: No data returned by memcached.");
 226     status = -1;
 227   }
 228
 229   shutdown(fd, SHUT_RDWR);
 230   close(fd);
 231   return (status);
 232 } /* int memcached_query_daemon */
 233
 234 static void memcached_init_vl (value_list_t *vl, memcached_t const *st)
 235 {
 236   sstrncpy (vl->plugin, "memcached", sizeof (vl->plugin));
 237   if (strcmp (st->name, "__legacy__") == 0) /* legacy mode */
 238   {
 239     sstrncpy (vl->host, hostname_g, sizeof (vl->host));
 240   }
 241   else
 242   {
 243     if (st->socket != NULL)
 244       sstrncpy (vl->host, hostname_g, sizeof (vl->host));
 245     else
 246       sstrncpy (vl->host,
 247           (st->host != NULL) ? st->host : MEMCACHED_DEF_HOST,
 248           sizeof (vl->host));
 249     sstrncpy (vl->plugin_instance, st->name, sizeof (vl->plugin_instance));
 250   }
 251 }
 252
 253 static void submit_derive (const char *type, const char *type_inst,
 254     derive_t value, memcached_t *st)
 255 {
 256   value_t values[1];
 257   value_list_t vl = VALUE_LIST_INIT;
 258   memcached_init_vl (&vl, st);
 259
 260   values[0].derive = value;
 261
 262   vl.values = values;
 263   vl.values_len = 1;
 264   sstrncpy (vl.type, type, sizeof (vl.type));
 265   if (type_inst != NULL)
 266     sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 267
 268   plugin_dispatch_values (&vl);
 269 }
 270
 271 static void submit_derive2 (const char *type, const char *type_inst,
 272     derive_t value0, derive_t value1, memcached_t *st)
 273 {
 274   value_t values[2];
 275   value_list_t vl = VALUE_LIST_INIT;
 276   memcached_init_vl (&vl, st);
 277
 278   values[0].derive = value0;
 279   values[1].derive = value1;
 280
 281   vl.values = values;
 282   vl.values_len = 2;
 283   sstrncpy (vl.type, type, sizeof (vl.type));
 284   if (type_inst != NULL)
 285     sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 286
 287   plugin_dispatch_values (&vl);
 288 }
 289
 290 static void submit_gauge (const char *type, const char *type_inst,
 291     gauge_t value, memcached_t *st)
 292 {
 293   value_t values[1];
 294   value_list_t vl = VALUE_LIST_INIT;
 295   memcached_init_vl (&vl, st);
 296
 297   values[0].gauge = value;
 298
 299   vl.values = values;
 300   vl.values_len = 1;
 301   sstrncpy (vl.type, type, sizeof (vl.type));
 302   if (type_inst != NULL)
 303     sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 304
 305   plugin_dispatch_values (&vl);
 306 }
 307
 308 static void submit_gauge2 (const char *type, const char *type_inst,
 309     gauge_t value0, gauge_t value1, memcached_t *st)
 310 {
 311   value_t values[2];
 312   value_list_t vl = VALUE_LIST_INIT;
 313   memcached_init_vl (&vl, st);
 314
 315   values[0].gauge = value0;
 316   values[1].gauge = value1;
 317
 318   vl.values = values;
 319   vl.values_len = 2;
 320   sstrncpy (vl.type, type, sizeof (vl.type));
 321   if (type_inst != NULL)
 322     sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 323
 324   plugin_dispatch_values (&vl);
 325 }
 326
 327 static int memcached_read (user_data_t *user_data)
 328 {
 329   char buf[4096];
 330   char *fields[3];
 331   char *ptr;
 332   char *line;
 333   char *saveptr;
 334   int fields_num;
 335
 336   gauge_t bytes_used = NAN;
 337   gauge_t bytes_total = NAN;
 338   gauge_t hits = NAN;
 339   gauge_t gets = NAN;
 340   derive_t rusage_user = 0;
 341   derive_t rusage_syst = 0;
 342   derive_t octets_rx = 0;
 343   derive_t octets_tx = 0;
 344
 345   memcached_t *st;
 346   st = user_data->data;
 347
 348   /* get data from daemon */
 349   if (memcached_query_daemon (buf, sizeof (buf), st) < 0) {
 350     return -1;
 351   }
 352
 353 #define FIELD_IS(cnst) \
 354   (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
 355
 356   ptr = buf;
 357   saveptr = NULL;
 358   while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
 359   {
 360     int name_len;
 361
 362     ptr = NULL;
 363
 364     fields_num = strsplit(line, fields, 3);
 365     if (fields_num != 3)
 366       continue;
 367
 368     name_len = strlen(fields[1]);
 369     if (name_len == 0)
 370       continue;
 371
 372     /*
 373      * For an explanation on these fields please refer to
 374      * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
 375      */
 376
 377     /*
 378      * CPU time consumed by the memcached process
 379      */
 380     if (FIELD_IS ("rusage_user"))
 381     {
 382       rusage_user = atoll (fields[2]);
 383     }
 384     else if (FIELD_IS ("rusage_system"))
 385     {
 386       rusage_syst = atoll(fields[2]);
 387     }
 388
 389     /*
 390      * Number of threads of this instance
 391      */
 392     else if (FIELD_IS ("threads"))
 393     {
 394       submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]), st);
 395     }
 396
 397     /*
 398      * Number of items stored
 399      */
 400     else if (FIELD_IS ("curr_items"))
 401     {
 402       submit_gauge ("memcached_items", "current", atof (fields[2]), st);
 403     }
 404
 405     /*
 406      * Number of bytes used and available (total - used)
 407      */
 408     else if (FIELD_IS ("bytes"))
 409     {
 410       bytes_used = atof (fields[2]);
 411     }
 412     else if (FIELD_IS ("limit_maxbytes"))
 413     {
 414       bytes_total = atof(fields[2]);
 415     }
 416
 417     /*
 418      * Connections
 419      */
 420     else if (FIELD_IS ("curr_connections"))
 421     {
 422       submit_gauge ("memcached_connections", "current", atof (fields[2]), st);
 423     }
 424
 425     /*
 426      * Commands
 427      */
 428     else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
 429     {
 430       const char *name = fields[1] + 4;
 431       submit_derive ("memcached_command", name, atoll (fields[2]), st);
 432       if (strcmp (name, "get") == 0)
 433         gets = atof (fields[2]);
 434     }
 435
 436     /*
 437      * Operations on the cache, i. e. cache hits, cache misses and evictions of items
 438      */
 439     else if (FIELD_IS ("get_hits"))
 440     {
 441       submit_derive ("memcached_ops", "hits", atoll (fields[2]), st);
 442       hits = atof (fields[2]);
 443     }
 444     else if (FIELD_IS ("get_misses"))
 445     {
 446       submit_derive ("memcached_ops", "misses", atoll (fields[2]), st);
 447     }
 448     else if (FIELD_IS ("evictions"))
 449     {
 450       submit_derive ("memcached_ops", "evictions", atoll (fields[2]), st);
 451     }
 452
 453     /*
 454      * Network traffic
 455      */
 456     else if (FIELD_IS ("bytes_read"))
 457     {
 458       octets_rx = atoll (fields[2]);
 459     }
 460     else if (FIELD_IS ("bytes_written"))
 461     {
 462       octets_tx = atoll (fields[2]);
 463     }
 464   } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
 465
 466   if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
 467     submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used, st);
 468
 469   if ((rusage_user != 0) || (rusage_syst != 0))
 470     submit_derive2 ("ps_cputime", NULL, rusage_user, rusage_syst, st);
 471
 472   if ((octets_rx != 0) || (octets_tx != 0))
 473     submit_derive2 ("memcached_octets", NULL, octets_rx, octets_tx, st);
 474
 475   if (!isnan (gets) && !isnan (hits))
 476   {
 477     gauge_t rate = NAN;
 478
 479     if (gets != 0.0)
 480       rate = 100.0 * hits / gets;
 481
 482     submit_gauge ("percent", "hitratio", rate, st);
 483   }
 484
 485   return 0;
 486 } /* int memcached_read */
 487
 488 static int memcached_add_read_callback (memcached_t *st)
 489 {
 490   user_data_t ud;
 491   char callback_name[3*DATA_MAX_NAME_LEN];
 492   int status;
 493
 494   memset (&ud, 0, sizeof (ud));
 495   ud.data = st;
 496   ud.free_func = (void *) memcached_free;
 497
 498   assert (st->name != NULL);
 499   ssnprintf (callback_name, sizeof (callback_name), "memcached/%s", st->name);
 500
 501   status = plugin_register_complex_read (/* group = */ "memcached",
 502       /* name      = */ callback_name,
 503       /* callback  = */ memcached_read,
 504       /* interval  = */ NULL,
 505       /* user_data = */ &ud);
 506   return (status);
 507 } /* int memcached_add_read_callback */
 508
 509 /* Configuration handling functiions
 510  * <Plugin memcached>
 511  *   <Instance "instance_name">
 512  *     Host foo.zomg.com
 513  *     Port "1234"
 514  *   </Instance>
 515  * </Plugin>
 516  */
 517 static int config_add_instance(oconfig_item_t *ci)
 518 {
 519   memcached_t *st;
 520   int i;
 521   int status = 0;
 522
 523   /* Disable automatic generation of default instance in the init callback. */
 524   memcached_have_instances = 1;
 525
 526   st = malloc (sizeof (*st));
 527   if (st == NULL)
 528   {
 529     ERROR ("memcached plugin: malloc failed.");
 530     return (-1);
 531   }
 532
 533   memset (st, 0, sizeof (*st));
 534   st->name = NULL;
 535   st->socket = NULL;
 536   st->host = NULL;
 537   st->port = NULL;
 538
 539   if (strcasecmp (ci->key, "Plugin") == 0) /* default instance */
 540     st->name = sstrdup ("__legacy__");
 541   else /* <Instance /> block */
 542     status = cf_util_get_string (ci, &st->name);
 543   if (status != 0)
 544   {
 545     sfree (st);
 546     return (status);
 547   }
 548   assert (st->name != NULL);
 549
 550   for (i = 0; i < ci->children_num; i++)
 551   {
 552     oconfig_item_t *child = ci->children + i;
 553
 554     if (strcasecmp ("Socket", child->key) == 0)
 555       status = cf_util_get_string (child, &st->socket);
 556     else if (strcasecmp ("Host", child->key) == 0)
 557       status = cf_util_get_string (child, &st->host);
 558     else if (strcasecmp ("Port", child->key) == 0)
 559       status = cf_util_get_service (child, &st->port);
 560     else
 561     {
 562       WARNING ("memcached plugin: Option `%s' not allowed here.",
 563           child->key);
 564       status = -1;
 565     }
 566
 567     if (status != 0)
 568       break;
 569   }
 570
 571   if (status == 0)
 572     status = memcached_add_read_callback (st);
 573
 574   if (status != 0)
 575   {
 576     memcached_free(st);
 577     return (-1);
 578   }
 579
 580   return (0);
 581 }
 582
 583 static int memcached_config (oconfig_item_t *ci)
 584 {
 585   int status = 0;
 586   _Bool have_instance_block = 0;
 587   int i;
 588
 589   for (i = 0; i < ci->children_num; i++)
 590   {
 591     oconfig_item_t *child = ci->children + i;
 592
 593     if (strcasecmp ("Instance", child->key) == 0)
 594     {
 595       config_add_instance (child);
 596       have_instance_block = 1;
 597     }
 598     else if (!have_instance_block)
 599     {
 600       /* Non-instance option: Assume legacy configuration (without <Instance />
 601        * blocks) and call config_add_instance() with the <Plugin /> block. */
 602       return (config_add_instance (ci));
 603     }
 604     else
 605       WARNING ("memcached plugin: The configuration option "
 606           "\"%s\" is not allowed here. Did you "
 607           "forget to add an <Instance /> block "
 608           "around the configuration?",
 609           child->key);
 610   } /* for (ci->children) */
 611
 612   return (status);
 613 }
 614
 615 static int memcached_init (void)
 616 {
 617   memcached_t *st;
 618   int status;
 619
 620   if (memcached_have_instances)
 621     return (0);
 622
 623   /* No instances were configured, lets start a default instance. */
 624   st = malloc (sizeof (*st));
 625   if (st == NULL)
 626     return (ENOMEM);
 627   memset (st, 0, sizeof (*st));
 628   st->name = sstrdup ("__legacy__");
 629   st->socket = NULL;
 630   st->host = NULL;
 631   st->port = NULL;
 632
 633   status = memcached_add_read_callback (st);
 634   if (status == 0)
 635     memcached_have_instances = 1;
 636   else
 637     memcached_free (st);
 638
 639   return (status);
 640 } /* int memcached_init */
 641
 642 void module_register (void)
 643 {
 644   plugin_register_complex_config ("memcached", memcached_config);
 645   plugin_register_init ("memcached", memcached_init);
 646 }