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>
27 #include "configfile.h"
30 #include <hiredis/hiredis.h>
33 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
36 #define REDIS_DEF_HOST "localhost"
37 #define REDIS_DEF_PASSWD ""
38 #define REDIS_DEF_PORT 6379
39 #define REDIS_DEF_TIMEOUT 2000
40 #define MAX_REDIS_NODE_NAME 64
41 #define MAX_REDIS_PASSWD_LENGTH 512
42 #define MAX_REDIS_VAL_SIZE 256
43 #define MAX_REDIS_QUERY 2048
45 /* Redis plugin configuration example:
58 typedef struct redis_query_s redis_query_t;
61 char query[MAX_REDIS_QUERY];
62 char type[DATA_MAX_NAME_LEN];
63 char instance[DATA_MAX_NAME_LEN];
68 typedef struct redis_node_s redis_node_t;
71 char name[MAX_REDIS_NODE_NAME];
72 char host[HOST_NAME_MAX];
73 char passwd[MAX_REDIS_PASSWD_LENGTH];
75 struct timeval timeout;
76 redis_query_t *queries;
81 static redis_node_t *nodes_head = NULL;
83 static int redis_node_add (const redis_node_t *rn) /* {{{ */
85 redis_node_t *rn_copy;
88 /* Check for duplicates first */
89 for (rn_ptr = nodes_head; rn_ptr != NULL; rn_ptr = rn_ptr->next)
90 if (strcmp (rn->name, rn_ptr->name) == 0)
95 ERROR ("redis plugin: A node with the name `%s' already exists.",
100 rn_copy = malloc (sizeof (*rn_copy));
103 ERROR ("redis plugin: malloc failed adding redis_node to the tree.");
107 memcpy (rn_copy, rn, sizeof (*rn_copy));
108 rn_copy->next = NULL;
110 DEBUG ("redis plugin: Adding node \"%s\".", rn->name);
112 if (nodes_head == NULL)
113 nodes_head = rn_copy;
117 while (rn_ptr->next != NULL)
118 rn_ptr = rn_ptr->next;
119 rn_ptr->next = rn_copy;
125 static redis_query_t *redis_config_query (oconfig_item_t *ci) /* {{{ */
130 rq = calloc(1, sizeof(*rq));
132 ERROR("redis plugin: calloc failed adding redis_query.");
135 status = cf_util_get_string_buffer(ci, rq->query, sizeof(rq->query));
140 * Default to a gauge type.
142 (void)strncpy(rq->type, "gauge", sizeof(rq->type));
143 (void)sstrncpy(rq->instance, rq->query, sizeof(rq->instance));
144 replace_special(rq->instance, sizeof(rq->instance));
146 for (int i = 0; i < ci->children_num; i++) {
147 oconfig_item_t *option = ci->children + i;
149 if (strcasecmp("Type", option->key) == 0) {
150 status = cf_util_get_string_buffer(option, rq->type, sizeof(rq->type));
151 } else if (strcasecmp("Instance", option->key) == 0) {
152 status = cf_util_get_string_buffer(option, rq->instance, sizeof(rq->instance));
154 WARNING("redis plugin: unknown configuration option: %s", option->key);
166 static int redis_config_node (oconfig_item_t *ci) /* {{{ */
173 .port = REDIS_DEF_PORT,
174 .timeout.tv_usec = REDIS_DEF_TIMEOUT
177 sstrncpy (rn.host, REDIS_DEF_HOST, sizeof (rn.host));
179 status = cf_util_get_string_buffer (ci, rn.name, sizeof (rn.name));
183 for (int i = 0; i < ci->children_num; i++)
185 oconfig_item_t *option = ci->children + i;
187 if (strcasecmp ("Host", option->key) == 0)
188 status = cf_util_get_string_buffer (option, rn.host, sizeof (rn.host));
189 else if (strcasecmp ("Port", option->key) == 0)
191 status = cf_util_get_port_number (option);
198 else if (strcasecmp ("Query", option->key) == 0)
200 rq = redis_config_query(option);
204 rq->next = rn.queries;
208 else if (strcasecmp ("Timeout", option->key) == 0)
210 status = cf_util_get_int (option, &timeout);
211 if (status == 0) rn.timeout.tv_usec = timeout;
213 else if (strcasecmp ("Password", option->key) == 0)
214 status = cf_util_get_string_buffer (option, rn.passwd, sizeof (rn.passwd));
216 WARNING ("redis plugin: Option `%s' not allowed inside a `Node' "
217 "block. I'll ignore this option.", option->key);
226 return (redis_node_add (&rn));
227 } /* }}} int redis_config_node */
229 static int redis_config (oconfig_item_t *ci) /* {{{ */
231 for (int i = 0; i < ci->children_num; i++)
233 oconfig_item_t *option = ci->children + i;
235 if (strcasecmp ("Node", option->key) == 0)
236 redis_config_node (option);
238 WARNING ("redis plugin: Option `%s' not allowed in redis"
239 " configuration. It will be ignored.", option->key);
242 if (nodes_head == NULL)
244 ERROR ("redis plugin: No valid node configuration could be found.");
251 __attribute__ ((nonnull(2)))
252 static void redis_submit (char *plugin_instance,
253 const char *type, const char *type_instance,
254 value_t value) /* {{{ */
257 value_list_t vl = VALUE_LIST_INIT;
263 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
264 sstrncpy (vl.plugin, "redis", sizeof (vl.plugin));
265 if (plugin_instance != NULL)
266 sstrncpy (vl.plugin_instance, plugin_instance,
267 sizeof (vl.plugin_instance));
268 sstrncpy (vl.type, type, sizeof (vl.type));
269 if (type_instance != NULL)
270 sstrncpy (vl.type_instance, type_instance,
271 sizeof (vl.type_instance));
273 plugin_dispatch_values (&vl);
276 static int redis_init (void) /* {{{ */
280 .host = REDIS_DEF_HOST,
281 .port = REDIS_DEF_PORT,
283 .timeout.tv_usec = REDIS_DEF_TIMEOUT,
287 if (nodes_head == NULL)
288 redis_node_add (&rn);
291 } /* }}} int redis_init */
293 static int redis_handle_info (char *node, char const *info_line, char const *type, char const *type_instance, char const *field_name, int ds_type) /* {{{ */
295 char *str = strstr (info_line, field_name);
296 static char buf[MAX_REDIS_VAL_SIZE];
302 str += strlen (field_name) + 1; /* also skip the ':' */
303 for(i=0;(*str && (isdigit((unsigned char)*str) || *str == '.'));i++,str++)
307 if(parse_value (buf, &val, ds_type) == -1)
309 WARNING ("redis plugin: Unable to parse field `%s'.", field_name);
313 redis_submit (node, type, type_instance, val);
318 } /* }}} int redis_handle_info */
320 static int redis_handle_query (redisContext *rh, redis_node_t *rn, redis_query_t *rq) /* {{{ */
323 const data_set_t *ds;
326 ds = plugin_get_ds (rq->type);
328 ERROR ("redis plugin: DataSet `%s' not defined.", rq->type);
332 if (ds->ds_num != 1) {
333 ERROR ("redis plugin: DS `%s' has too many types.", rq->type);
337 if ((rr = redisCommand(rh, rq->query)) == NULL) {
338 WARNING("redis plugin: unable to carry out query `%s'.", rq->query);
343 case REDIS_REPLY_INTEGER:
344 switch (ds->ds[0].type) {
345 case DS_TYPE_COUNTER:
346 val.counter = (counter_t)rr->integer;
349 val.gauge = (gauge_t)rr->integer;
352 val.gauge = (derive_t)rr->integer;
354 case DS_TYPE_ABSOLUTE:
355 val.gauge = (absolute_t)rr->integer;
359 case REDIS_REPLY_STRING:
360 if (parse_value (rr->str, &val, ds->ds[0].type) == -1) {
361 WARNING("redis plugin: Unable to parse field `%s'.", rq->type);
362 freeReplyObject (rr);
367 WARNING("redis plugin: Cannot coerce redis type.");
372 redis_submit(rn->name, rq->type, (strlen(rq->instance) >0)?rq->instance:NULL, val);
373 freeReplyObject (rr);
375 } /* }}} int redis_handle_query */
377 static int redis_read (void) /* {{{ */
379 for (redis_node_t *rn = nodes_head; rn != NULL; rn = rn->next)
384 DEBUG ("redis plugin: querying info from node `%s' (%s:%d).", rn->name, rn->host, rn->port);
386 rh = redisConnectWithTimeout ((char *)rn->host, rn->port, rn->timeout);
389 ERROR ("redis plugin: unable to connect to node `%s' (%s:%d).", rn->name, rn->host, rn->port);
393 if (strlen (rn->passwd) > 0)
395 DEBUG ("redis plugin: authenticating node `%s' passwd(%s).", rn->name, rn->passwd);
397 if ((rr = redisCommand (rh, "AUTH %s", rn->passwd)) == NULL)
399 WARNING ("redis plugin: unable to authenticate on node `%s'.", rn->name);
403 if (rr->type != REDIS_REPLY_STATUS)
405 WARNING ("redis plugin: invalid authentication on node `%s'.", rn->name);
409 freeReplyObject (rr);
412 if ((rr = redisCommand(rh, "INFO")) == NULL)
414 WARNING ("redis plugin: unable to get info from node `%s'.", rn->name);
418 redis_handle_info (rn->name, rr->str, "uptime", NULL, "uptime_in_seconds", DS_TYPE_GAUGE);
419 redis_handle_info (rn->name, rr->str, "current_connections", "clients", "connected_clients", DS_TYPE_GAUGE);
420 redis_handle_info (rn->name, rr->str, "blocked_clients", NULL, "blocked_clients", DS_TYPE_GAUGE);
421 redis_handle_info (rn->name, rr->str, "memory", NULL, "used_memory", DS_TYPE_GAUGE);
422 redis_handle_info (rn->name, rr->str, "memory_lua", NULL, "used_memory_lua", DS_TYPE_GAUGE);
423 /* changes_since_last_save: Deprecated in redis version 2.6 and above */
424 redis_handle_info (rn->name, rr->str, "volatile_changes", NULL, "changes_since_last_save", DS_TYPE_GAUGE);
425 redis_handle_info (rn->name, rr->str, "total_connections", NULL, "total_connections_received", DS_TYPE_DERIVE);
426 redis_handle_info (rn->name, rr->str, "total_operations", NULL, "total_commands_processed", DS_TYPE_DERIVE);
427 redis_handle_info (rn->name, rr->str, "operations_per_second", NULL, "instantaneous_ops_per_sec", DS_TYPE_GAUGE);
428 redis_handle_info (rn->name, rr->str, "expired_keys", NULL, "expired_keys", DS_TYPE_DERIVE);
429 redis_handle_info (rn->name, rr->str, "evicted_keys", NULL, "evicted_keys", DS_TYPE_DERIVE);
430 redis_handle_info (rn->name, rr->str, "pubsub", "channels", "pubsub_channels", DS_TYPE_GAUGE);
431 redis_handle_info (rn->name, rr->str, "pubsub", "patterns", "pubsub_patterns", DS_TYPE_GAUGE);
432 redis_handle_info (rn->name, rr->str, "current_connections", "slaves", "connected_slaves", DS_TYPE_GAUGE);
433 redis_handle_info (rn->name, rr->str, "cache_result", "hits", "keyspace_hits", DS_TYPE_DERIVE);
434 redis_handle_info (rn->name, rr->str, "cache_result", "misses", "keyspace_misses", DS_TYPE_DERIVE);
435 redis_handle_info (rn->name, rr->str, "total_bytes", "input", "total_net_input_bytes", DS_TYPE_DERIVE);
436 redis_handle_info (rn->name, rr->str, "total_bytes", "output", "total_net_output_bytes", DS_TYPE_DERIVE);
438 for (redis_query_t *rq = rn->queries; rq != NULL; rq = rq->next)
439 redis_handle_query(rh, rn, rq);
443 freeReplyObject (rr);
451 void module_register (void) /* {{{ */
453 plugin_register_complex_config ("redis", redis_config);
454 plugin_register_init ("redis", redis_init);
455 plugin_register_read ("redis", redis_read);
456 /* TODO: plugin_register_write: one redis list per value id with
461 /* vim: set sw=2 sts=2 et fdm=marker : */