2 * collectd - src/memcached.c, based on src/hddtemp.c
3 * Copyright (C) 2007 Antony Dovgal
4 * Copyright (C) 2007-2009 Florian Forster
5 * Copyright (C) 2009 Doug MacEachern
6 * Copyright (C) 2009 Franck Lombardi
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 * Antony Dovgal <tony at daylessday dot org>
24 * Florian octo Forster <octo at verplant.org>
25 * Doug MacEachern <dougm at hyperic.com>
32 #include "configfile.h"
36 # include <sys/socket.h>
38 # include <netinet/in.h>
39 # include <netinet/tcp.h>
41 /* Hack to work around the missing define in AIX */
43 # define MSG_DONTWAIT MSG_NONBLOCK
46 #define MEMCACHED_DEF_HOST "127.0.0.1"
47 #define MEMCACHED_DEF_PORT "11211"
49 #define MEMCACHED_RETRY_COUNT 100
51 static const char *config_keys[] =
57 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
59 static char *memcached_socket = NULL;
60 static char *memcached_host = NULL;
61 static char memcached_port[16];
63 static int memcached_query_daemon (char *buffer, int buffer_size) /* {{{ */
70 if (memcached_socket != NULL) {
71 struct sockaddr_un serv_addr;
73 memset (&serv_addr, 0, sizeof (serv_addr));
74 serv_addr.sun_family = AF_UNIX;
75 sstrncpy (serv_addr.sun_path, memcached_socket,
76 sizeof (serv_addr.sun_path));
78 /* create our socket descriptor */
79 fd = socket (AF_UNIX, SOCK_STREAM, 0);
82 ERROR ("memcached: unix socket: %s", sstrerror (errno, errbuf,
87 /* connect to the memcached daemon */
88 status = (ssize_t) connect (fd, (struct sockaddr *) &serv_addr,
91 shutdown (fd, SHUT_RDWR);
96 else { /* if (memcached_socket == NULL) */
100 struct addrinfo ai_hints;
101 struct addrinfo *ai_list, *ai_ptr;
104 memset (&ai_hints, '\0', sizeof (ai_hints));
105 ai_hints.ai_flags = 0;
107 /* ai_hints.ai_flags |= AI_ADDRCONFIG; */
109 ai_hints.ai_family = AF_INET;
110 ai_hints.ai_socktype = SOCK_STREAM;
111 ai_hints.ai_protocol = 0;
113 host = memcached_host;
115 host = MEMCACHED_DEF_HOST;
118 port = memcached_port;
119 if (strlen (port) == 0) {
120 port = MEMCACHED_DEF_PORT;
123 if ((ai_return = getaddrinfo (host, port, &ai_hints, &ai_list)) != 0) {
125 ERROR ("memcached: getaddrinfo (%s, %s): %s",
127 (ai_return == EAI_SYSTEM)
128 ? sstrerror (errno, errbuf, sizeof (errbuf))
129 : gai_strerror (ai_return));
134 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) {
135 /* create our socket descriptor */
136 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
139 ERROR ("memcached: socket: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
143 /* connect to the memcached daemon */
144 status = (ssize_t) connect (fd, (struct sockaddr *) ai_ptr->ai_addr, ai_ptr->ai_addrlen);
146 shutdown (fd, SHUT_RDWR);
152 /* A socket could be opened and connecting succeeded. We're
157 freeaddrinfo (ai_list);
161 ERROR ("memcached: Could not connect to daemon.");
165 if (send(fd, "stats\r\n", sizeof("stats\r\n") - 1, MSG_DONTWAIT) != (sizeof("stats\r\n") - 1)) {
166 ERROR ("memcached: Could not send command to the memcached daemon.");
174 memset (&p, 0, sizeof (p));
176 p.events = POLLIN | POLLERR | POLLHUP;
179 status = poll (&p, /* nfds = */ 1, /* timeout = */ 1000 * interval_g);
184 ERROR ("memcached: poll(2) timed out after %i seconds.", interval_g);
189 ERROR ("memcached: poll(2) failed: %s",
190 sstrerror (errno, errbuf, sizeof (errbuf)));
192 shutdown (fd, SHUT_RDWR);
198 /* receive data from the memcached daemon */
199 memset (buffer, '\0', buffer_size);
202 while ((status = recv (fd, buffer + buffer_fill, buffer_size - buffer_fill, MSG_DONTWAIT)) != 0) {
203 if (i > MEMCACHED_RETRY_COUNT) {
204 ERROR("recv() timed out");
212 if (errno == EAGAIN) {
216 ERROR ("memcached: Error reading from socket: %s",
217 sstrerror (errno, errbuf, sizeof (errbuf)));
218 shutdown(fd, SHUT_RDWR);
222 buffer_fill += status;
224 if (buffer_fill > 3 && buffer[buffer_fill-5] == 'E' && buffer[buffer_fill-4] == 'N' && buffer[buffer_fill-3] == 'D') {
225 /* we got all the data */
230 if (buffer_fill >= buffer_size) {
231 buffer[buffer_size - 1] = '\0';
232 WARNING ("memcached: Message from memcached has been truncated.");
233 } else if (buffer_fill == 0) {
234 WARNING ("memcached: Peer has unexpectedly shut down the socket. "
235 "Buffer: `%s'", buffer);
236 shutdown(fd, SHUT_RDWR);
241 shutdown(fd, SHUT_RDWR);
247 static int memcached_config (const char *key, const char *value) /* {{{ */
249 if (strcasecmp (key, "Socket") == 0) {
250 if (memcached_socket != NULL) {
251 free (memcached_socket);
253 memcached_socket = strdup (value);
254 } else if (strcasecmp (key, "Host") == 0) {
255 if (memcached_host != NULL) {
256 free (memcached_host);
258 memcached_host = strdup (value);
259 } else if (strcasecmp (key, "Port") == 0) {
260 int port = (int) (atof (value));
261 if ((port > 0) && (port <= 65535)) {
262 ssnprintf (memcached_port, sizeof (memcached_port), "%i", port);
264 sstrncpy (memcached_port, value, sizeof (memcached_port));
274 static void submit_counter (const char *type, const char *type_inst,
275 counter_t value) /* {{{ */
278 value_list_t vl = VALUE_LIST_INIT;
280 values[0].counter = value;
284 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
285 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
286 sstrncpy (vl.type, type, sizeof (vl.type));
287 if (type_inst != NULL)
288 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
290 plugin_dispatch_values (&vl);
291 } /* void memcached_submit_cmd */
294 static void submit_counter2 (const char *type, const char *type_inst,
295 counter_t value0, counter_t value1) /* {{{ */
298 value_list_t vl = VALUE_LIST_INIT;
300 values[0].counter = value0;
301 values[1].counter = value1;
305 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
306 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
307 sstrncpy (vl.type, type, sizeof (vl.type));
308 if (type_inst != NULL)
309 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
311 plugin_dispatch_values (&vl);
312 } /* void memcached_submit_cmd */
315 static void submit_gauge (const char *type, const char *type_inst,
316 gauge_t value) /* {{{ */
319 value_list_t vl = VALUE_LIST_INIT;
321 values[0].gauge = value;
325 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
326 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
327 sstrncpy (vl.type, type, sizeof (vl.type));
328 if (type_inst != NULL)
329 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
331 plugin_dispatch_values (&vl);
335 static void submit_gauge2 (const char *type, const char *type_inst,
336 gauge_t value0, gauge_t value1) /* {{{ */
339 value_list_t vl = VALUE_LIST_INIT;
341 values[0].gauge = value0;
342 values[1].gauge = value1;
346 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
347 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
348 sstrncpy (vl.type, type, sizeof (vl.type));
349 if (type_inst != NULL)
350 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
352 plugin_dispatch_values (&vl);
356 static int memcached_read (void) /* {{{ */
365 gauge_t bytes_used = NAN;
366 gauge_t bytes_total = NAN;
369 counter_t rusage_user = 0;
370 counter_t rusage_syst = 0;
371 counter_t octets_rx = 0;
372 counter_t octets_tx = 0;
374 /* get data from daemon */
375 if (memcached_query_daemon (buf, sizeof (buf)) < 0) {
379 #define FIELD_IS(cnst) \
380 (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
384 while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
390 fields_num = strsplit(line, fields, 3);
394 name_len = strlen(fields[1]);
399 * For an explanation on these fields please refer to
400 * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
404 * CPU time consumed by the memcached process
406 if (FIELD_IS ("rusage_user"))
408 rusage_user = atoll (fields[2]);
410 else if (FIELD_IS ("rusage_system"))
412 rusage_syst = atoll(fields[2]);
416 * Number of threads of this instance
418 else if (FIELD_IS ("threads"))
420 submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]));
424 * Number of items stored
426 else if (FIELD_IS ("curr_items"))
428 submit_gauge ("memcached_items", "current", atof (fields[2]));
432 * Number of bytes used and available (total - used)
434 else if (FIELD_IS ("bytes"))
436 bytes_used = atof (fields[2]);
438 else if (FIELD_IS ("limit_maxbytes"))
440 bytes_total = atof(fields[2]);
446 else if (FIELD_IS ("curr_connections"))
448 submit_gauge ("memcached_connections", "current", atof (fields[2]));
454 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
456 const char *name = fields[1] + 4;
457 submit_counter ("memcached_command", name, atoll (fields[2]));
458 if (strcmp (name, "get") == 0)
459 gets = atof (fields[2]);
463 * Operations on the cache, i. e. cache hits, cache misses and evictions of items
465 else if (FIELD_IS ("get_hits"))
467 submit_counter ("memcached_ops", "hits", atoll (fields[2]));
468 hits = atof (fields[2]);
470 else if (FIELD_IS ("get_misses"))
472 submit_counter ("memcached_ops", "misses", atoll (fields[2]));
474 else if (FIELD_IS ("evictions"))
476 submit_counter ("memcached_ops", "evictions", atoll (fields[2]));
482 else if (FIELD_IS ("bytes_read"))
484 octets_rx = atoll (fields[2]);
486 else if (FIELD_IS ("bytes_written"))
488 octets_tx = atoll (fields[2]);
490 } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
492 if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
493 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used);
495 if ((rusage_user != 0) || (rusage_syst != 0))
496 submit_counter2 ("ps_cputime", NULL, rusage_user, rusage_syst);
498 if ((octets_rx != 0) || (octets_tx != 0))
499 submit_counter2 ("memcached_octets", NULL, octets_rx, octets_tx);
501 if (!isnan (gets) && !isnan (hits))
506 rate = 100.0 * hits / gets;
508 submit_gauge ("percent", "hitratio", rate);
515 void module_register (void) /* {{{ */
517 plugin_register_config ("memcached", memcached_config, config_keys, config_keys_num);
518 plugin_register_read ("memcached", memcached_read);
527 * vim600: sw=4 ts=4 fdm=marker noexpandtab
528 * vim<600: sw=4 ts=4 noexpandtab