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.");
133 memset (&p, 0, sizeof (p));
135 p.events = POLLIN | POLLERR | POLLHUP;
138 status = poll (&p, /* nfds = */ 1, /* timeout = */ interval_g);
143 ERROR ("memcached: poll(2) timed out after %i seconds.", interval_g);
148 ERROR ("memcached: poll(2) failed: %s",
149 sstrerror (errno, errbuf, sizeof (errbuf)));
151 shutdown (fd, SHUT_RDWR);
157 /* receive data from the memcached daemon */
158 memset (buffer, '\0', buffer_size);
161 while ((status = recv (fd, buffer + buffer_fill, buffer_size - buffer_fill, MSG_DONTWAIT)) != 0) {
162 if (i > MEMCACHED_RETRY_COUNT) {
163 ERROR("recv() timed out");
171 if (errno == EAGAIN) {
175 ERROR ("memcached: Error reading from socket: %s",
176 sstrerror (errno, errbuf, sizeof (errbuf)));
177 shutdown(fd, SHUT_RDWR);
181 buffer_fill += status;
183 if (buffer_fill > 3 && buffer[buffer_fill-5] == 'E' && buffer[buffer_fill-4] == 'N' && buffer[buffer_fill-3] == 'D') {
184 /* we got all the data */
189 if (buffer_fill >= buffer_size) {
190 buffer[buffer_size - 1] = '\0';
191 WARNING ("memcached: Message from memcached has been truncated.");
192 } else if (buffer_fill == 0) {
193 WARNING ("memcached: Peer has unexpectedly shut down the socket. "
194 "Buffer: `%s'", buffer);
195 shutdown(fd, SHUT_RDWR);
200 shutdown(fd, SHUT_RDWR);
206 static int memcached_config (const char *key, const char *value) /* {{{ */
208 if (strcasecmp (key, "Host") == 0) {
209 if (memcached_host != NULL) {
210 free (memcached_host);
212 memcached_host = strdup (value);
213 } else if (strcasecmp (key, "Port") == 0) {
214 int port = (int) (atof (value));
215 if ((port > 0) && (port <= 65535)) {
216 ssnprintf (memcached_port, sizeof (memcached_port), "%i", port);
218 sstrncpy (memcached_port, value, sizeof (memcached_port));
228 static void submit_counter (const char *type, const char *type_inst,
229 counter_t value) /* {{{ */
232 value_list_t vl = VALUE_LIST_INIT;
234 values[0].counter = value;
238 vl.time = time (NULL);
239 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
240 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
241 sstrncpy (vl.type, type, sizeof (vl.type));
242 if (type_inst != NULL)
243 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
245 plugin_dispatch_values (&vl);
246 } /* void memcached_submit_cmd */
249 static void submit_counter2 (const char *type, const char *type_inst,
250 counter_t value0, counter_t value1) /* {{{ */
253 value_list_t vl = VALUE_LIST_INIT;
255 values[0].counter = value0;
256 values[1].counter = value1;
260 vl.time = time (NULL);
261 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
262 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
263 sstrncpy (vl.type, type, sizeof (vl.type));
264 if (type_inst != NULL)
265 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
267 plugin_dispatch_values (&vl);
268 } /* void memcached_submit_cmd */
271 static void submit_gauge (const char *type, const char *type_inst,
272 gauge_t value) /* {{{ */
275 value_list_t vl = VALUE_LIST_INIT;
277 values[0].gauge = value;
281 vl.time = time (NULL);
282 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
283 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
284 sstrncpy (vl.type, type, sizeof (vl.type));
285 if (type_inst != NULL)
286 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
288 plugin_dispatch_values (&vl);
292 static void submit_gauge2 (const char *type, const char *type_inst,
293 gauge_t value0, gauge_t value1) /* {{{ */
296 value_list_t vl = VALUE_LIST_INIT;
298 values[0].gauge = value0;
299 values[1].gauge = value1;
303 vl.time = time (NULL);
304 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
305 sstrncpy (vl.plugin, "memcached", sizeof (vl.plugin));
306 sstrncpy (vl.type, type, sizeof (vl.type));
307 if (type_inst != NULL)
308 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
310 plugin_dispatch_values (&vl);
314 static int memcached_read (void) /* {{{ */
323 gauge_t bytes_used = NAN;
324 gauge_t bytes_total = NAN;
325 counter_t rusage_user = 0;
326 counter_t rusage_syst = 0;
327 counter_t octets_rx = 0;
328 counter_t octets_tx = 0;
330 /* get data from daemon */
331 if (memcached_query_daemon (buf, sizeof (buf)) < 0) {
335 #define FIELD_IS(cnst) \
336 (((sizeof(cnst) - 1) == name_len) && (strcmp (cnst, fields[1]) == 0))
340 while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
346 fields_num = strsplit(line, fields, 3);
350 name_len = strlen(fields[1]);
355 * For an explanation on these fields please refer to
356 * <http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt>
360 * CPU time consumed by the memcached process
362 if (FIELD_IS ("rusage_user"))
364 rusage_user = atoll (fields[2]);
366 else if (FIELD_IS ("rusage_system"))
368 rusage_syst = atoll(fields[2]);
372 * Number of threads of this instance
374 else if (FIELD_IS ("threads"))
376 submit_gauge2 ("ps_count", NULL, NAN, atof (fields[2]));
380 * Number of items stored
382 else if (FIELD_IS ("curr_items"))
384 submit_gauge ("memcached_items", "current", atof (fields[2]));
387 else if (FIELD_IS ("total_items"))
389 total_items = atoll(fields[2]);
394 * Number of bytes used and available (total - used)
396 else if (FIELD_IS ("bytes"))
398 bytes_used = atof (fields[2]);
400 else if (FIELD_IS ("limit_maxbytes"))
402 bytes_total = atof(fields[2]);
408 else if (FIELD_IS ("curr_connections"))
410 submit_gauge ("memcached_connections", "current", atof (fields[2]));
413 else if (FIELD_IS("total_connections"))
415 total_connections = atoll(fields[2]);
420 * ``Number of connection structures allocated by the server''
421 else if (FIELD_IS ("connection_structures"))
423 connection_structures = atof(fields[2]);
430 else if ((name_len > 4) && (strncmp (fields[1], "cmd_", 4) == 0))
432 const char *name = fields[1] + 4;
433 submit_counter ("memcached_command", name, atoll (fields[2]));
437 * Operations on the cache, i. e. cache hits, cache misses and evictions of items
439 else if (FIELD_IS ("get_hits"))
441 submit_counter ("memcached_ops", "hits", atoll (fields[2]));
443 else if (FIELD_IS ("get_misses"))
445 submit_counter ("memcached_ops", "misses", atoll (fields[2]));
447 else if (FIELD_IS ("evictions"))
449 submit_counter ("memcached_ops", "evictions", atoll (fields[2]));
455 else if (FIELD_IS ("bytes_read"))
457 octets_rx = atoll (fields[2]);
459 else if (FIELD_IS ("bytes_written"))
461 octets_tx = atoll (fields[2]);
463 } /* while ((line = strtok_r (ptr, "\n\r", &saveptr)) != NULL) */
465 if (!isnan (bytes_used) && !isnan (bytes_total) && (bytes_used <= bytes_total))
466 submit_gauge2 ("df", "cache", bytes_used, bytes_total - bytes_used);
468 if ((rusage_user != 0) || (rusage_syst != 0))
469 submit_counter2 ("ps_cputime", NULL, rusage_user, rusage_syst);
471 if ((octets_rx != 0) || (octets_tx != 0))
472 submit_counter2 ("memcached_octets", NULL, octets_rx, octets_tx);
478 void module_register (void) /* {{{ */
480 plugin_register_config ("memcached", memcached_config, config_keys, config_keys_num);
481 plugin_register_read ("memcached", memcached_read);
490 * vim600: sw=4 ts=4 fdm=marker