src/memcached.c

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