src/memcached.c

   1 /**
   2  * collectd - src/memcached.c, based on src/hddtemp.c
   3  * Copyright (C) 2007  Antony Dovgal
   4  * Copyright (C) 2005,2006  Vincent Stehlé
   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; either version 2 of the License, or (at your
   9  * option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  *
  20  * Authors:
  21  *   Antony Dovgal <tony at daylessday dot org>
  22  *   Vincent Stehlé <vincent.stehle at free.fr>
  23  *   Florian octo Forster <octo at verplant.org>
  24  **/
  25
  26 #include "collectd.h"
  27 #include "common.h"
  28 #include "plugin.h"
  29 #include "configfile.h"
  30
  31 # include <poll.h>
  32 # include <netdb.h>
  33 # include <sys/socket.h>
  34 # include <netinet/in.h>
  35 # include <netinet/tcp.h>
  36
  37 #define MEMCACHED_DEF_HOST "127.0.0.1"
  38 #define MEMCACHED_DEF_PORT "11211"
  39
  40 #define MEMCACHED_RETRY_COUNT 100
  41
  42 static const char *config_keys[] =
  43 {
  44         "Host",
  45         "Port"
  46 };
  47 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  48
  49 static char *memcached_host = NULL;
  50 static char memcached_port[16];
  51
  52 static int memcached_query_daemon (char *buffer, int buffer_size) /* {{{ */
  53 {
  54         int fd;
  55         ssize_t status;
  56         int buffer_fill;
  57
  58         const char *host;
  59         const char *port;
  60
  61         struct addrinfo  ai_hints;
  62         struct addrinfo *ai_list, *ai_ptr;
  63         int              ai_return, i = 0;
  64
  65         memset (&ai_hints, '\0', sizeof (ai_hints));
  66         ai_hints.ai_flags    = 0;
  67 #ifdef AI_ADDRCONFIG
  68 /*      ai_hints.ai_flags   |= AI_ADDRCONFIG; */
  69 #endif
  70         ai_hints.ai_family   = AF_INET;
  71         ai_hints.ai_socktype = SOCK_STREAM;
  72         ai_hints.ai_protocol = 0;
  73
  74         host = memcached_host;
  75         if (host == NULL) {
  76                 host = MEMCACHED_DEF_HOST;
  77         }
  78
  79         port = memcached_port;
  80         if (strlen (port) == 0) {
  81                 port = MEMCACHED_DEF_PORT;
  82         }
  83
  84         if ((ai_return = getaddrinfo (host, port, NULL, &ai_list)) != 0) {
  85                 char errbuf[1024];
  86                 ERROR ("memcached: getaddrinfo (%s, %s): %s",
  87                                 host, port,
  88                                 (ai_return == EAI_SYSTEM)
  89                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
  90                                 : gai_strerror (ai_return));
  91                 return -1;
  92         }
  93
  94         fd = -1;
  95         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) {
  96                 /* create our socket descriptor */
  97                 if ((fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol)) < 0) {
  98                         char errbuf[1024];
  99                         ERROR ("memcached: socket: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
 100                         continue;
 101                 }
 102
 103                 /* connect to the memcached daemon */
 104                 if (connect (fd, (struct sockaddr *) ai_ptr->ai_addr, ai_ptr->ai_addrlen)) {
 105                         shutdown(fd, SHUT_RDWR);
 106                         close(fd);
 107                         fd = -1;
 108                         continue;
 109                 }
 110
 111                 /* A socket could be opened and connecting succeeded. We're
 112                  * done. */
 113                 break;
 114         }
 115
 116         freeaddrinfo (ai_list);
 117
 118         if (fd < 0) {
 119                 ERROR ("memcached: Could not connect to daemon.");
 120                 return -1;
 121         }
 122
 123         if (send(fd, "stats\r\n", sizeof("stats\r\n") - 1, MSG_DONTWAIT) != (sizeof("stats\r\n") - 1)) {
 124                 ERROR ("memcached: Could not send command to the memcached daemon.");
 125                 return -1;
 126         }
 127
 128         {
 129                 struct pollfd p;
 130                 int n;
 131
 132                 p.fd = fd;
 133                 p.events = POLLIN|POLLERR|POLLHUP;
 134                 p.revents = 0;
 135
 136                 n = poll(&p, 1, 3);
 137
 138                 if (n <= 0) {
 139                         ERROR ("memcached: poll() failed or timed out");
 140                         return -1;
 141                 }
 142         }
 143
 144         /* receive data from the memcached daemon */
 145         memset (buffer, '\0', buffer_size);
 146
 147         buffer_fill = 0;
 148         while ((status = recv (fd, buffer + buffer_fill, buffer_size - buffer_fill, MSG_DONTWAIT)) != 0) {
 149                 if (i > MEMCACHED_RETRY_COUNT) {
 150                         ERROR("recv() timed out");
 151                         break;
 152                 }
 153                 i++;
 154
 155                 if (status == -1) {
 156                         char errbuf[1024];
 157
 158                         if (errno == EAGAIN) {
 159                                 continue;
 160                         }
 161
 162                         ERROR ("memcached: Error reading from socket: %s",
 163                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 164                         shutdown(fd, SHUT_RDWR);
 165                         close (fd);
 166                         return -1;
 167                 }
 168                 buffer_fill += status;
 169
 170                 if (buffer_fill > 3 && buffer[buffer_fill-5] == 'E' && buffer[buffer_fill-4] == 'N' && buffer[buffer_fill-3] == 'D') {
 171                         /* we got all the data */
 172                         break;
 173                 }
 174         }
 175
 176         if (buffer_fill >= buffer_size) {
 177                 buffer[buffer_size - 1] = '\0';
 178                 WARNING ("memcached: Message from memcached has been truncated.");
 179         } else if (buffer_fill == 0) {
 180                 WARNING ("memcached: Peer has unexpectedly shut down the socket. "
 181                                 "Buffer: `%s'", buffer);
 182                 shutdown(fd, SHUT_RDWR);
 183                 close(fd);
 184                 return -1;
 185         }
 186
 187         shutdown(fd, SHUT_RDWR);
 188         close(fd);
 189         return 0;
 190 }
 191 /* }}} */
 192
 193 static int memcached_config (const char *key, const char *value) /* {{{ */
 194 {
 195         if (strcasecmp (key, "Host") == 0) {
 196                 if (memcached_host != NULL) {
 197                         free (memcached_host);
 198                 }
 199                 memcached_host = strdup (value);
 200         } else if (strcasecmp (key, "Port") == 0) {
 201                 int port = (int) (atof (value));
 202                 if ((port > 0) && (port <= 65535)) {
 203                         snprintf (memcached_port, sizeof (memcached_port), "%i", port);
 204                 } else {
 205                         strncpy (memcached_port, value, sizeof (memcached_port));
 206                 }
 207                 memcached_port[sizeof (memcached_port) - 1] = '\0';
 208         } else {
 209                 return -1;
 210         }
 211
 212         return 0;
 213 }
 214 /* }}} */
 215
 216 static void submit_counter (const char *type, const char *type_inst,
 217                 counter_t value) /* {{{ */
 218 {
 219         value_t values[1];
 220         value_list_t vl = VALUE_LIST_INIT;
 221
 222         values[0].counter = value;
 223
 224         vl.values = values;
 225         vl.values_len = 1;
 226         vl.time = time (NULL);
 227         strcpy (vl.host, hostname_g);
 228         strcpy (vl.plugin, "memcached");
 229         strncpy (vl.type, type, sizeof (vl.type));
 230         if (type_inst != NULL)
 231         {
 232                 strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 233                 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
 234         }
 235
 236         plugin_dispatch_values (&vl);
 237 } /* void memcached_submit_cmd */
 238 /* }}} */
 239
 240 static void submit_counter2 (const char *type, const char *type_inst,
 241                 counter_t value0, counter_t value1) /* {{{ */
 242 {
 243         value_t values[2];
 244         value_list_t vl = VALUE_LIST_INIT;
 245
 246         values[0].counter = value0;
 247         values[1].counter = value1;
 248
 249         vl.values = values;
 250         vl.values_len = 2;
 251         vl.time = time (NULL);
 252         strcpy (vl.host, hostname_g);
 253         strcpy (vl.plugin, "memcached");
 254         strncpy (vl.type, type, sizeof (vl.type));
 255         if (type_inst != NULL)
 256         {
 257                 strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 258                 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
 259         }
 260
 261         plugin_dispatch_values (&vl);
 262 } /* void memcached_submit_cmd */
 263 /* }}} */
 264
 265 static void submit_gauge (const char *type, const char *type_inst,
 266                 gauge_t value) /* {{{ */
 267 {
 268         value_t values[1];
 269         value_list_t vl = VALUE_LIST_INIT;
 270
 271         values[0].gauge = value;
 272
 273         vl.values = values;
 274         vl.values_len = 1;
 275         vl.time = time (NULL);
 276         strcpy (vl.host, hostname_g);
 277         strcpy (vl.plugin, "memcached");
 278         strncpy (vl.type, type, sizeof (vl.type));
 279         if (type_inst != NULL)
 280         {
 281                 strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 282                 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
 283         }
 284
 285         plugin_dispatch_values (&vl);
 286 }
 287 /* }}} */
 288
 289 static void submit_gauge2 (const char *type, const char *type_inst,
 290                 gauge_t value0, gauge_t value1) /* {{{ */
 291 {
 292         value_t values[2];
 293         value_list_t vl = VALUE_LIST_INIT;
 294
 295         values[0].gauge = value0;
 296         values[1].gauge = value1;
 297
 298         vl.values = values;
 299         vl.values_len = 2;
 300         vl.time = time (NULL);
 301         strcpy (vl.host, hostname_g);
 302         strcpy (vl.plugin, "memcached");
 303         strncpy (vl.type, type, sizeof (vl.type));
 304         if (type_inst != NULL)
 305         {
 306                 strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 307                 vl.type_instance[sizeof (vl.type_instance) - 1] = '\0';
 308         }
 309
 310         plugin_dispatch_values (&vl);
 311 }
 312 /* }}} */
 313
 314 static int memcached_read (void) /* {{{ */
 315 {
 316         char buf[1024];
 317         char *fields[3];
 318         char *ptr;
 319         char *line;
 320         char *saveptr;
 321         int fields_num;
 322
 323         gauge_t bytes_used = NAN;
 324         gauge_t bytes_total = NAN;
 325         counter_t rusage_user = 0;
 326         counter_t rusage_syst = 0;
 327         counter_t octets_rx = 0;
 328         counter_t octets_tx = 0;
 329
 330         /* get data from daemon */
 331         if (memcached_query_daemon (buf, sizeof (buf)) < 0) {
 332                 return -1;
 333         }
 334
 335 #define FIELD_IS(cnst) \
 336         (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
 337
 338     ptr = buf;
 339     saveptr = NULL;
 340     while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
 341         {
 342                 int name_len;
 343
 344         ptr = NULL;
 345
 346                 fields_num = strsplit(line, fields, 3);
 347                 if (fields_num != 3)
 348                         continue;
 349
 350                 name_len = strlen(fields[1]);
 351                 if (name_len == 0)
 352                         continue;
 353
 354                 /*
 355                  * For an explanation on these fields please refer to
 356                  * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
 357                  */
 358
 359                 /*
 360                  * CPU time consumed by the memcached process
 361                  */
 362                 if (FIELD_IS ("rusage_user"))
 363                 {
 364                         rusage_user = atoll (fields[2]);
 365                 }
 366                 else if (FIELD_IS ("rusage_system"))
 367                 {
 368                         rusage_syst = atoll(fields[2]);
 369                 }
 370
 371                 /*
 372                  * Number of threads of this instance
 373                  */
 374                 else if (FIELD_IS ("threads"))
 375                 {
 376                         submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]));
 377                 }
 378
 379                 /*
 380                  * Number of items stored
 381                  */
 382                 else if (FIELD_IS ("curr_items"))
 383                 {
 384                         submit_gauge ("memcached_items", "current", atof (fields[2]));
 385                 }
 386 /*
 387                 else if (FIELD_IS ("total_items"))
 388                 {
 389                         total_items = atoll(fields[2]);
 390                 }
 391  */
 392
 393                 /*
 394                  * Number of bytes used and available (total - used)
 395                  */
 396                 else if (FIELD_IS ("bytes"))
 397                 {
 398                         bytes_used = atof (fields[2]);
 399                 }
 400                 else if (FIELD_IS ("limit_maxbytes"))
 401                 {
 402                         bytes_total = atof(fields[2]);
 403                 }
 404
 405                 /*
 406                  * Connections
 407                  */
 408                 else if (FIELD_IS ("curr_connections"))
 409                 {
 410                         submit_gauge ("memcached_connections", "current", atof (fields[2]));
 411                 }
 412 /*
 413                 else if (FIELD_IS("total_connections"))
 414                 {
 415                         total_connections = atoll(fields[2]);
 416                 }
 417 */
 418
 419 /*
 420  * ``Number of connection structures allocated by the server''
 421                 else if (FIELD_IS ("connection_structures"))
 422                 {
 423                         connection_structures = atof(fields[2]);
 424                 }
 425  */
 426
 427                 /*
 428                  * Commands
 429                  */
 430                 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
 431                 {
 432                         const char *name = fields[1] + 4;
 433                         submit_counter ("memcached_command", name, atoll (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_counter ("memcached_ops", "hits", atoll (fields[2]));
 442                 }
 443                 else if (FIELD_IS ("get_misses"))
 444                 {
 445                         submit_counter ("memcached_ops", "misses", atoll (fields[2]));
 446                 }
 447                 else if (FIELD_IS ("evictions"))
 448                 {
 449                         submit_counter ("memcached_ops", "evictions", atoll (fields[2]));
 450                 }
 451
 452                 /*
 453                  * Network traffic
 454                  */
 455                 else if (FIELD_IS ("bytes_read"))
 456                 {
 457                         octets_rx = atoll (fields[2]);
 458                 }
 459                 else if (FIELD_IS ("bytes_written"))
 460                 {
 461                         octets_tx = atoll (fields[2]);
 462                 }
 463         } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
 464
 465         if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
 466                 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used);
 467
 468         if ((rusage_user != 0) || (rusage_syst != 0))
 469                 submit_counter2 ("ps_cputime", NULL, rusage_user, rusage_syst);
 470
 471         if ((octets_rx != 0) || (octets_tx != 0))
 472                 submit_counter2 ("memcached_octets", NULL, octets_rx, octets_tx);
 473
 474         return 0;
 475 }
 476 /* }}} */
 477
 478 void module_register (void) /* {{{ */
 479 {
 480         plugin_register_config ("memcached", memcached_config, config_keys, config_keys_num);
 481         plugin_register_read ("memcached", memcached_read);
 482 }
 483 /* }}} */
 484
 485 /*
 486  * Local variables:
 487  * tab-width: 4
 488  * c-basic-offset: 4
 489  * End:
 490  * vim600: sw=4 ts=4 fdm=marker
 491  * vim<600: sw=4 ts=4
 492  */
 493