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: memcached_connect_unix: socket(2) failed: %s",
83 sstrerror (errno, errbuf, sizeof (errbuf)));
88 } /* int memcached_connect_unix */
90 static int memcached_connect_inet (memcached_t *st)
95 struct addrinfo ai_hints;
96 struct addrinfo *ai_list, *ai_ptr;
100 memset (&ai_hints, 0, sizeof (ai_hints));
101 ai_hints.ai_flags = 0;
103 ai_hints.ai_flags |= AI_ADDRCONFIG;
105 ai_hints.ai_family = AF_UNSPEC;
106 ai_hints.ai_socktype = SOCK_STREAM;
107 ai_hints.ai_protocol = 0;
109 host = (st->host != NULL) ? st->host : MEMCACHED_DEF_HOST;
110 port = (st->port != NULL) ? st->port : MEMCACHED_DEF_PORT;
113 status = getaddrinfo (host, port, &ai_hints, &ai_list);
117 ERROR ("memcached: memcached_connect_inet: getaddrinfo(%s,%s) failed: %s",
119 (status == EAI_SYSTEM)
120 ? sstrerror (errno, errbuf, sizeof (errbuf))
121 : gai_strerror (status));
125 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
127 /* create our socket descriptor */
128 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
132 WARNING ("memcached: memcached_connect_inet: socket(2) failed: %s",
133 sstrerror (errno, errbuf, sizeof (errbuf)));
137 /* connect to the memcached daemon */
138 status = (int) connect (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
141 shutdown (fd, SHUT_RDWR);
147 /* A socket could be opened and connecting succeeded. We're done. */
151 freeaddrinfo (ai_list);
153 } /* int memcached_connect_inet */
155 static int memcached_connect (memcached_t *st)
157 if (st->socket != NULL)
158 return (memcached_connect_unix (st));
160 return (memcached_connect_inet (st));
163 static int memcached_query_daemon (char *buffer, size_t buffer_size, memcached_t *st)
169 fd = memcached_connect (st);
171 ERROR ("memcached: Could not connect to daemon.");
175 status = (int) swrite (fd, "stats\r\n", strlen ("stats\r\n"));
179 ERROR ("memcached plugin: write(2) failed: %s",
180 sstrerror (errno, errbuf, sizeof (errbuf)));
181 shutdown(fd, SHUT_RDWR);
186 /* receive data from the memcached daemon */
187 memset (buffer, 0, buffer_size);
190 while ((status = (int) recv (fd, buffer + buffer_fill,
191 buffer_size - buffer_fill, /* flags = */ 0)) != 0)
193 char const end_token[5] = {'E', 'N', 'D', '\r', '\n'};
198 if ((errno == EAGAIN) || (errno == EINTR))
201 ERROR ("memcached: Error reading from socket: %s",
202 sstrerror (errno, errbuf, sizeof (errbuf)));
203 shutdown(fd, SHUT_RDWR);
208 buffer_fill += (size_t) status;
209 if (buffer_fill > buffer_size)
211 buffer_fill = buffer_size;
212 WARNING ("memcached plugin: Message was truncated.");
216 /* If buffer ends in end_token, we have all the data. */
217 if (memcmp (buffer + buffer_fill - sizeof (end_token),
218 end_token, sizeof (end_token)) == 0)
223 if (buffer_fill == 0)
225 WARNING ("memcached plugin: No data returned by memcached.");
229 shutdown(fd, SHUT_RDWR);
232 } /* int memcached_query_daemon */
234 static void submit_derive (const char *type, const char *type_inst,
235 derive_t value, memcached_t *st)
238 value_list_t vl = VALUE_LIST_INIT;
240 values[0].derive = value;
244 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
245 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
246 if (st->name != NULL)
247 sstrncpy (vl.plugin_instance, st->name, sizeof (vl.plugin_instance));
248 sstrncpy (vl.type, type, sizeof (vl.type));
249 if (type_inst != NULL)
250 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
252 plugin_dispatch_values (&vl);
255 static void submit_derive2 (const char *type, const char *type_inst,
256 derive_t value0, derive_t value1, memcached_t *st)
259 value_list_t vl = VALUE_LIST_INIT;
261 values[0].derive = value0;
262 values[1].derive = value1;
266 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
267 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
268 if (st->name != NULL)
269 sstrncpy (vl.plugin_instance, st->name, sizeof (vl.plugin_instance));
270 sstrncpy (vl.type, type, sizeof (vl.type));
271 if (type_inst != NULL)
272 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
274 plugin_dispatch_values (&vl);
277 static void submit_gauge (const char *type, const char *type_inst,
278 gauge_t value, memcached_t *st)
281 value_list_t vl = VALUE_LIST_INIT;
283 values[0].gauge = value;
287 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
288 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
289 if (st->name != NULL)
290 sstrncpy (vl.plugin_instance, st->name, sizeof (vl.plugin_instance));
291 sstrncpy (vl.type, type, sizeof (vl.type));
292 if (type_inst != NULL)
293 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
295 plugin_dispatch_values (&vl);
298 static void submit_gauge2 (const char *type, const char *type_inst,
299 gauge_t value0, gauge_t value1, memcached_t *st)
302 value_list_t vl = VALUE_LIST_INIT;
304 values[0].gauge = value0;
305 values[1].gauge = value1;
309 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
310 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
311 if (st->name != NULL)
312 sstrncpy (vl.plugin_instance, st->name, sizeof (vl.plugin_instance));
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 int memcached_read (user_data_t *user_data)
329 gauge_t bytes_used = NAN;
330 gauge_t bytes_total = NAN;
333 derive_t rusage_user = 0;
334 derive_t rusage_syst = 0;
335 derive_t octets_rx = 0;
336 derive_t octets_tx = 0;
339 st = user_data->data;
341 /* get data from daemon */
342 if (memcached_query_daemon (buf, sizeof (buf), st) < 0) {
346 #define FIELD_IS(cnst) \
347 (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
351 while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
357 fields_num = strsplit(line, fields, 3);
361 name_len = strlen(fields[1]);
366 * For an explanation on these fields please refer to
367 * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
371 * CPU time consumed by the memcached process
373 if (FIELD_IS ("rusage_user"))
375 rusage_user = atoll (fields[2]);
377 else if (FIELD_IS ("rusage_system"))
379 rusage_syst = atoll(fields[2]);
383 * Number of threads of this instance
385 else if (FIELD_IS ("threads"))
387 submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]), st);
391 * Number of items stored
393 else if (FIELD_IS ("curr_items"))
395 submit_gauge ("memcached_items", "current", atof (fields[2]), st);
399 * Number of bytes used and available (total - used)
401 else if (FIELD_IS ("bytes"))
403 bytes_used = atof (fields[2]);
405 else if (FIELD_IS ("limit_maxbytes"))
407 bytes_total = atof(fields[2]);
413 else if (FIELD_IS ("curr_connections"))
415 submit_gauge ("memcached_connections", "current", atof (fields[2]), st);
421 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
423 const char *name = fields[1] + 4;
424 submit_derive ("memcached_command", name, atoll (fields[2]), st);
425 if (strcmp (name, "get") == 0)
426 gets = atof (fields[2]);
430 * Operations on the cache, i. e. cache hits, cache misses and evictions of items
432 else if (FIELD_IS ("get_hits"))
434 submit_derive ("memcached_ops", "hits", atoll (fields[2]), st);
435 hits = atof (fields[2]);
437 else if (FIELD_IS ("get_misses"))
439 submit_derive ("memcached_ops", "misses", atoll (fields[2]), st);
441 else if (FIELD_IS ("evictions"))
443 submit_derive ("memcached_ops", "evictions", atoll (fields[2]), st);
449 else if (FIELD_IS ("bytes_read"))
451 octets_rx = atoll (fields[2]);
453 else if (FIELD_IS ("bytes_written"))
455 octets_tx = atoll (fields[2]);
457 } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
459 if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
460 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used, st);
462 if ((rusage_user != 0) || (rusage_syst != 0))
463 submit_derive2 ("ps_cputime", NULL, rusage_user, rusage_syst, st);
465 if ((octets_rx != 0) || (octets_tx != 0))
466 submit_derive2 ("memcached_octets", NULL, octets_rx, octets_tx, st);
468 if (!isnan (gets) && !isnan (hits))
473 rate = 100.0 * hits / gets;
475 submit_gauge ("percent", "hitratio", rate, st);
479 } /* int memcached_read */
481 static int memcached_add_read_callback (memcached_t *st)
484 char callback_name[3*DATA_MAX_NAME_LEN];
487 memset (&ud, 0, sizeof (ud));
489 ud.free_func = (void *) memcached_free;
491 assert (st->name != NULL);
492 ssnprintf (callback_name, sizeof (callback_name), "memcached/%s", st->name);
494 status = plugin_register_complex_read (/* group = */ "memcached",
495 /* name = */ callback_name,
496 /* callback = */ memcached_read,
497 /* interval = */ NULL,
498 /* user_data = */ &ud);
500 } /* int memcached_add_read_callback */
502 /* Configuration handling functiions
504 * <Instance "instance_name">
510 static int config_add_instance(oconfig_item_t *ci)
516 /* Disable automatic generation of default instance in the init callback. */
517 memcached_have_instances = 1;
519 st = malloc (sizeof (*st));
522 ERROR ("memcached plugin: malloc failed.");
526 memset (st, 0, sizeof (*st));
532 if (strcasecmp (ci->key, "Plugin") == 0) /* default instance */
533 st->name = sstrdup ("default");
534 else /* <Instance /> block */
535 status = cf_util_get_string (ci, &st->name);
541 assert (st->name != NULL);
543 for (i = 0; i < ci->children_num; i++)
545 oconfig_item_t *child = ci->children + i;
547 if (strcasecmp ("Socket", child->key) == 0)
548 status = cf_util_get_string (child, &st->socket);
549 else if (strcasecmp ("Host", child->key) == 0)
550 status = cf_util_get_string (child, &st->host);
551 else if (strcasecmp ("Port", child->key) == 0)
552 status = cf_util_get_service (child, &st->port);
555 WARNING ("memcached plugin: Option `%s' not allowed here.",
565 status = memcached_add_read_callback (st);
576 static int memcached_config (oconfig_item_t *ci)
579 _Bool have_instance_block = 0;
582 for (i = 0; i < ci->children_num; i++)
584 oconfig_item_t *child = ci->children + i;
586 if (strcasecmp ("Instance", child->key) == 0)
588 config_add_instance (child);
589 have_instance_block = 1;
591 else if (!have_instance_block)
593 /* Non-instance option: Assume legacy configuration (without <Instance />
594 * blocks) and call config_add_instance() with the <Plugin /> block. */
595 return (config_add_instance (ci));
598 WARNING ("memcached plugin: The configuration option "
599 "\"%s\" is not allowed here. Did you "
600 "forget to add an <Instance /> block "
601 "around the configuration?",
603 } /* for (ci->children) */
608 static int memcached_init (void)
613 if (memcached_have_instances)
616 /* No instances were configured, lets start a default instance. */
617 st = malloc (sizeof (*st));
620 memset (st, 0, sizeof (*st));
621 st->name = sstrdup ("default");
626 status = memcached_add_read_callback (st);
628 memcached_have_instances = 1;
633 } /* int memcached_init */
635 void module_register (void)
637 plugin_register_complex_config ("memcached", memcached_config);
638 plugin_register_init ("memcached", memcached_init);