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