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>
26 #include "utils/common/common.h"
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 derive_t keyspace_hits;
64 derive_t keyspace_misses;
66 typedef struct prev_s prev_t;
69 typedef struct redis_node_s redis_node_t;
76 struct timeval timeout;
77 bool report_command_stats;
78 bool report_cpu_usage;
79 redisContext *redisContext;
80 redis_query_t *queries;
86 static bool redis_have_instances;
87 static int redis_read(user_data_t *user_data);
89 static void redis_node_free(void *arg) {
90 redis_node_t *rn = arg;
94 redis_query_t *rq = rn->queries;
96 redis_query_t *next = rq->next;
101 if (rn->redisContext)
102 redisFree(rn->redisContext);
108 } /* void redis_node_free */
110 static int redis_node_add(redis_node_t *rn) /* {{{ */
112 DEBUG("redis plugin: Adding node \"%s\".", rn->name);
114 /* Disable automatic generation of default instance in the init callback. */
115 redis_have_instances = true;
117 char cb_name[sizeof("redis/") + DATA_MAX_NAME_LEN];
118 ssnprintf(cb_name, sizeof(cb_name), "redis/%s", rn->name);
120 return plugin_register_complex_read(
121 /* group = */ "redis",
122 /* name = */ cb_name,
123 /* callback = */ redis_read,
127 .free_func = redis_node_free,
131 static redis_query_t *redis_config_query(oconfig_item_t *ci) /* {{{ */
136 rq = calloc(1, sizeof(*rq));
138 ERROR("redis plugin: calloc failed adding redis_query.");
141 status = cf_util_get_string_buffer(ci, rq->query, sizeof(rq->query));
146 * Default to a gauge type.
148 (void)strncpy(rq->type, "gauge", sizeof(rq->type));
149 (void)sstrncpy(rq->instance, rq->query, sizeof(rq->instance));
150 replace_special(rq->instance, sizeof(rq->instance));
154 for (int i = 0; i < ci->children_num; i++) {
155 oconfig_item_t *option = ci->children + i;
157 if (strcasecmp("Type", option->key) == 0) {
158 status = cf_util_get_string_buffer(option, rq->type, sizeof(rq->type));
159 } else if (strcasecmp("Instance", option->key) == 0) {
161 cf_util_get_string_buffer(option, rq->instance, sizeof(rq->instance));
162 } else if (strcasecmp("Database", option->key) == 0) {
163 status = cf_util_get_int(option, &rq->database);
164 if (rq->database < 0) {
165 WARNING("redis plugin: The \"Database\" option must be positive "
170 WARNING("redis plugin: unknown configuration option: %s", option->key);
182 static int redis_config_node(oconfig_item_t *ci) /* {{{ */
184 redis_node_t *rn = calloc(1, sizeof(*rn));
186 ERROR("redis plugin: calloc failed adding node.");
190 rn->port = REDIS_DEF_PORT;
191 rn->timeout.tv_sec = REDIS_DEF_TIMEOUT_SEC;
192 rn->report_cpu_usage = true;
194 rn->host = strdup(REDIS_DEF_HOST);
195 if (rn->host == NULL) {
196 ERROR("redis plugin: strdup failed adding node.");
201 int status = cf_util_get_string(ci, &rn->name);
208 for (int i = 0; i < ci->children_num; i++) {
209 oconfig_item_t *option = ci->children + i;
211 if (strcasecmp("Host", option->key) == 0)
212 status = cf_util_get_string(option, &rn->host);
213 else if (strcasecmp("Port", option->key) == 0) {
214 status = cf_util_get_port_number(option);
219 } else if (strcasecmp("Socket", option->key) == 0) {
220 status = cf_util_get_string(option, &rn->socket);
221 } else if (strcasecmp("Query", option->key) == 0) {
222 redis_query_t *rq = redis_config_query(option);
226 rq->next = rn->queries;
229 } else if (strcasecmp("Timeout", option->key) == 0) {
231 status = cf_util_get_int(option, &timeout);
233 rn->timeout.tv_usec = timeout * 1000;
234 rn->timeout.tv_sec = rn->timeout.tv_usec / 1000000L;
235 rn->timeout.tv_usec %= 1000000L;
237 } else if (strcasecmp("Password", option->key) == 0)
238 status = cf_util_get_string(option, &rn->passwd);
239 else if (strcasecmp("ReportCommandStats", option->key) == 0)
240 status = cf_util_get_boolean(option, &rn->report_command_stats);
241 else if (strcasecmp("ReportCpuUsage", option->key) == 0)
242 status = cf_util_get_boolean(option, &rn->report_cpu_usage);
244 WARNING("redis plugin: Option `%s' not allowed inside a `Node' "
245 "block. I'll ignore this option.",
257 return redis_node_add(rn);
258 } /* }}} int redis_config_node */
260 static int redis_config(oconfig_item_t *ci) /* {{{ */
262 for (int i = 0; i < ci->children_num; i++) {
263 oconfig_item_t *option = ci->children + i;
265 if (strcasecmp("Node", option->key) == 0)
266 redis_config_node(option);
268 WARNING("redis plugin: Option `%s' not allowed in redis"
269 " configuration. It will be ignored.",
276 __attribute__((nonnull(2))) static void
277 redis_submit(const char *plugin_instance, const char *type,
278 const char *type_instance, value_t value) /* {{{ */
280 value_list_t vl = VALUE_LIST_INIT;
284 sstrncpy(vl.plugin, "redis", sizeof(vl.plugin));
285 if (plugin_instance != NULL)
286 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
287 sstrncpy(vl.type, type, sizeof(vl.type));
288 if (type_instance != NULL)
289 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
291 plugin_dispatch_values(&vl);
294 __attribute__((nonnull(2))) static void
295 redis_submit2(const char *plugin_instance, const char *type,
296 const char *type_instance, value_t value0,
297 value_t value1) /* {{{ */
299 value_list_t vl = VALUE_LIST_INIT;
300 value_t values[] = {value0, value1};
303 vl.values_len = STATIC_ARRAY_SIZE(values);
305 sstrncpy(vl.plugin, "redis", sizeof(vl.plugin));
306 sstrncpy(vl.type, type, sizeof(vl.type));
308 if (plugin_instance != NULL)
309 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
311 if (type_instance != NULL)
312 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
314 plugin_dispatch_values(&vl);
317 static int redis_init(void) /* {{{ */
319 if (redis_have_instances)
322 redis_node_t *rn = calloc(1, sizeof(*rn));
326 rn->port = REDIS_DEF_PORT;
327 rn->timeout.tv_sec = REDIS_DEF_TIMEOUT_SEC;
329 rn->name = strdup("default");
330 rn->host = strdup(REDIS_DEF_HOST);
332 if (rn->name == NULL || rn->host == NULL) {
339 return redis_node_add(rn);
340 } /* }}} int redis_init */
342 static void *c_redisCommand(redis_node_t *rn, const char *format, ...) {
343 redisContext *c = rn->redisContext;
349 va_start(ap, format);
350 void *reply = redisvCommand(c, format, ap);
354 ERROR("redis plugin: Connection error: %s", c->errstr);
355 redisFree(rn->redisContext);
356 rn->redisContext = NULL;
360 } /* void c_redisCommand */
362 static int redis_get_info_value(char const *info_line, char const *field_name,
363 int ds_type, value_t *val) {
364 char *str = strstr(info_line, field_name);
365 static char buf[MAX_REDIS_VAL_SIZE];
369 str += strlen(field_name) + 1; /* also skip the ':' */
370 for (i = 0; (*str && (isdigit((unsigned char)*str) || *str == '.'));
375 if (parse_value(buf, val, ds_type) == -1) {
376 WARNING("redis plugin: Unable to parse field `%s'.", field_name);
383 } /* int redis_get_info_value */
385 static int redis_handle_info(char *node, char const *info_line,
386 char const *type, char const *type_instance,
387 char const *field_name, int ds_type) /* {{{ */
390 if (redis_get_info_value(info_line, field_name, ds_type, &val) != 0)
393 redis_submit(node, type, type_instance, val);
395 } /* }}} int redis_handle_info */
397 static int redis_handle_query(redis_node_t *rn, redis_query_t *rq) /* {{{ */
400 const data_set_t *ds;
403 ds = plugin_get_ds(rq->type);
405 ERROR("redis plugin: DS type `%s' not defined.", rq->type);
409 if (ds->ds_num != 1) {
410 ERROR("redis plugin: DS type `%s' has too many datasources. This is not "
411 "supported currently.",
416 if ((rr = c_redisCommand(rn, "SELECT %d", rq->database)) == NULL) {
417 WARNING("redis plugin: unable to switch to database `%d' on node `%s'.",
418 rq->database, rn->name);
422 if ((rr = c_redisCommand(rn, rq->query)) == NULL) {
423 WARNING("redis plugin: unable to carry out query `%s'.", rq->query);
428 case REDIS_REPLY_INTEGER:
429 switch (ds->ds[0].type) {
430 case DS_TYPE_COUNTER:
431 val.counter = (counter_t)rr->integer;
434 val.gauge = (gauge_t)rr->integer;
437 val.gauge = (derive_t)rr->integer;
439 case DS_TYPE_ABSOLUTE:
440 val.gauge = (absolute_t)rr->integer;
444 case REDIS_REPLY_STRING:
445 if (parse_value(rr->str, &val, ds->ds[0].type) == -1) {
446 WARNING("redis plugin: Query `%s': Unable to parse value.", rq->query);
451 case REDIS_REPLY_ERROR:
452 WARNING("redis plugin: Query `%s' failed: %s.", rq->query, rr->str);
455 case REDIS_REPLY_ARRAY:
456 WARNING("redis plugin: Query `%s' should return string or integer. Arrays "
457 "are not supported.",
462 WARNING("redis plugin: Query `%s': Cannot coerce redis type (%i).",
463 rq->query, rr->type);
468 redis_submit(rn->name, rq->type,
469 (strlen(rq->instance) > 0) ? rq->instance : NULL, val);
472 } /* }}} int redis_handle_query */
474 static int redis_db_stats(const char *node, char const *info_line) /* {{{ */
476 /* redis_db_stats parses and dispatches Redis database statistics,
477 * currently the number of keys for each database.
478 * info_line needs to have the following format:
479 * db0:keys=4,expires=0,avg_ttl=0
482 for (int db = 0; db < REDIS_DEF_DB_COUNT; db++) {
483 static char buf[MAX_REDIS_VAL_SIZE];
484 static char field_name[12];
485 static char db_id[4];
490 ssnprintf(field_name, sizeof(field_name), "db%d:keys=", db);
492 str = strstr(info_line, field_name);
496 str += strlen(field_name);
497 for (i = 0; (*str && isdigit((int)*str)); i++, str++)
501 if (parse_value(buf, &val, DS_TYPE_GAUGE) != 0) {
502 WARNING("redis plugin: Unable to parse field `%s'.", field_name);
506 ssnprintf(db_id, sizeof(db_id), "%d", db);
507 redis_submit(node, "records", db_id, val);
511 } /* }}} int redis_db_stats */
513 static void redis_cpu_usage(const char *node, char const *info_line) {
518 if (redis_get_info_value(info_line, "used_cpu_user", DS_TYPE_GAUGE,
522 if (redis_get_info_value(info_line, "used_cpu_sys", DS_TYPE_GAUGE,
526 redis_submit2(node, "ps_cputime", "daemon",
527 (value_t){.derive = rusage_user.gauge * 1000000},
528 (value_t){.derive = rusage_syst.gauge * 1000000});
536 if (redis_get_info_value(info_line, "used_cpu_user_children", DS_TYPE_GAUGE,
540 if (redis_get_info_value(info_line, "used_cpu_sys_children", DS_TYPE_GAUGE,
544 redis_submit2(node, "ps_cputime", "children",
545 (value_t){.derive = rusage_user.gauge * 1000000},
546 (value_t){.derive = rusage_syst.gauge * 1000000});
549 } /* void redis_cpu_usage */
551 static gauge_t calculate_ratio_percent(derive_t part1, derive_t part2,
552 derive_t *prev1, derive_t *prev2) {
553 if ((*prev1 == 0) || (*prev2 == 0) || (part1 < *prev1) || (part2 < *prev2)) {
559 derive_t num = part1 - *prev1;
560 derive_t denom = part2 - *prev2 + num;
571 return 100.0 * (gauge_t)num / (gauge_t)denom;
572 } /* gauge_t calculate_ratio_percent */
574 static void redis_keyspace_usage(redis_node_t *rn, char const *info_line) {
575 value_t hits, misses;
577 if (redis_get_info_value(info_line, "keyspace_hits", DS_TYPE_DERIVE, &hits) !=
581 if (redis_get_info_value(info_line, "keyspace_misses", DS_TYPE_DERIVE,
585 redis_submit(rn->name, "cache_result", "hits", hits);
586 redis_submit(rn->name, "cache_result", "misses", misses);
588 prev_t *prev = &rn->prev;
589 gauge_t ratio = calculate_ratio_percent(
590 hits.derive, misses.derive, &prev->keyspace_hits, &prev->keyspace_misses);
591 redis_submit(rn->name, "percent", "hitratio", (value_t){.gauge = ratio});
593 } /* void redis_keyspace_usage */
595 static void redis_check_connection(redis_node_t *rn) {
596 if (rn->redisContext)
600 if (rn->socket != NULL)
601 rh = redisConnectUnixWithTimeout(rn->socket, rn->timeout);
603 rh = redisConnectWithTimeout(rn->host, rn->port, rn->timeout);
606 ERROR("redis plugin: can't allocate redis context");
611 ERROR("redis plugin: unable to connect to node `%s' (%s): %s.", rn->name,
612 rn->socket, rh->errstr);
614 ERROR("redis plugin: unable to connect to node `%s' (%s:%d): %s.",
615 rn->name, rn->host, rn->port, rh->errstr);
620 rn->redisContext = rh;
625 DEBUG("redis plugin: authenticating node `%s' passwd(%s).", rn->name,
628 if ((rr = c_redisCommand(rn, "AUTH %s", rn->passwd)) == NULL) {
629 WARNING("redis plugin: unable to authenticate on node `%s'.", rn->name);
633 if (rr->type != REDIS_REPLY_STATUS) {
634 WARNING("redis plugin: invalid authentication on node `%s'.", rn->name);
636 redisFree(rn->redisContext);
637 rn->redisContext = NULL;
644 } /* void redis_check_connection */
646 static void redis_read_server_info(redis_node_t *rn) {
649 if ((rr = c_redisCommand(rn, "INFO")) == NULL) {
650 WARNING("redis plugin: unable to get INFO from node `%s'.", rn->name);
654 redis_handle_info(rn->name, rr->str, "uptime", NULL, "uptime_in_seconds",
656 redis_handle_info(rn->name, rr->str, "current_connections", "clients",
657 "connected_clients", DS_TYPE_GAUGE);
658 redis_handle_info(rn->name, rr->str, "blocked_clients", NULL,
659 "blocked_clients", DS_TYPE_GAUGE);
660 redis_handle_info(rn->name, rr->str, "memory", NULL, "used_memory",
662 redis_handle_info(rn->name, rr->str, "memory_lua", NULL, "used_memory_lua",
664 /* changes_since_last_save: Deprecated in redis version 2.6 and above */
665 redis_handle_info(rn->name, rr->str, "volatile_changes", NULL,
666 "changes_since_last_save", DS_TYPE_GAUGE);
667 redis_handle_info(rn->name, rr->str, "total_connections", NULL,
668 "total_connections_received", DS_TYPE_DERIVE);
669 redis_handle_info(rn->name, rr->str, "total_operations", NULL,
670 "total_commands_processed", DS_TYPE_DERIVE);
671 redis_handle_info(rn->name, rr->str, "expired_keys", NULL, "expired_keys",
673 redis_handle_info(rn->name, rr->str, "evicted_keys", NULL, "evicted_keys",
675 redis_handle_info(rn->name, rr->str, "pubsub", "channels", "pubsub_channels",
677 redis_handle_info(rn->name, rr->str, "pubsub", "patterns", "pubsub_patterns",
679 redis_handle_info(rn->name, rr->str, "current_connections", "slaves",
680 "connected_slaves", DS_TYPE_GAUGE);
681 redis_handle_info(rn->name, rr->str, "total_bytes", "input",
682 "total_net_input_bytes", DS_TYPE_DERIVE);
683 redis_handle_info(rn->name, rr->str, "total_bytes", "output",
684 "total_net_output_bytes", DS_TYPE_DERIVE);
686 redis_keyspace_usage(rn, rr->str);
688 redis_db_stats(rn->name, rr->str);
690 if (rn->report_cpu_usage)
691 redis_cpu_usage(rn->name, rr->str);
694 } /* void redis_read_server_info */
696 static void redis_read_command_stats(redis_node_t *rn) {
699 if ((rr = c_redisCommand(rn, "INFO commandstats")) == NULL) {
700 WARNING("redis plugin: node `%s': unable to get `INFO commandstats'.",
705 if (rr->type != REDIS_REPLY_STRING) {
706 WARNING("redis plugin: node `%s' `INFO commandstats' returned unsupported "
716 char *saveptr = NULL;
717 while ((line = strtok_r(ptr, "\n\r", &saveptr)) != NULL) {
724 if (strstr(line, "cmdstat_") != line) {
725 ERROR("redis plugin: not found 'cmdstat_' prefix in line '%s'", line);
729 char *values = strstr(line, ":");
730 if (values == NULL) {
731 ERROR("redis plugin: not found ':' separator in line '%s'", line);
735 /* Null-terminate command token */
737 command = line + strlen("cmdstat_");
741 /* cmdstat_publish:calls=20795774,usec=111039258,usec_per_call=5.34 */
743 char *saveptr_field = NULL;
744 while ((field = strtok_r(values, "=", &saveptr_field)) != NULL) {
748 /* only these are supported */
749 if (strcmp(field, "calls") == 0)
751 else if (strcmp(field, "usec") == 0)
752 type = "redis_command_cputime";
756 if ((field = strtok_r(NULL, ",", &saveptr_field)) == NULL)
761 derive_t value = strtoll(field, &endptr, 0);
763 if ((endptr == field) || (errno != 0))
766 redis_submit(rn->name, type, command, (value_t){.derive = value});
770 } /* void redis_read_command_stats */
772 static int redis_read(user_data_t *user_data) /* {{{ */
774 redis_node_t *rn = user_data->data;
778 DEBUG("redis plugin: querying info from node `%s' (%s).", rn->name,
781 DEBUG("redis plugin: querying info from node `%s' (%s:%d).", rn->name,
785 redis_check_connection(rn);
787 if (!rn->redisContext) /* no connection */
790 redis_read_server_info(rn);
792 if (!rn->redisContext) /* connection lost */
795 if (rn->report_command_stats) {
796 redis_read_command_stats(rn);
798 if (!rn->redisContext) /* connection lost */
802 for (redis_query_t *rq = rn->queries; rq != NULL; rq = rq->next) {
803 redis_handle_query(rn, rq);
804 if (!rn->redisContext) /* connection lost */
812 void module_register(void) /* {{{ */
814 plugin_register_complex_config("redis", redis_config);
815 plugin_register_init("redis", redis_init);