2 * collectd - src/redis.c, based on src/memcached.c
3 * Copyright (C) 2010 Andrés J. Díaz <ajdiaz@connectical.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Andrés J. Díaz <ajdiaz@connectical.com>
28 #include <hiredis/hiredis.h>
31 #define REDIS_DEF_HOST "localhost"
32 #define REDIS_DEF_PASSWD ""
33 #define REDIS_DEF_PORT 6379
34 #define REDIS_DEF_TIMEOUT_SEC 2
35 #define REDIS_DEF_DB_COUNT 256
36 #define MAX_REDIS_VAL_SIZE 256
37 #define MAX_REDIS_QUERY 2048
39 /* Redis plugin configuration example:
52 typedef struct redis_query_s redis_query_t;
53 struct redis_query_s {
54 char query[MAX_REDIS_QUERY];
55 char type[DATA_MAX_NAME_LEN];
56 char instance[DATA_MAX_NAME_LEN];
63 typedef struct redis_node_s redis_node_t;
69 struct timeval timeout;
70 bool report_command_stats;
71 redisContext *redisContext;
72 redis_query_t *queries;
77 static bool redis_have_instances;
78 static int redis_read(user_data_t *user_data);
80 static void redis_node_free(void *arg) {
81 redis_node_t *rn = arg;
85 redis_query_t *rq = rn->queries;
87 redis_query_t *next = rq->next;
92 redisFree(rn->redisContext);
97 } /* void redis_node_free */
99 static int redis_node_add(redis_node_t *rn) /* {{{ */
101 DEBUG("redis plugin: Adding node \"%s\".", rn->name);
103 /* Disable automatic generation of default instance in the init callback. */
104 redis_have_instances = true;
106 char cb_name[sizeof("redis/") + DATA_MAX_NAME_LEN];
107 snprintf(cb_name, sizeof(cb_name), "redis/%s", rn->name);
109 return plugin_register_complex_read(
110 /* group = */ "redis",
111 /* name = */ cb_name,
112 /* callback = */ redis_read,
115 .data = rn, .free_func = redis_node_free,
119 static redis_query_t *redis_config_query(oconfig_item_t *ci) /* {{{ */
124 rq = calloc(1, sizeof(*rq));
126 ERROR("redis plugin: calloc failed adding redis_query.");
129 status = cf_util_get_string_buffer(ci, rq->query, sizeof(rq->query));
134 * Default to a gauge type.
136 (void)strncpy(rq->type, "gauge", sizeof(rq->type));
137 (void)sstrncpy(rq->instance, rq->query, sizeof(rq->instance));
138 replace_special(rq->instance, sizeof(rq->instance));
142 for (int i = 0; i < ci->children_num; i++) {
143 oconfig_item_t *option = ci->children + i;
145 if (strcasecmp("Type", option->key) == 0) {
146 status = cf_util_get_string_buffer(option, rq->type, sizeof(rq->type));
147 } else if (strcasecmp("Instance", option->key) == 0) {
149 cf_util_get_string_buffer(option, rq->instance, sizeof(rq->instance));
150 } else if (strcasecmp("Database", option->key) == 0) {
151 status = cf_util_get_int(option, &rq->database);
152 if (rq->database < 0) {
153 WARNING("redis plugin: The \"Database\" option must be positive "
158 WARNING("redis plugin: unknown configuration option: %s", option->key);
170 static int redis_config_node(oconfig_item_t *ci) /* {{{ */
172 redis_node_t *rn = calloc(1, sizeof(*rn));
174 ERROR("redis plugin: calloc failed adding node.");
178 rn->port = REDIS_DEF_PORT;
179 rn->timeout.tv_sec = REDIS_DEF_TIMEOUT_SEC;
181 rn->host = strdup(REDIS_DEF_HOST);
182 if (rn->host == NULL) {
183 ERROR("redis plugin: strdup failed adding node.");
188 int status = cf_util_get_string(ci, &rn->name);
195 for (int i = 0; i < ci->children_num; i++) {
196 oconfig_item_t *option = ci->children + i;
198 if (strcasecmp("Host", option->key) == 0)
199 status = cf_util_get_string(option, &rn->host);
200 else if (strcasecmp("Port", option->key) == 0) {
201 status = cf_util_get_port_number(option);
206 } else if (strcasecmp("Query", option->key) == 0) {
207 redis_query_t *rq = redis_config_query(option);
211 rq->next = rn->queries;
214 } else if (strcasecmp("Timeout", option->key) == 0) {
216 status = cf_util_get_int(option, &timeout);
218 rn->timeout.tv_usec = timeout * 1000;
219 rn->timeout.tv_sec = rn->timeout.tv_usec / 1000000L;
220 rn->timeout.tv_usec %= 1000000L;
222 } else if (strcasecmp("Password", option->key) == 0)
223 status = cf_util_get_string(option, &rn->passwd);
224 else if (strcasecmp("ReportCommandStats", option->key) == 0)
225 status = cf_util_get_boolean(option, &rn->report_command_stats);
227 WARNING("redis plugin: Option `%s' not allowed inside a `Node' "
228 "block. I'll ignore this option.",
240 return redis_node_add(rn);
241 } /* }}} int redis_config_node */
243 static int redis_config(oconfig_item_t *ci) /* {{{ */
245 for (int i = 0; i < ci->children_num; i++) {
246 oconfig_item_t *option = ci->children + i;
248 if (strcasecmp("Node", option->key) == 0)
249 redis_config_node(option);
251 WARNING("redis plugin: Option `%s' not allowed in redis"
252 " configuration. It will be ignored.",
259 __attribute__((nonnull(2))) static void
260 redis_submit(char *plugin_instance, const char *type, const char *type_instance,
261 value_t value) /* {{{ */
263 value_list_t vl = VALUE_LIST_INIT;
267 sstrncpy(vl.plugin, "redis", sizeof(vl.plugin));
268 if (plugin_instance != NULL)
269 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
270 sstrncpy(vl.type, type, sizeof(vl.type));
271 if (type_instance != NULL)
272 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
274 plugin_dispatch_values(&vl);
277 __attribute__((nonnull(2))) static void
278 redis_submit2(char *plugin_instance, const char *type,
279 const char *type_instance, value_t value0,
280 value_t value1) /* {{{ */
282 value_list_t vl = VALUE_LIST_INIT;
283 value_t values[] = {value0, value1};
286 vl.values_len = STATIC_ARRAY_SIZE(values);
288 sstrncpy(vl.plugin, "redis", sizeof(vl.plugin));
289 sstrncpy(vl.type, type, sizeof(vl.type));
291 if (plugin_instance != NULL)
292 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
294 if (type_instance != NULL)
295 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
297 plugin_dispatch_values(&vl);
300 static int redis_init(void) /* {{{ */
302 if (redis_have_instances)
305 redis_node_t *rn = calloc(1, sizeof(*rn));
309 rn->port = REDIS_DEF_PORT;
310 rn->timeout.tv_sec = REDIS_DEF_TIMEOUT_SEC;
312 rn->name = strdup("default");
313 rn->host = strdup(REDIS_DEF_HOST);
315 if (rn->name == NULL || rn->host == NULL)
318 return redis_node_add(rn);
319 } /* }}} int redis_init */
321 static void *c_redisCommand(redis_node_t *rn, const char *format, ...) {
322 redisContext *c = rn->redisContext;
328 va_start(ap, format);
329 void *reply = redisvCommand(c, format, ap);
333 ERROR("redis plugin: Connection error: %s", c->errstr);
334 redisFree(rn->redisContext);
335 rn->redisContext = NULL;
339 } /* void c_redisCommand */
341 static int redis_get_info_value(char const *info_line, char const *field_name,
342 int ds_type, value_t *val) {
343 char *str = strstr(info_line, field_name);
344 static char buf[MAX_REDIS_VAL_SIZE];
348 str += strlen(field_name) + 1; /* also skip the ':' */
349 for (i = 0; (*str && (isdigit((unsigned char)*str) || *str == '.'));
354 if (parse_value(buf, val, ds_type) == -1) {
355 WARNING("redis plugin: Unable to parse field `%s'.", field_name);
362 } /* int redis_get_info_value */
364 static int redis_handle_info(char *node, char const *info_line,
365 char const *type, char const *type_instance,
366 char const *field_name, int ds_type) /* {{{ */
369 if (redis_get_info_value(info_line, field_name, ds_type, &val) != 0)
372 redis_submit(node, type, type_instance, val);
374 } /* }}} int redis_handle_info */
376 static int redis_handle_query(redis_node_t *rn, redis_query_t *rq) /* {{{ */
379 const data_set_t *ds;
382 ds = plugin_get_ds(rq->type);
384 ERROR("redis plugin: DS type `%s' not defined.", rq->type);
388 if (ds->ds_num != 1) {
389 ERROR("redis plugin: DS type `%s' has too many datasources. This is not "
390 "supported currently.",
395 if ((rr = c_redisCommand(rn, "SELECT %d", rq->database)) == NULL) {
396 WARNING("redis plugin: unable to switch to database `%d' on node `%s'.",
397 rq->database, rn->name);
401 if ((rr = c_redisCommand(rn, rq->query)) == NULL) {
402 WARNING("redis plugin: unable to carry out query `%s'.", rq->query);
407 case REDIS_REPLY_INTEGER:
408 switch (ds->ds[0].type) {
409 case DS_TYPE_COUNTER:
410 val.counter = (counter_t)rr->integer;
413 val.gauge = (gauge_t)rr->integer;
416 val.gauge = (derive_t)rr->integer;
418 case DS_TYPE_ABSOLUTE:
419 val.gauge = (absolute_t)rr->integer;
423 case REDIS_REPLY_STRING:
424 if (parse_value(rr->str, &val, ds->ds[0].type) == -1) {
425 WARNING("redis plugin: Query `%s': Unable to parse value.", rq->query);
430 case REDIS_REPLY_ERROR:
431 WARNING("redis plugin: Query `%s' failed: %s.", rq->query, rr->str);
434 case REDIS_REPLY_ARRAY:
435 WARNING("redis plugin: Query `%s' should return string or integer. Arrays "
436 "are not supported.",
441 WARNING("redis plugin: Query `%s': Cannot coerce redis type (%i).",
442 rq->query, rr->type);
447 redis_submit(rn->name, rq->type,
448 (strlen(rq->instance) > 0) ? rq->instance : NULL, val);
451 } /* }}} int redis_handle_query */
453 static int redis_db_stats(char *node, char const *info_line) /* {{{ */
455 /* redis_db_stats parses and dispatches Redis database statistics,
456 * currently the number of keys for each database.
457 * info_line needs to have the following format:
458 * db0:keys=4,expires=0,avg_ttl=0
461 for (int db = 0; db < REDIS_DEF_DB_COUNT; db++) {
462 static char buf[MAX_REDIS_VAL_SIZE];
463 static char field_name[12];
464 static char db_id[4];
469 snprintf(field_name, sizeof(field_name), "db%d:keys=", db);
471 str = strstr(info_line, field_name);
475 str += strlen(field_name);
476 for (i = 0; (*str && isdigit((int)*str)); i++, str++)
480 if (parse_value(buf, &val, DS_TYPE_GAUGE) != 0) {
481 WARNING("redis plugin: Unable to parse field `%s'.", field_name);
485 snprintf(db_id, sizeof(db_id), "%d", db);
486 redis_submit(node, "records", db_id, val);
490 } /* }}} int redis_db_stats */
492 static void redis_check_connection(redis_node_t *rn) {
493 if (rn->redisContext)
496 redisContext *rh = redisConnectWithTimeout(rn->host, rn->port, rn->timeout);
499 ERROR("redis plugin: can't allocate redis context");
503 ERROR("redis plugin: unable to connect to node `%s' (%s:%d): %s.", rn->name,
504 rn->host, rn->port, rh->errstr);
509 rn->redisContext = rh;
514 DEBUG("redis plugin: authenticating node `%s' passwd(%s).", rn->name,
517 if ((rr = c_redisCommand(rn, "AUTH %s", rn->passwd)) == NULL) {
518 WARNING("redis plugin: unable to authenticate on node `%s'.", rn->name);
522 if (rr->type != REDIS_REPLY_STATUS) {
523 WARNING("redis plugin: invalid authentication on node `%s'.", rn->name);
525 redisFree(rn->redisContext);
526 rn->redisContext = NULL;
533 } /* void redis_check_connection */
535 static void redis_read_server_info(redis_node_t *rn) {
538 if ((rr = c_redisCommand(rn, "INFO")) == NULL) {
539 WARNING("redis plugin: unable to get INFO from node `%s'.", rn->name);
543 redis_handle_info(rn->name, rr->str, "uptime", NULL, "uptime_in_seconds",
545 redis_handle_info(rn->name, rr->str, "current_connections", "clients",
546 "connected_clients", DS_TYPE_GAUGE);
547 redis_handle_info(rn->name, rr->str, "blocked_clients", NULL,
548 "blocked_clients", DS_TYPE_GAUGE);
549 redis_handle_info(rn->name, rr->str, "memory", NULL, "used_memory",
551 redis_handle_info(rn->name, rr->str, "memory_lua", NULL, "used_memory_lua",
553 /* changes_since_last_save: Deprecated in redis version 2.6 and above */
554 redis_handle_info(rn->name, rr->str, "volatile_changes", NULL,
555 "changes_since_last_save", DS_TYPE_GAUGE);
556 redis_handle_info(rn->name, rr->str, "total_connections", NULL,
557 "total_connections_received", DS_TYPE_DERIVE);
558 redis_handle_info(rn->name, rr->str, "total_operations", NULL,
559 "total_commands_processed", DS_TYPE_DERIVE);
560 redis_handle_info(rn->name, rr->str, "operations_per_second", NULL,
561 "instantaneous_ops_per_sec", DS_TYPE_GAUGE);
562 redis_handle_info(rn->name, rr->str, "expired_keys", NULL, "expired_keys",
564 redis_handle_info(rn->name, rr->str, "evicted_keys", NULL, "evicted_keys",
566 redis_handle_info(rn->name, rr->str, "pubsub", "channels", "pubsub_channels",
568 redis_handle_info(rn->name, rr->str, "pubsub", "patterns", "pubsub_patterns",
570 redis_handle_info(rn->name, rr->str, "current_connections", "slaves",
571 "connected_slaves", DS_TYPE_GAUGE);
572 redis_handle_info(rn->name, rr->str, "cache_result", "hits", "keyspace_hits",
574 redis_handle_info(rn->name, rr->str, "cache_result", "misses",
575 "keyspace_misses", DS_TYPE_DERIVE);
576 redis_handle_info(rn->name, rr->str, "total_bytes", "input",
577 "total_net_input_bytes", DS_TYPE_DERIVE);
578 redis_handle_info(rn->name, rr->str, "total_bytes", "output",
579 "total_net_output_bytes", DS_TYPE_DERIVE);
585 if (redis_get_info_value(rr->str, "used_cpu_user", DS_TYPE_GAUGE,
589 if (redis_get_info_value(rr->str, "used_cpu_sys", DS_TYPE_GAUGE,
593 redis_submit2(rn->name, "ps_cputime", "daemon",
594 (value_t){.derive = rusage_user.gauge * 1000000},
595 (value_t){.derive = rusage_syst.gauge * 1000000});
603 if (redis_get_info_value(rr->str, "used_cpu_user_children", DS_TYPE_GAUGE,
607 if (redis_get_info_value(rr->str, "used_cpu_sys_children", DS_TYPE_GAUGE,
611 redis_submit2(rn->name, "ps_cputime", "children",
612 (value_t){.derive = rusage_user.gauge * 1000000},
613 (value_t){.derive = rusage_syst.gauge * 1000000});
617 redis_db_stats(rn->name, rr->str);
620 } /* void redis_read_server_info */
622 static void redis_read_command_stats(redis_node_t *rn) {
625 if ((rr = c_redisCommand(rn, "INFO commandstats")) == NULL) {
626 WARNING("redis plugin: node `%s': unable to get `INFO commandstats'.",
631 if (rr->type != REDIS_REPLY_STRING) {
632 WARNING("redis plugin: node `%s' `INFO commandstats' returned unsupported "
639 char command[DATA_MAX_NAME_LEN];
642 char *saveptr = NULL;
643 while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
650 if (strstr(line, "cmdstat_") != line) {
651 ERROR("redis plugin: not found 'cmdstat_' prefix in line '%s'", line);
655 char *values = strstr(line, ":");
656 if (values == NULL) {
657 ERROR("redis plugin: not found ':' separator in line '%s'", line);
661 int cmd_len = values - line - strlen("cmdstat_") + 1;
662 if (cmd_len > DATA_MAX_NAME_LEN)
663 cmd_len = DATA_MAX_NAME_LEN;
665 sstrncpy(command, line + strlen("cmdstat_"), cmd_len);
668 /* cmdstat_publish:calls=20795774,usec=111039258,usec_per_call=5.34 */
671 char *saveptr_line = NULL;
673 while ((field = strtok_r(values, "=,", &saveptr_line)) != NULL) {
676 if ((strcmp(field, "calls") == 0) &&
677 ((field = strtok_r(NULL, "=,", &saveptr_line)) != NULL)) {
681 derive_t calls = strtoll(field, &endptr, 0);
683 if ((endptr == field) || (errno != 0))
686 ERROR("redis plugin: Found CALLS value %lld (%s)", calls, command);
687 redis_submit(rn->name, "commands", command, (value_t){.derive = calls});
691 if ((strcmp(field, "usec") == 0) &&
692 ((field = strtok_r(NULL, "=,", &saveptr_line)) != NULL)) {
696 derive_t calls = strtoll(field, &endptr, 0);
698 if ((endptr == field) || (errno != 0))
701 ERROR("redis plugin: Found USEC value %lld (%s)", calls, command);
702 redis_submit(rn->name, "redis_command_cputime", command,
703 (value_t){.derive = calls});
709 } /* void redis_read_command_stats */
711 static int redis_read(user_data_t *user_data) /* {{{ */
713 redis_node_t *rn = user_data->data;
715 DEBUG("redis plugin: querying info from node `%s' (%s:%d).", rn->name,
718 redis_check_connection(rn);
720 if (!rn->redisContext) /* no connection */
723 redis_read_server_info(rn);
725 if (!rn->redisContext) /* connection lost */
728 if (rn->report_command_stats) {
729 redis_read_command_stats(rn);
731 if (!rn->redisContext) /* connection lost */
735 for (redis_query_t *rq = rn->queries; rq != NULL; rq = rq->next) {
736 redis_handle_query(rn, rq);
737 if (!rn->redisContext) /* connection lost */
745 void module_register(void) /* {{{ */
747 plugin_register_complex_config("redis", redis_config);
748 plugin_register_init("redis", redis_init);