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 int memcached_read (user_data_t *user_data);
58 static void memcached_free (memcached_t *st)
69 static int memcached_connect_unix (memcached_t *st)
71 struct sockaddr_un serv_addr;
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));
79 /* create our socket descriptor */
80 fd = socket (AF_UNIX, SOCK_STREAM, 0);
84 ERROR ("memcached: memcached_connect_unix: socket(2) failed: %s",
85 sstrerror (errno, errbuf, sizeof (errbuf)));
90 } /* int memcached_connect_unix */
92 static int memcached_connect_inet (memcached_t *st)
97 struct addrinfo ai_hints;
98 struct addrinfo *ai_list, *ai_ptr;
102 memset (&ai_hints, 0, sizeof (ai_hints));
103 ai_hints.ai_flags = 0;
105 ai_hints.ai_flags |= AI_ADDRCONFIG;
107 ai_hints.ai_family = AF_UNSPEC;
108 ai_hints.ai_socktype = SOCK_STREAM;
109 ai_hints.ai_protocol = 0;
111 host = (st->host != NULL) ? st->host : MEMCACHED_DEF_HOST;
112 port = (st->port != NULL) ? st->port : MEMCACHED_DEF_PORT;
115 status = getaddrinfo (host, port, &ai_hints, &ai_list);
119 ERROR ("memcached: memcached_connect_inet: getaddrinfo(%s,%s) failed: %s",
121 (status == EAI_SYSTEM)
122 ? sstrerror (errno, errbuf, sizeof (errbuf))
123 : gai_strerror (status));
127 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
129 /* create our socket descriptor */
130 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
134 WARNING ("memcached: memcached_connect_inet: socket(2) failed: %s",
135 sstrerror (errno, errbuf, sizeof (errbuf)));
139 /* connect to the memcached daemon */
140 status = (int) connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
143 shutdown (fd, SHUT_RDWR);
149 /* A socket could be opened and connecting succeeded. We're done. */
153 freeaddrinfo (ai_list);
155 } /* int memcached_connect_inet */
157 static int memcached_connect (memcached_t *st)
159 if (st->socket != NULL)
160 return (memcached_connect_unix (st));
162 return (memcached_connect_inet (st));
165 static int memcached_query_daemon (char *buffer, size_t buffer_size, memcached_t *st)
171 fd = memcached_connect (st);
173 ERROR ("memcached: Could not connect to daemon.");
177 status = (int) swrite (fd, "stats\r\n", strlen ("stats\r\n"));
181 ERROR ("memcached plugin: write(2) failed: %s",
182 sstrerror (errno, errbuf, sizeof (errbuf)));
183 shutdown(fd, SHUT_RDWR);
188 /* receive data from the memcached daemon */
189 memset (buffer, 0, buffer_size);
192 while ((status = (int) recv (fd, buffer + buffer_fill,
193 buffer_size - buffer_fill, /* flags = */ 0)) != 0)
195 char const end_token[5] = {'E', 'N', 'D', '\r', '\n'};
200 if ((errno == EAGAIN) || (errno == EINTR))
203 ERROR ("memcached: Error reading from socket: %s",
204 sstrerror (errno, errbuf, sizeof (errbuf)));
205 shutdown(fd, SHUT_RDWR);
210 buffer_fill += (size_t) status;
211 if (buffer_fill > buffer_size)
213 buffer_fill = buffer_size;
214 WARNING ("memcached plugin: Message was truncated.");
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)
225 if (buffer_fill == 0)
227 WARNING ("memcached plugin: No data returned by memcached.");
231 shutdown(fd, SHUT_RDWR);
234 } /* int memcached_query_daemon */
236 static int memcached_add_read_callback (memcached_t *st)
239 char callback_name[3*DATA_MAX_NAME_LEN];
242 memset (&ud, 0, sizeof (ud));
244 ud.free_func = (void *) memcached_free;
246 assert (st->name != NULL);
247 ssnprintf (callback_name, sizeof (callback_name), "memcached/%s", st->name);
249 status = plugin_register_complex_read (/* group = */ "memcached",
250 /* name = */ callback_name,
251 /* callback = */ memcached_read,
252 /* interval = */ NULL,
253 /* user_data = */ &ud);
255 } /* int memcached_add_read_callback */
257 /* Configuration handling functiions
259 * <Instance "instance_name">
265 static int config_add_instance(oconfig_item_t *ci)
271 /* Disable automatic generation of default instance in the init callback. */
272 memcached_have_instances = 1;
274 st = malloc (sizeof (*st));
277 ERROR ("memcached plugin: malloc failed.");
281 memset (st, 0, sizeof (*st));
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);
296 assert (st->name != NULL);
298 for (i = 0; i < ci->children_num; i++)
300 oconfig_item_t *child = ci->children + i;
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);
310 WARNING ("memcached plugin: Option `%s' not allowed here.",
320 status = memcached_add_read_callback (st);
331 static int memcached_config (oconfig_item_t *ci)
334 _Bool have_instance_block = 0;
337 for (i = 0; i < ci->children_num; i++)
339 oconfig_item_t *child = ci->children + i;
341 if (strcasecmp ("Instance", child->key) == 0)
343 config_add_instance (child);
344 have_instance_block = 1;
346 else if (!have_instance_block)
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));
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?",
358 } /* for (ci->children) */
363 static int memcached_init (void)
368 if (memcached_have_instances)
371 /* No instances were configured, lets start a default instance. */
372 st = malloc (sizeof (*st));
375 memset (st, 0, sizeof (*st));
376 st->name = sstrdup ("default");
381 status = memcached_add_read_callback (st);
383 memcached_have_instances = 1;
388 } /* int memcached_init */
390 static void submit_derive (const char *type, const char *type_inst,
391 derive_t value, memcached_t *st)
394 value_list_t vl = VALUE_LIST_INIT;
396 values[0].derive = value;
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));
408 plugin_dispatch_values (&vl);
411 static void submit_derive2 (const char *type, const char *type_inst,
412 derive_t value0, derive_t value1, memcached_t *st)
415 value_list_t vl = VALUE_LIST_INIT;
417 values[0].derive = value0;
418 values[1].derive = value1;
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));
430 plugin_dispatch_values (&vl);
433 static void submit_gauge (const char *type, const char *type_inst,
434 gauge_t value, memcached_t *st)
437 value_list_t vl = VALUE_LIST_INIT;
439 values[0].gauge = value;
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));
451 plugin_dispatch_values (&vl);
454 static void submit_gauge2 (const char *type, const char *type_inst,
455 gauge_t value0, gauge_t value1, memcached_t *st)
458 value_list_t vl = VALUE_LIST_INIT;
460 values[0].gauge = value0;
461 values[1].gauge = value1;
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));
473 plugin_dispatch_values (&vl);
476 static int memcached_read (user_data_t *user_data)
485 gauge_t bytes_used = NAN;
486 gauge_t bytes_total = 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;
495 st = user_data->data;
497 /* get data from daemon */
498 if (memcached_query_daemon (buf, sizeof (buf), st) < 0) {
502 #define FIELD_IS(cnst) \
503 (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
507 while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
513 fields_num = strsplit(line, fields, 3);
517 name_len = strlen(fields[1]);
522 * For an explanation on these fields please refer to
523 * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
527 * CPU time consumed by the memcached process
529 if (FIELD_IS ("rusage_user"))
531 rusage_user = atoll (fields[2]);
533 else if (FIELD_IS ("rusage_system"))
535 rusage_syst = atoll(fields[2]);
539 * Number of threads of this instance
541 else if (FIELD_IS ("threads"))
543 submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]), st);
547 * Number of items stored
549 else if (FIELD_IS ("curr_items"))
551 submit_gauge ("memcached_items", "current", atof (fields[2]), st);
555 * Number of bytes used and available (total - used)
557 else if (FIELD_IS ("bytes"))
559 bytes_used = atof (fields[2]);
561 else if (FIELD_IS ("limit_maxbytes"))
563 bytes_total = atof(fields[2]);
569 else if (FIELD_IS ("curr_connections"))
571 submit_gauge ("memcached_connections", "current", atof (fields[2]), st);
577 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
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]);
586 * Operations on the cache, i. e. cache hits, cache misses and evictions of items
588 else if (FIELD_IS ("get_hits"))
590 submit_derive ("memcached_ops", "hits", atoll (fields[2]), st);
591 hits = atof (fields[2]);
593 else if (FIELD_IS ("get_misses"))
595 submit_derive ("memcached_ops", "misses", atoll (fields[2]), st);
597 else if (FIELD_IS ("evictions"))
599 submit_derive ("memcached_ops", "evictions", atoll (fields[2]), st);
605 else if (FIELD_IS ("bytes_read"))
607 octets_rx = atoll (fields[2]);
609 else if (FIELD_IS ("bytes_written"))
611 octets_tx = atoll (fields[2]);
613 } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
615 if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
616 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used, st);
618 if ((rusage_user != 0) || (rusage_syst != 0))
619 submit_derive2 ("ps_cputime", NULL, rusage_user, rusage_syst, st);
621 if ((octets_rx != 0) || (octets_tx != 0))
622 submit_derive2 ("memcached_octets", NULL, octets_rx, octets_tx, st);
624 if (!isnan (gets) && !isnan (hits))
629 rate = 100.0 * hits / gets;
631 submit_gauge ("percent", "hitratio", rate, st);
635 } /* int memcached_read */
637 void module_register (void)
639 plugin_register_complex_config ("memcached", memcached_config);
640 plugin_register_init ("memcached", memcached_init);