2 * collectd - src/memcached.c, based on src/hddtemp.c
3 * Copyright (C) 2007 Antony Dovgal
4 * Copyright (C) 2005,2006 Vincent Stehlé
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.
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.
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
21 * Antony Dovgal <tony at daylessday dot org>
22 * Vincent Stehlé <vincent.stehle at free.fr>
23 * Florian octo Forster <octo at verplant.org>
29 #include "configfile.h"
33 # include <sys/socket.h>
34 # include <netinet/in.h>
35 # include <netinet/tcp.h>
37 #define MEMCACHED_DEF_HOST "127.0.0.1"
38 #define MEMCACHED_DEF_PORT "11211"
40 #define MEMCACHED_RETRY_COUNT 100
42 static const char *config_keys[] =
47 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
49 static char *memcached_host = NULL;
50 static char memcached_port[16];
52 static int memcached_query_daemon (char *buffer, int buffer_size) /* {{{ */
61 struct addrinfo ai_hints;
62 struct addrinfo *ai_list, *ai_ptr;
65 memset (&ai_hints, '\0', sizeof (ai_hints));
66 ai_hints.ai_flags = 0;
68 /* ai_hints.ai_flags |= AI_ADDRCONFIG; */
70 ai_hints.ai_family = AF_INET;
71 ai_hints.ai_socktype = SOCK_STREAM;
72 ai_hints.ai_protocol = 0;
74 host = memcached_host;
76 host = MEMCACHED_DEF_HOST;
79 port = memcached_port;
80 if (strlen (port) == 0) {
81 port = MEMCACHED_DEF_PORT;
84 if ((ai_return = getaddrinfo (host, port, NULL, &ai_list)) != 0) {
86 ERROR ("memcached: getaddrinfo (%s, %s): %s",
88 (ai_return == EAI_SYSTEM)
89 ? sstrerror (errno, errbuf, sizeof (errbuf))
90 : gai_strerror (ai_return));
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) {
99 ERROR ("memcached: socket: %s", sstrerror (errno, errbuf, sizeof (errbuf)));
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);
111 /* A socket could be opened and connecting succeeded. We're
116 freeaddrinfo (ai_list);
119 ERROR ("memcached: Could not connect to daemon.");
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.");
132 memset (&p, 0, sizeof (p));
134 p.events = POLLIN | POLLERR | POLLHUP;
137 status = poll (&p, /* nfds = */ 1, /* timeout = */ 1000 * interval_g);
142 ERROR ("memcached: poll(2) timed out after %i seconds.", interval_g);
147 ERROR ("memcached: poll(2) failed: %s",
148 sstrerror (errno, errbuf, sizeof (errbuf)));
150 shutdown (fd, SHUT_RDWR);
156 /* receive data from the memcached daemon */
157 memset (buffer, '\0', buffer_size);
160 while ((status = recv (fd, buffer + buffer_fill, buffer_size - buffer_fill, MSG_DONTWAIT)) != 0) {
161 if (i > MEMCACHED_RETRY_COUNT) {
162 ERROR("recv() timed out");
170 if (errno == EAGAIN) {
174 ERROR ("memcached: Error reading from socket: %s",
175 sstrerror (errno, errbuf, sizeof (errbuf)));
176 shutdown(fd, SHUT_RDWR);
180 buffer_fill += status;
182 if (buffer_fill > 3 && buffer[buffer_fill-5] == 'E' && buffer[buffer_fill-4] == 'N' && buffer[buffer_fill-3] == 'D') {
183 /* we got all the data */
188 if (buffer_fill >= buffer_size) {
189 buffer[buffer_size - 1] = '\0';
190 WARNING ("memcached: Message from memcached has been truncated.");
191 } else if (buffer_fill == 0) {
192 WARNING ("memcached: Peer has unexpectedly shut down the socket. "
193 "Buffer: `%s'", buffer);
194 shutdown(fd, SHUT_RDWR);
199 shutdown(fd, SHUT_RDWR);
205 static int memcached_config (const char *key, const char *value) /* {{{ */
207 if (strcasecmp (key, "Host") == 0) {
208 if (memcached_host != NULL) {
209 free (memcached_host);
211 memcached_host = strdup (value);
212 } else if (strcasecmp (key, "Port") == 0) {
213 int port = (int) (atof (value));
214 if ((port > 0) && (port <= 65535)) {
215 ssnprintf (memcached_port, sizeof (memcached_port), "%i", port);
217 sstrncpy (memcached_port, value, sizeof (memcached_port));
227 static void submit_counter (const char *type, const char *type_inst,
228 counter_t value) /* {{{ */
231 value_list_t vl = VALUE_LIST_INIT;
233 values[0].counter = value;
237 vl.time = time (NULL);
238 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
239 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
240 sstrncpy (vl.type, type, sizeof (vl.type));
241 if (type_inst != NULL)
242 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
244 plugin_dispatch_values (&vl);
245 } /* void memcached_submit_cmd */
248 static void submit_counter2 (const char *type, const char *type_inst,
249 counter_t value0, counter_t value1) /* {{{ */
252 value_list_t vl = VALUE_LIST_INIT;
254 values[0].counter = value0;
255 values[1].counter = value1;
259 vl.time = time (NULL);
260 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
261 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
262 sstrncpy (vl.type, type, sizeof (vl.type));
263 if (type_inst != NULL)
264 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
266 plugin_dispatch_values (&vl);
267 } /* void memcached_submit_cmd */
270 static void submit_gauge (const char *type, const char *type_inst,
271 gauge_t value) /* {{{ */
274 value_list_t vl = VALUE_LIST_INIT;
276 values[0].gauge = value;
280 vl.time = time (NULL);
281 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
282 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
283 sstrncpy (vl.type, type, sizeof (vl.type));
284 if (type_inst != NULL)
285 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
287 plugin_dispatch_values (&vl);
291 static void submit_gauge2 (const char *type, const char *type_inst,
292 gauge_t value0, gauge_t value1) /* {{{ */
295 value_list_t vl = VALUE_LIST_INIT;
297 values[0].gauge = value0;
298 values[1].gauge = value1;
302 vl.time = time (NULL);
303 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
304 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
305 sstrncpy (vl.type, type, sizeof (vl.type));
306 if (type_inst != NULL)
307 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
309 plugin_dispatch_values (&vl);
313 static int memcached_read (void) /* {{{ */
322 gauge_t bytes_used = NAN;
323 gauge_t bytes_total = NAN;
326 counter_t rusage_user = 0;
327 counter_t rusage_syst = 0;
328 counter_t octets_rx = 0;
329 counter_t octets_tx = 0;
331 /* get data from daemon */
332 if (memcached_query_daemon (buf, sizeof (buf)) < 0) {
336 #define FIELD_IS(cnst) \
337 (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
341 while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
347 fields_num = strsplit(line, fields, 3);
351 name_len = strlen(fields[1]);
356 * For an explanation on these fields please refer to
357 * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
361 * CPU time consumed by the memcached process
363 if (FIELD_IS ("rusage_user"))
365 rusage_user = atoll (fields[2]);
367 else if (FIELD_IS ("rusage_system"))
369 rusage_syst = atoll(fields[2]);
373 * Number of threads of this instance
375 else if (FIELD_IS ("threads"))
377 submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]));
381 * Number of items stored
383 else if (FIELD_IS ("curr_items"))
385 submit_gauge ("memcached_items", "current", atof (fields[2]));
388 else if (FIELD_IS ("total_items"))
390 total_items = atoll(fields[2]);
395 * Number of bytes used and available (total - used)
397 else if (FIELD_IS ("bytes"))
399 bytes_used = atof (fields[2]);
401 else if (FIELD_IS ("limit_maxbytes"))
403 bytes_total = atof(fields[2]);
409 else if (FIELD_IS ("curr_connections"))
411 submit_gauge ("memcached_connections", "current", atof (fields[2]));
414 else if (FIELD_IS("total_connections"))
416 total_connections = atoll(fields[2]);
421 * ``Number of connection structures allocated by the server''
422 else if (FIELD_IS ("connection_structures"))
424 connection_structures = atof(fields[2]);
431 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
433 const char *name = fields[1] + 4;
434 submit_counter ("memcached_command", name, atoll (fields[2]));
435 if (strcmp (name, "get") == 0)
436 gets = atof (fields[2]);
440 * Operations on the cache, i. e. cache hits, cache misses and evictions of items
442 else if (FIELD_IS ("get_hits"))
444 submit_counter ("memcached_ops", "hits", atoll (fields[2]));
445 hits = atof (fields[2]);
447 else if (FIELD_IS ("get_misses"))
449 submit_counter ("memcached_ops", "misses", atoll (fields[2]));
451 else if (FIELD_IS ("evictions"))
453 submit_counter ("memcached_ops", "evictions", atoll (fields[2]));
459 else if (FIELD_IS ("bytes_read"))
461 octets_rx = atoll (fields[2]);
463 else if (FIELD_IS ("bytes_written"))
465 octets_tx = atoll (fields[2]);
467 } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
469 if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
470 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used);
472 if ((rusage_user != 0) || (rusage_syst != 0))
473 submit_counter2 ("ps_cputime", NULL, rusage_user, rusage_syst);
475 if ((octets_rx != 0) || (octets_tx != 0))
476 submit_counter2 ("memcached_octets", NULL, octets_rx, octets_tx);
478 if (!isnan (gets) && !isnan (hits))
483 rate = 100.0 * hits / gets;
485 submit_gauge ("percent", "hitratio", rate);
492 void module_register (void) /* {{{ */
494 plugin_register_config ("memcached", memcached_config, config_keys, config_keys_num);
495 plugin_register_read ("memcached", memcached_read);
504 * vim600: sw=4 ts=4 fdm=marker