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
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.
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.
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
24 * Antony Dovgal <tony at daylessday dot org>
25 * Florian octo Forster <octo at collectd.org>
26 * Doug MacEachern <dougm at hyperic.com>
34 #include "configfile.h"
37 #include <sys/socket.h>
39 #include <netinet/in.h>
40 #include <netinet/tcp.h>
42 #define MEMCACHED_DEF_HOST "127.0.0.1"
43 #define MEMCACHED_DEF_PORT "11211"
52 typedef struct memcached_s memcached_t;
54 static _Bool memcached_have_instances = 0;
56 static void memcached_free (memcached_t *st)
67 static int memcached_connect_unix (memcached_t *st)
69 struct sockaddr_un serv_addr;
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));
77 /* create our socket descriptor */
78 fd = socket (AF_UNIX, SOCK_STREAM, 0);
82 ERROR ("memcached plugin: memcached_connect_unix: socket(2) failed: %s",
83 sstrerror (errno, errbuf, sizeof (errbuf)));
87 /* connect to the memcached daemon */
88 int status = connect (fd, (struct sockaddr *)&serv_addr, sizeof(serv_addr));
91 shutdown (fd, SHUT_RDWR);
97 } /* int memcached_connect_unix */
99 static int memcached_connect_inet (memcached_t *st)
104 struct addrinfo ai_hints;
105 struct addrinfo *ai_list, *ai_ptr;
109 memset (&ai_hints, 0, sizeof (ai_hints));
110 ai_hints.ai_flags = 0;
112 ai_hints.ai_flags |= AI_ADDRCONFIG;
114 ai_hints.ai_family = AF_UNSPEC;
115 ai_hints.ai_socktype = SOCK_STREAM;
116 ai_hints.ai_protocol = 0;
118 host = (st->host != NULL) ? st->host : MEMCACHED_DEF_HOST;
119 port = (st->port != NULL) ? st->port : MEMCACHED_DEF_PORT;
122 status = getaddrinfo (host, port, &ai_hints, &ai_list);
126 ERROR ("memcached plugin: memcached_connect_inet: "
127 "getaddrinfo(%s,%s) failed: %s",
129 (status == EAI_SYSTEM)
130 ? sstrerror (errno, errbuf, sizeof (errbuf))
131 : gai_strerror (status));
135 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
137 /* create our socket descriptor */
138 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
142 WARNING ("memcached plugin: memcached_connect_inet: "
143 "socket(2) failed: %s",
144 sstrerror (errno, errbuf, sizeof (errbuf)));
148 /* connect to the memcached daemon */
149 status = (int) connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
152 shutdown (fd, SHUT_RDWR);
158 /* A socket could be opened and connecting succeeded. We're done. */
162 freeaddrinfo (ai_list);
164 } /* int memcached_connect_inet */
166 static int memcached_connect (memcached_t *st)
168 if (st->socket != NULL)
169 return (memcached_connect_unix (st));
171 return (memcached_connect_inet (st));
174 static int memcached_query_daemon (char *buffer, size_t buffer_size, memcached_t *st)
180 fd = memcached_connect (st);
182 ERROR ("memcached plugin: Instance \"%s\" could not connect to daemon.",
187 status = (int) swrite (fd, "stats\r\n", strlen ("stats\r\n"));
191 ERROR ("memcached plugin: write(2) failed: %s",
192 sstrerror (errno, errbuf, sizeof (errbuf)));
193 shutdown(fd, SHUT_RDWR);
198 /* receive data from the memcached daemon */
199 memset (buffer, 0, buffer_size);
202 while ((status = (int) recv (fd, buffer + buffer_fill,
203 buffer_size - buffer_fill, /* flags = */ 0)) != 0)
205 char const end_token[5] = {'E', 'N', 'D', '\r', '\n'};
210 if ((errno == EAGAIN) || (errno == EINTR))
213 ERROR ("memcached: Error reading from socket: %s",
214 sstrerror (errno, errbuf, sizeof (errbuf)));
215 shutdown(fd, SHUT_RDWR);
220 buffer_fill += (size_t) status;
221 if (buffer_fill > buffer_size)
223 buffer_fill = buffer_size;
224 WARNING ("memcached plugin: Message was truncated.");
228 /* If buffer ends in end_token, we have all the data. */
229 if (memcmp (buffer + buffer_fill - sizeof (end_token),
230 end_token, sizeof (end_token)) == 0)
235 if (buffer_fill == 0)
237 WARNING ("memcached plugin: No data returned by memcached.");
241 shutdown(fd, SHUT_RDWR);
244 } /* int memcached_query_daemon */
246 static void memcached_init_vl (value_list_t *vl, memcached_t const *st)
248 sstrncpy (vl->plugin, "memcached", sizeof (vl->plugin));
249 if (strcmp (st->name, "__legacy__") == 0) /* legacy mode */
251 sstrncpy (vl->host, hostname_g, sizeof (vl->host));
255 if (st->socket != NULL)
256 sstrncpy (vl->host, hostname_g, sizeof (vl->host));
259 (st->host != NULL) ? st->host : MEMCACHED_DEF_HOST,
261 sstrncpy (vl->plugin_instance, st->name, sizeof (vl->plugin_instance));
265 static void submit_derive (const char *type, const char *type_inst,
266 derive_t value, memcached_t *st)
269 value_list_t vl = VALUE_LIST_INIT;
270 memcached_init_vl (&vl, st);
272 values[0].derive = value;
276 sstrncpy (vl.type, type, sizeof (vl.type));
277 if (type_inst != NULL)
278 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
280 plugin_dispatch_values (&vl);
283 static void submit_derive2 (const char *type, const char *type_inst,
284 derive_t value0, derive_t value1, memcached_t *st)
287 value_list_t vl = VALUE_LIST_INIT;
288 memcached_init_vl (&vl, st);
290 values[0].derive = value0;
291 values[1].derive = value1;
295 sstrncpy (vl.type, type, sizeof (vl.type));
296 if (type_inst != NULL)
297 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
299 plugin_dispatch_values (&vl);
302 static void submit_gauge (const char *type, const char *type_inst,
303 gauge_t value, memcached_t *st)
306 value_list_t vl = VALUE_LIST_INIT;
307 memcached_init_vl (&vl, st);
309 values[0].gauge = value;
313 sstrncpy (vl.type, type, sizeof (vl.type));
314 if (type_inst != NULL)
315 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
317 plugin_dispatch_values (&vl);
320 static void submit_gauge2 (const char *type, const char *type_inst,
321 gauge_t value0, gauge_t value1, memcached_t *st)
324 value_list_t vl = VALUE_LIST_INIT;
325 memcached_init_vl (&vl, st);
327 values[0].gauge = value0;
328 values[1].gauge = value1;
332 sstrncpy (vl.type, type, sizeof (vl.type));
333 if (type_inst != NULL)
334 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
336 plugin_dispatch_values (&vl);
339 static int memcached_read (user_data_t *user_data)
348 gauge_t bytes_used = NAN;
349 gauge_t bytes_total = NAN;
352 gauge_t incr_hits = NAN;
354 gauge_t decr_hits = NAN;
356 derive_t rusage_user = 0;
357 derive_t rusage_syst = 0;
358 derive_t octets_rx = 0;
359 derive_t octets_tx = 0;
362 st = user_data->data;
364 /* get data from daemon */
365 if (memcached_query_daemon (buf, sizeof (buf), st) < 0) {
369 #define FIELD_IS(cnst) \
370 (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
374 while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
380 fields_num = strsplit(line, fields, 3);
384 name_len = strlen(fields[1]);
389 * For an explanation on these fields please refer to
390 * <https://github.com/memcached/memcached/blob/master/doc/protocol.txt>
394 * CPU time consumed by the memcached process
396 if (FIELD_IS ("rusage_user"))
398 rusage_user = atoll (fields[2]);
400 else if (FIELD_IS ("rusage_system"))
402 rusage_syst = atoll(fields[2]);
406 * Number of threads of this instance
408 else if (FIELD_IS ("threads"))
410 submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]), st);
414 * Number of items stored
416 else if (FIELD_IS ("curr_items"))
418 submit_gauge ("memcached_items", "current", atof (fields[2]), st);
422 * Number of bytes used and available (total - used)
424 else if (FIELD_IS ("bytes"))
426 bytes_used = atof (fields[2]);
428 else if (FIELD_IS ("limit_maxbytes"))
430 bytes_total = atof(fields[2]);
436 else if (FIELD_IS ("curr_connections"))
438 submit_gauge ("memcached_connections", "current", atof (fields[2]), st);
440 else if (FIELD_IS ("listen_disabled_num"))
442 submit_derive ("memcached_connections", "listen_disabled", atof (fields[2]), st);
448 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
450 const char *name = fields[1] + 4;
451 submit_derive ("memcached_command", name, atoll (fields[2]), st);
452 if (strcmp (name, "get") == 0)
453 gets = atof (fields[2]);
457 * Increment/Decrement
459 else if (FIELD_IS("incr_misses"))
461 derive_t incr_count = atoll (fields[2]);
462 submit_derive ("memcached_ops", "incr_misses", incr_count, st);
465 else if (FIELD_IS ("incr_hits"))
467 derive_t incr_count = atoll (fields[2]);
468 submit_derive ("memcached_ops", "incr_hits", incr_count, st);
469 incr_hits = atof (fields[2]);
472 else if (FIELD_IS ("decr_misses"))
474 derive_t decr_count = atoll (fields[2]);
475 submit_derive ("memcached_ops", "decr_misses", decr_count, st);
478 else if (FIELD_IS ("decr_hits"))
480 derive_t decr_count = atoll (fields[2]);
481 submit_derive ("memcached_ops", "decr_hits", decr_count, st);
482 decr_hits = atof (fields[2]);
487 * Operations on the cache, i. e. cache hits, cache misses and evictions of items
489 else if (FIELD_IS ("get_hits"))
491 submit_derive ("memcached_ops", "hits", atoll (fields[2]), st);
492 hits = atof (fields[2]);
494 else if (FIELD_IS ("get_misses"))
496 submit_derive ("memcached_ops", "misses", atoll (fields[2]), st);
498 else if (FIELD_IS ("evictions"))
500 submit_derive ("memcached_ops", "evictions", atoll (fields[2]), st);
506 else if (FIELD_IS ("bytes_read"))
508 octets_rx = atoll (fields[2]);
510 else if (FIELD_IS ("bytes_written"))
512 octets_tx = atoll (fields[2]);
514 } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
516 if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
517 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used, st);
519 if ((rusage_user != 0) || (rusage_syst != 0))
520 submit_derive2 ("ps_cputime", NULL, rusage_user, rusage_syst, st);
522 if ((octets_rx != 0) || (octets_tx != 0))
523 submit_derive2 ("memcached_octets", NULL, octets_rx, octets_tx, st);
525 if (!isnan (gets) && !isnan (hits))
530 rate = 100.0 * hits / gets;
532 submit_gauge ("percent", "hitratio", rate, st);
535 if (!isnan (incr_hits) && incr != 0)
537 gauge_t incr_rate = 100.0 * incr_hits / incr;
538 submit_gauge ("percent", "incr_hitratio", incr_rate, st);
539 submit_derive ("memcached_ops", "incr", incr, st);
542 if (!isnan (decr_hits) && decr != 0)
544 gauge_t decr_rate = 100.0 * decr_hits / decr;
545 submit_gauge ("percent", "decr_hitratio", decr_rate, st);
546 submit_derive ("memcached_ops", "decr", decr, st);
550 } /* int memcached_read */
552 static int memcached_add_read_callback (memcached_t *st)
555 char callback_name[3*DATA_MAX_NAME_LEN];
558 memset (&ud, 0, sizeof (ud));
560 ud.free_func = (void *) memcached_free;
562 assert (st->name != NULL);
563 ssnprintf (callback_name, sizeof (callback_name), "memcached/%s", st->name);
565 status = plugin_register_complex_read (/* group = */ "memcached",
566 /* name = */ callback_name,
567 /* callback = */ memcached_read,
568 /* interval = */ NULL,
569 /* user_data = */ &ud);
571 } /* int memcached_add_read_callback */
573 /* Configuration handling functiions
575 * <Instance "instance_name">
581 static int config_add_instance(oconfig_item_t *ci)
587 /* Disable automatic generation of default instance in the init callback. */
588 memcached_have_instances = 1;
590 st = malloc (sizeof (*st));
593 ERROR ("memcached plugin: malloc failed.");
597 memset (st, 0, sizeof (*st));
603 if (strcasecmp (ci->key, "Plugin") == 0) /* default instance */
604 st->name = sstrdup ("__legacy__");
605 else /* <Instance /> block */
606 status = cf_util_get_string (ci, &st->name);
612 assert (st->name != NULL);
614 for (i = 0; i < ci->children_num; i++)
616 oconfig_item_t *child = ci->children + i;
618 if (strcasecmp ("Socket", child->key) == 0)
619 status = cf_util_get_string (child, &st->socket);
620 else if (strcasecmp ("Host", child->key) == 0)
621 status = cf_util_get_string (child, &st->host);
622 else if (strcasecmp ("Port", child->key) == 0)
623 status = cf_util_get_service (child, &st->port);
626 WARNING ("memcached plugin: Option `%s' not allowed here.",
636 status = memcached_add_read_callback (st);
647 static int memcached_config (oconfig_item_t *ci)
650 _Bool have_instance_block = 0;
653 for (i = 0; i < ci->children_num; i++)
655 oconfig_item_t *child = ci->children + i;
657 if (strcasecmp ("Instance", child->key) == 0)
659 config_add_instance (child);
660 have_instance_block = 1;
662 else if (!have_instance_block)
664 /* Non-instance option: Assume legacy configuration (without <Instance />
665 * blocks) and call config_add_instance() with the <Plugin /> block. */
666 return (config_add_instance (ci));
669 WARNING ("memcached plugin: The configuration option "
670 "\"%s\" is not allowed here. Did you "
671 "forget to add an <Instance /> block "
672 "around the configuration?",
674 } /* for (ci->children) */
679 static int memcached_init (void)
684 if (memcached_have_instances)
687 /* No instances were configured, lets start a default instance. */
688 st = malloc (sizeof (*st));
691 memset (st, 0, sizeof (*st));
692 st->name = sstrdup ("__legacy__");
697 status = memcached_add_read_callback (st);
699 memcached_have_instances = 1;
704 } /* int memcached_init */
706 void module_register (void)
708 plugin_register_complex_config ("memcached", memcached_config);
709 plugin_register_init ("memcached", memcached_init);