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 bool report_cpu_usage;
72 redisContext *redisContext;
73 redis_query_t *queries;
78 static bool redis_have_instances;
79 static int redis_read(user_data_t *user_data);
81 static void redis_node_free(void *arg) {
82 redis_node_t *rn = arg;
86 redis_query_t *rq = rn->queries;
88 redis_query_t *next = rq->next;
93 redisFree(rn->redisContext);
98 } /* void redis_node_free */
100 static int redis_node_add(redis_node_t *rn) /* {{{ */
102 DEBUG("redis plugin: Adding node \"%s\".", rn->name);
104 /* Disable automatic generation of default instance in the init callback. */
105 redis_have_instances = true;
107 char cb_name[sizeof("redis/") + DATA_MAX_NAME_LEN];
108 snprintf(cb_name, sizeof(cb_name), "redis/%s", rn->name);
110 return plugin_register_complex_read(
111 /* group = */ "redis",
112 /* name = */ cb_name,
113 /* callback = */ redis_read,
116 .data = rn, .free_func = redis_node_free,
120 static redis_query_t *redis_config_query(oconfig_item_t *ci) /* {{{ */
125 rq = calloc(1, sizeof(*rq));
127 ERROR("redis plugin: calloc failed adding redis_query.");
130 status = cf_util_get_string_buffer(ci, rq->query, sizeof(rq->query));
135 * Default to a gauge type.
137 (void)strncpy(rq->type, "gauge", sizeof(rq->type));
138 (void)sstrncpy(rq->instance, rq->query, sizeof(rq->instance));
139 replace_special(rq->instance, sizeof(rq->instance));
143 for (int i = 0; i < ci->children_num; i++) {
144 oconfig_item_t *option = ci->children + i;
146 if (strcasecmp("Type", option->key) == 0) {
147 status = cf_util_get_string_buffer(option, rq->type, sizeof(rq->type));
148 } else if (strcasecmp("Instance", option->key) == 0) {
150 cf_util_get_string_buffer(option, rq->instance, sizeof(rq->instance));
151 } else if (strcasecmp("Database", option->key) == 0) {
152 status = cf_util_get_int(option, &rq->database);
153 if (rq->database < 0) {
154 WARNING("redis plugin: The \"Database\" option must be positive "
159 WARNING("redis plugin: unknown configuration option: %s", option->key);
171 static int redis_config_node(oconfig_item_t *ci) /* {{{ */
173 redis_node_t *rn = calloc(1, sizeof(*rn));
175 ERROR("redis plugin: calloc failed adding node.");
179 rn->port = REDIS_DEF_PORT;
180 rn->timeout.tv_sec = REDIS_DEF_TIMEOUT_SEC;
181 rn->report_cpu_usage = true;
183 rn->host = strdup(REDIS_DEF_HOST);
184 if (rn->host == NULL) {
185 ERROR("redis plugin: strdup failed adding node.");
190 int status = cf_util_get_string(ci, &rn->name);
197 for (int i = 0; i < ci->children_num; i++) {
198 oconfig_item_t *option = ci->children + i;
200 if (strcasecmp("Host", option->key) == 0)
201 status = cf_util_get_string(option, &rn->host);
202 else if (strcasecmp("Port", option->key) == 0) {
203 status = cf_util_get_port_number(option);
208 } else if (strcasecmp("Query", option->key) == 0) {
209 redis_query_t *rq = redis_config_query(option);
213 rq->next = rn->queries;
216 } else if (strcasecmp("Timeout", option->key) == 0) {
218 status = cf_util_get_int(option, &timeout);
220 rn->timeout.tv_usec = timeout * 1000;
221 rn->timeout.tv_sec = rn->timeout.tv_usec / 1000000L;
222 rn->timeout.tv_usec %= 1000000L;
224 } else if (strcasecmp("Password", option->key) == 0)
225 status = cf_util_get_string(option, &rn->passwd);
226 else if (strcasecmp("ReportCommandStats", option->key) == 0)
227 status = cf_util_get_boolean(option, &rn->report_command_stats);
228 else if (strcasecmp("ReportCpuUsage", option->key) == 0)
229 status = cf_util_get_boolean(option, &rn->report_cpu_usage);
231 WARNING("redis plugin: Option `%s' not allowed inside a `Node' "
232 "block. I'll ignore this option.",
244 return redis_node_add(rn);
245 } /* }}} int redis_config_node */
247 static int redis_config(oconfig_item_t *ci) /* {{{ */
249 for (int i = 0; i < ci->children_num; i++) {
250 oconfig_item_t *option = ci->children + i;
252 if (strcasecmp("Node", option->key) == 0)
253 redis_config_node(option);
255 WARNING("redis plugin: Option `%s' not allowed in redis"
256 " configuration. It will be ignored.",
263 __attribute__((nonnull(2))) static void
264 redis_submit(const char *plugin_instance, const char *type,
265 const char *type_instance, value_t value) /* {{{ */
267 value_list_t vl = VALUE_LIST_INIT;
271 sstrncpy(vl.plugin, "redis", sizeof(vl.plugin));
272 if (plugin_instance != NULL)
273 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
274 sstrncpy(vl.type, type, sizeof(vl.type));
275 if (type_instance != NULL)
276 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
278 plugin_dispatch_values(&vl);
281 __attribute__((nonnull(2))) static void
282 redis_submit2(const char *plugin_instance, const char *type,
283 const char *type_instance, value_t value0,
284 value_t value1) /* {{{ */
286 value_list_t vl = VALUE_LIST_INIT;
287 value_t values[] = {value0, value1};
290 vl.values_len = STATIC_ARRAY_SIZE(values);
292 sstrncpy(vl.plugin, "redis", sizeof(vl.plugin));
293 sstrncpy(vl.type, type, sizeof(vl.type));
295 if (plugin_instance != NULL)
296 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
298 if (type_instance != NULL)
299 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
301 plugin_dispatch_values(&vl);
304 static int redis_init(void) /* {{{ */
306 if (redis_have_instances)
309 redis_node_t *rn = calloc(1, sizeof(*rn));
313 rn->port = REDIS_DEF_PORT;
314 rn->timeout.tv_sec = REDIS_DEF_TIMEOUT_SEC;
316 rn->name = strdup("default");
317 rn->host = strdup(REDIS_DEF_HOST);
319 if (rn->name == NULL || rn->host == NULL) {
326 return redis_node_add(rn);
327 } /* }}} int redis_init */
329 static void *c_redisCommand(redis_node_t *rn, const char *format, ...) {
330 redisContext *c = rn->redisContext;
336 va_start(ap, format);
337 void *reply = redisvCommand(c, format, ap);
341 ERROR("redis plugin: Connection error: %s", c->errstr);
342 redisFree(rn->redisContext);
343 rn->redisContext = NULL;
347 } /* void c_redisCommand */
349 static int redis_get_info_value(char const *info_line, char const *field_name,
350 int ds_type, value_t *val) {
351 char *str = strstr(info_line, field_name);
352 static char buf[MAX_REDIS_VAL_SIZE];
356 str += strlen(field_name) + 1; /* also skip the ':' */
357 for (i = 0; (*str && (isdigit((unsigned char)*str) || *str == '.'));
362 if (parse_value(buf, val, ds_type) == -1) {
363 WARNING("redis plugin: Unable to parse field `%s'.", field_name);
370 } /* int redis_get_info_value */
372 static int redis_handle_info(char *node, char const *info_line,
373 char const *type, char const *type_instance,
374 char const *field_name, int ds_type) /* {{{ */
377 if (redis_get_info_value(info_line, field_name, ds_type, &val) != 0)
380 redis_submit(node, type, type_instance, val);
382 } /* }}} int redis_handle_info */
384 static int redis_handle_query(redis_node_t *rn, redis_query_t *rq) /* {{{ */
387 const data_set_t *ds;
390 ds = plugin_get_ds(rq->type);
392 ERROR("redis plugin: DS type `%s' not defined.", rq->type);
396 if (ds->ds_num != 1) {
397 ERROR("redis plugin: DS type `%s' has too many datasources. This is not "
398 "supported currently.",
403 if ((rr = c_redisCommand(rn, "SELECT %d", rq->database)) == NULL) {
404 WARNING("redis plugin: unable to switch to database `%d' on node `%s'.",
405 rq->database, rn->name);
409 if ((rr = c_redisCommand(rn, rq->query)) == NULL) {
410 WARNING("redis plugin: unable to carry out query `%s'.", rq->query);
415 case REDIS_REPLY_INTEGER:
416 switch (ds->ds[0].type) {
417 case DS_TYPE_COUNTER:
418 val.counter = (counter_t)rr->integer;
421 val.gauge = (gauge_t)rr->integer;
424 val.gauge = (derive_t)rr->integer;
426 case DS_TYPE_ABSOLUTE:
427 val.gauge = (absolute_t)rr->integer;
431 case REDIS_REPLY_STRING:
432 if (parse_value(rr->str, &val, ds->ds[0].type) == -1) {
433 WARNING("redis plugin: Query `%s': Unable to parse value.", rq->query);
438 case REDIS_REPLY_ERROR:
439 WARNING("redis plugin: Query `%s' failed: %s.", rq->query, rr->str);
442 case REDIS_REPLY_ARRAY:
443 WARNING("redis plugin: Query `%s' should return string or integer. Arrays "
444 "are not supported.",
449 WARNING("redis plugin: Query `%s': Cannot coerce redis type (%i).",
450 rq->query, rr->type);
455 redis_submit(rn->name, rq->type,
456 (strlen(rq->instance) > 0) ? rq->instance : NULL, val);
459 } /* }}} int redis_handle_query */
461 static int redis_db_stats(const char *node, char const *info_line) /* {{{ */
463 /* redis_db_stats parses and dispatches Redis database statistics,
464 * currently the number of keys for each database.
465 * info_line needs to have the following format:
466 * db0:keys=4,expires=0,avg_ttl=0
469 for (int db = 0; db < REDIS_DEF_DB_COUNT; db++) {
470 static char buf[MAX_REDIS_VAL_SIZE];
471 static char field_name[12];
472 static char db_id[4];
477 snprintf(field_name, sizeof(field_name), "db%d:keys=", db);
479 str = strstr(info_line, field_name);
483 str += strlen(field_name);
484 for (i = 0; (*str && isdigit((int)*str)); i++, str++)
488 if (parse_value(buf, &val, DS_TYPE_GAUGE) != 0) {
489 WARNING("redis plugin: Unable to parse field `%s'.", field_name);
493 snprintf(db_id, sizeof(db_id), "%d", db);
494 redis_submit(node, "records", db_id, val);
498 } /* }}} int redis_db_stats */
500 static void redis_cpu_usage(const char *node, char const *info_line) {
505 if (redis_get_info_value(info_line, "used_cpu_user", DS_TYPE_GAUGE,
509 if (redis_get_info_value(info_line, "used_cpu_sys", DS_TYPE_GAUGE,
513 redis_submit2(node, "ps_cputime", "daemon",
514 (value_t){.derive = rusage_user.gauge * 1000000},
515 (value_t){.derive = rusage_syst.gauge * 1000000});
523 if (redis_get_info_value(info_line, "used_cpu_user_children", DS_TYPE_GAUGE,
527 if (redis_get_info_value(info_line, "used_cpu_sys_children", DS_TYPE_GAUGE,
531 redis_submit2(node, "ps_cputime", "children",
532 (value_t){.derive = rusage_user.gauge * 1000000},
533 (value_t){.derive = rusage_syst.gauge * 1000000});
536 } /* void redis_cpu_usage */
538 static void redis_check_connection(redis_node_t *rn) {
539 if (rn->redisContext)
542 redisContext *rh = redisConnectWithTimeout(rn->host, rn->port, rn->timeout);
545 ERROR("redis plugin: can't allocate redis context");
549 ERROR("redis plugin: unable to connect to node `%s' (%s:%d): %s.", rn->name,
550 rn->host, rn->port, rh->errstr);
555 rn->redisContext = rh;
560 DEBUG("redis plugin: authenticating node `%s' passwd(%s).", rn->name,
563 if ((rr = c_redisCommand(rn, "AUTH %s", rn->passwd)) == NULL) {
564 WARNING("redis plugin: unable to authenticate on node `%s'.", rn->name);
568 if (rr->type != REDIS_REPLY_STATUS) {
569 WARNING("redis plugin: invalid authentication on node `%s'.", rn->name);
571 redisFree(rn->redisContext);
572 rn->redisContext = NULL;
579 } /* void redis_check_connection */
581 static void redis_read_server_info(redis_node_t *rn) {
584 if ((rr = c_redisCommand(rn, "INFO")) == NULL) {
585 WARNING("redis plugin: unable to get INFO from node `%s'.", rn->name);
589 redis_handle_info(rn->name, rr->str, "uptime", NULL, "uptime_in_seconds",
591 redis_handle_info(rn->name, rr->str, "current_connections", "clients",
592 "connected_clients", DS_TYPE_GAUGE);
593 redis_handle_info(rn->name, rr->str, "blocked_clients", NULL,
594 "blocked_clients", DS_TYPE_GAUGE);
595 redis_handle_info(rn->name, rr->str, "memory", NULL, "used_memory",
597 redis_handle_info(rn->name, rr->str, "memory_lua", NULL, "used_memory_lua",
599 /* changes_since_last_save: Deprecated in redis version 2.6 and above */
600 redis_handle_info(rn->name, rr->str, "volatile_changes", NULL,
601 "changes_since_last_save", DS_TYPE_GAUGE);
602 redis_handle_info(rn->name, rr->str, "total_connections", NULL,
603 "total_connections_received", DS_TYPE_DERIVE);
604 redis_handle_info(rn->name, rr->str, "total_operations", NULL,
605 "total_commands_processed", DS_TYPE_DERIVE);
606 redis_handle_info(rn->name, rr->str, "operations_per_second", NULL,
607 "instantaneous_ops_per_sec", DS_TYPE_GAUGE);
608 redis_handle_info(rn->name, rr->str, "expired_keys", NULL, "expired_keys",
610 redis_handle_info(rn->name, rr->str, "evicted_keys", NULL, "evicted_keys",
612 redis_handle_info(rn->name, rr->str, "pubsub", "channels", "pubsub_channels",
614 redis_handle_info(rn->name, rr->str, "pubsub", "patterns", "pubsub_patterns",
616 redis_handle_info(rn->name, rr->str, "current_connections", "slaves",
617 "connected_slaves", DS_TYPE_GAUGE);
618 redis_handle_info(rn->name, rr->str, "cache_result", "hits", "keyspace_hits",
620 redis_handle_info(rn->name, rr->str, "cache_result", "misses",
621 "keyspace_misses", DS_TYPE_DERIVE);
622 redis_handle_info(rn->name, rr->str, "total_bytes", "input",
623 "total_net_input_bytes", DS_TYPE_DERIVE);
624 redis_handle_info(rn->name, rr->str, "total_bytes", "output",
625 "total_net_output_bytes", DS_TYPE_DERIVE);
627 redis_db_stats(rn->name, rr->str);
629 if (rn->report_cpu_usage)
630 redis_cpu_usage(rn->name, rr->str);
633 } /* void redis_read_server_info */
635 static void redis_read_command_stats(redis_node_t *rn) {
638 if ((rr = c_redisCommand(rn, "INFO commandstats")) == NULL) {
639 WARNING("redis plugin: node `%s': unable to get `INFO commandstats'.",
644 if (rr->type != REDIS_REPLY_STRING) {
645 WARNING("redis plugin: node `%s' `INFO commandstats' returned unsupported "
655 char *saveptr = NULL;
656 while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
663 if (strstr(line, "cmdstat_") != line) {
664 ERROR("redis plugin: not found 'cmdstat_' prefix in line '%s'", line);
668 char *values = strstr(line, ":");
669 if (values == NULL) {
670 ERROR("redis plugin: not found ':' separator in line '%s'", line);
674 /* Null-terminate command token */
676 command = line + strlen("cmdstat_");
680 /* cmdstat_publish:calls=20795774,usec=111039258,usec_per_call=5.34 */
682 char *saveptr_field = NULL;
683 while ((field = strtok_r(values, "=", &saveptr_field)) != NULL) {
687 /* only these are supported */
688 if (strcmp(field, "calls") == 0)
690 else if (strcmp(field, "usec") == 0)
691 type = "redis_command_cputime";
695 if ((field = strtok_r(NULL, ",", &saveptr_field)) == NULL)
700 derive_t value = strtoll(field, &endptr, 0);
702 if ((endptr == field) || (errno != 0))
705 redis_submit(rn->name, type, command, (value_t){.derive = value});
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);