src/redis.c

   1 /**
   2  * collectd - src/redis.c, based on src/memcached.c
   3  * Copyright (C) 2010       Andrés J. Díaz <ajdiaz@connectical.com>
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  *
  19  * Authors:
  20  *   Andrés J. Díaz <ajdiaz@connectical.com>
  21  **/
  22
  23 #include "collectd.h"
  24 #include "common.h"
  25 #include "plugin.h"
  26 #include "configfile.h"
  27
  28 #include <pthread.h>
  29 #include <sys/time.h>
  30 #include <hiredis/hiredis.h>
  31
  32 #ifndef HOST_NAME_MAX
  33 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
  34 #endif
  35
  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
  44
  45 /* Redis plugin configuration example:
  46  *
  47  * <Plugin redis>
  48  *   <Node "mynode">
  49  *     Host "localhost"
  50  *     Port "6379"
  51  *     Timeout 2
  52  *     Password "foobar"
  53  *   </Node>
  54  * </Plugin>
  55  */
  56
  57 struct redis_query_s;
  58 typedef struct redis_query_s redis_query_t;
  59 struct redis_query_s
  60 {
  61     char query[MAX_REDIS_QUERY];
  62     char type[DATA_MAX_NAME_LEN];
  63     char instance[DATA_MAX_NAME_LEN];
  64     redis_query_t *next;
  65 };
  66
  67 struct redis_node_s;
  68 typedef struct redis_node_s redis_node_t;
  69 struct redis_node_s
  70 {
  71   char name[MAX_REDIS_NODE_NAME];
  72   char host[HOST_NAME_MAX];
  73   char passwd[MAX_REDIS_PASSWD_LENGTH];
  74   int port;
  75   struct timeval timeout;
  76   redis_query_t *queries;
  77
  78   redis_node_t *next;
  79 };
  80
  81 static redis_node_t *nodes_head = NULL;
  82
  83 static int redis_node_add (const redis_node_t *rn) /* {{{ */
  84 {
  85   redis_node_t *rn_copy;
  86   redis_node_t *rn_ptr;
  87
  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)
  91       break;
  92
  93   if (rn_ptr != NULL)
  94   {
  95     ERROR ("redis plugin: A node with the name `%s' already exists.",
  96         rn->name);
  97     return (-1);
  98   }
  99
 100   rn_copy = malloc (sizeof (*rn_copy));
 101   if (rn_copy == NULL)
 102   {
 103     ERROR ("redis plugin: malloc failed adding redis_node to the tree.");
 104     return (-1);
 105   }
 106
 107   memcpy (rn_copy, rn, sizeof (*rn_copy));
 108   rn_copy->next = NULL;
 109
 110   DEBUG ("redis plugin: Adding node \"%s\".", rn->name);
 111
 112   if (nodes_head == NULL)
 113     nodes_head = rn_copy;
 114   else
 115   {
 116     rn_ptr = nodes_head;
 117     while (rn_ptr->next != NULL)
 118       rn_ptr = rn_ptr->next;
 119     rn_ptr->next = rn_copy;
 120   }
 121
 122   return (0);
 123 } /* }}} */
 124
 125 static redis_query_t *redis_config_query (oconfig_item_t *ci) /* {{{ */
 126 {
 127     redis_query_t *rq;
 128     int status;
 129     int i;
 130
 131     rq = calloc(1, sizeof(*rq));
 132     if (rq == NULL) {
 133         ERROR("redis plugin: calloc failed adding redis_query.");
 134         return NULL;
 135     }
 136     status = cf_util_get_string_buffer(ci, rq->query, sizeof(rq->query));
 137     if (status != 0)
 138         goto err;
 139
 140     /*
 141      * Default to a gauge type.
 142      */
 143     (void)strncpy(rq->type, "gauge", sizeof(rq->type));
 144     (void)sstrncpy(rq->instance, rq->query, sizeof(rq->instance));
 145     replace_special(rq->instance, sizeof(rq->instance));
 146
 147     for (i = 0; i < ci->children_num; i++) {
 148         oconfig_item_t *option = ci->children + i;
 149
 150         if (strcasecmp("Type", option->key) == 0) {
 151             status = cf_util_get_string_buffer(option, rq->type, sizeof(rq->type));
 152         } else if (strcasecmp("Instance", option->key) == 0) {
 153             status = cf_util_get_string_buffer(option, rq->instance, sizeof(rq->instance));
 154         } else {
 155             WARNING("redis plugin: unknown configuration option: %s", option->key);
 156             status = -1;
 157         }
 158         if (status != 0)
 159             goto err;
 160     }
 161     return rq;
 162  err:
 163     free(rq);
 164     return NULL;
 165 } /* }}} */
 166
 167 static int redis_config_node (oconfig_item_t *ci) /* {{{ */
 168 {
 169   redis_node_t rn;
 170   redis_query_t *rq;
 171   int i;
 172   int status;
 173   int timeout;
 174
 175   memset (&rn, 0, sizeof (rn));
 176   sstrncpy (rn.host, REDIS_DEF_HOST, sizeof (rn.host));
 177   rn.port = REDIS_DEF_PORT;
 178   rn.timeout.tv_usec = REDIS_DEF_TIMEOUT;
 179   rn.queries = NULL;
 180
 181   status = cf_util_get_string_buffer (ci, rn.name, sizeof (rn.name));
 182   if (status != 0)
 183     return (status);
 184
 185   for (i = 0; i < ci->children_num; i++)
 186   {
 187     oconfig_item_t *option = ci->children + i;
 188
 189     if (strcasecmp ("Host", option->key) == 0)
 190       status = cf_util_get_string_buffer (option, rn.host, sizeof (rn.host));
 191     else if (strcasecmp ("Port", option->key) == 0)
 192     {
 193       status = cf_util_get_port_number (option);
 194       if (status > 0)
 195       {
 196         rn.port = status;
 197         status = 0;
 198       }
 199     }
 200     else if (strcasecmp ("Query", option->key) == 0)
 201     {
 202       rq = redis_config_query(option);
 203       if (rq == NULL) {
 204           status =1;
 205       } else {
 206           rq->next = rn.queries;
 207           rn.queries = rq;
 208       }
 209     }
 210     else if (strcasecmp ("Timeout", option->key) == 0)
 211     {
 212       status = cf_util_get_int (option, &timeout);
 213       if (status == 0) rn.timeout.tv_usec = timeout;
 214     }
 215     else if (strcasecmp ("Password", option->key) == 0)
 216       status = cf_util_get_string_buffer (option, rn.passwd, sizeof (rn.passwd));
 217     else
 218       WARNING ("redis plugin: Option `%s' not allowed inside a `Node' "
 219           "block. I'll ignore this option.", option->key);
 220
 221     if (status != 0)
 222       break;
 223   }
 224
 225   if (status != 0)
 226     return (status);
 227
 228   return (redis_node_add (&rn));
 229 } /* }}} int redis_config_node */
 230
 231 static int redis_config (oconfig_item_t *ci) /* {{{ */
 232 {
 233   int i;
 234
 235   for (i = 0; i < ci->children_num; i++)
 236   {
 237     oconfig_item_t *option = ci->children + i;
 238
 239     if (strcasecmp ("Node", option->key) == 0)
 240       redis_config_node (option);
 241     else
 242       WARNING ("redis plugin: Option `%s' not allowed in redis"
 243           " configuration. It will be ignored.", option->key);
 244   }
 245
 246   if (nodes_head == NULL)
 247   {
 248     ERROR ("redis plugin: No valid node configuration could be found.");
 249     return (ENOENT);
 250   }
 251
 252   return (0);
 253 } /* }}} */
 254
 255   __attribute__ ((nonnull(2)))
 256 static void redis_submit (char *plugin_instance,
 257     const char *type, const char *type_instance,
 258     value_t value) /* {{{ */
 259 {
 260   value_t values[1];
 261   value_list_t vl = VALUE_LIST_INIT;
 262
 263   values[0] = value;
 264
 265   vl.values = values;
 266   vl.values_len = 1;
 267   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 268   sstrncpy (vl.plugin, "redis", sizeof (vl.plugin));
 269   if (plugin_instance != NULL)
 270     sstrncpy (vl.plugin_instance, plugin_instance,
 271         sizeof (vl.plugin_instance));
 272   sstrncpy (vl.type, type, sizeof (vl.type));
 273   if (type_instance != NULL)
 274     sstrncpy (vl.type_instance, type_instance,
 275         sizeof (vl.type_instance));
 276
 277   plugin_dispatch_values (&vl);
 278 } /* }}} */
 279
 280 static int redis_init (void) /* {{{ */
 281 {
 282   redis_node_t rn = {
 283     .name = "default",
 284     .host = REDIS_DEF_HOST,
 285     .port = REDIS_DEF_PORT,
 286     .timeout.tv_sec = 0,
 287     .timeout.tv_usec = REDIS_DEF_TIMEOUT,
 288     .next = NULL
 289 };
 290
 291   if (nodes_head == NULL)
 292     redis_node_add (&rn);
 293
 294   return (0);
 295 } /* }}} int redis_init */
 296
 297 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) /* {{{ */
 298 {
 299   char *str = strstr (info_line, field_name);
 300   static char buf[MAX_REDIS_VAL_SIZE];
 301   value_t val;
 302   if (str)
 303   {
 304     int i;
 305
 306     str += strlen (field_name) + 1; /* also skip the ':' */
 307     for(i=0;(*str && (isdigit((unsigned char)*str) || *str == '.'));i++,str++)
 308       buf[i] = *str;
 309     buf[i] ='\0';
 310
 311     if(parse_value (buf, &val, ds_type) == -1)
 312     {
 313       WARNING ("redis plugin: Unable to parse field `%s'.", field_name);
 314       return (-1);
 315     }
 316
 317     redis_submit (node, type, type_instance, val);
 318     return (0);
 319   }
 320   return (-1);
 321
 322 } /* }}} int redis_handle_info */
 323
 324 static int redis_handle_query (redisContext *rh, redis_node_t *rn, redis_query_t *rq) /* {{{ */
 325 {
 326     redisReply *rr;
 327     const data_set_t *ds;
 328     value_t val;
 329
 330     ds = plugin_get_ds (rq->type);
 331     if (!ds) {
 332         ERROR ("redis plugin: DataSet `%s' not defined.", rq->type);
 333         return (-1);
 334     }
 335
 336     if (ds->ds_num != 1) {
 337         ERROR ("redis plugin: DS `%s' has too many types.", rq->type);
 338         return (-1);
 339     }
 340
 341     if ((rr = redisCommand(rh, rq->query)) == NULL) {
 342         WARNING("redis plugin: unable to carry out query `%s'.", rq->query);
 343         return (-1);
 344     }
 345
 346     switch (rr->type) {
 347     case REDIS_REPLY_INTEGER:
 348         switch (ds->ds[0].type) {
 349         case DS_TYPE_COUNTER:
 350             val.counter = (counter_t)rr->integer;
 351             break;
 352         case DS_TYPE_GAUGE:
 353             val.gauge = (gauge_t)rr->integer;
 354             break;
 355         case DS_TYPE_DERIVE:
 356             val.gauge = (derive_t)rr->integer;
 357             break;
 358         case DS_TYPE_ABSOLUTE:
 359             val.gauge = (absolute_t)rr->integer;
 360             break;
 361         }
 362         break;
 363     case REDIS_REPLY_STRING:
 364         if (parse_value (rr->str, &val, ds->ds[0].type) == -1) {
 365             WARNING("redis plugin: Unable to parse field `%s'.", rq->type);
 366             freeReplyObject (rr);
 367             return (-1);
 368         }
 369         break;
 370     default:
 371         WARNING("redis plugin: Cannot coerce redis type.");
 372         freeReplyObject(rr);
 373         return (-1);
 374     }
 375
 376     redis_submit(rn->name, rq->type, (strlen(rq->instance) >0)?rq->instance:NULL, val);
 377     freeReplyObject (rr);
 378     return 0;
 379 } /* }}} int redis_handle_query */
 380
 381 static int redis_read (void) /* {{{ */
 382 {
 383   redis_node_t *rn;
 384   redis_query_t *rq;
 385
 386   for (rn = nodes_head; rn != NULL; rn = rn->next)
 387   {
 388     redisContext *rh;
 389     redisReply   *rr;
 390
 391     DEBUG ("redis plugin: querying info from node `%s' (%s:%d).", rn->name, rn->host, rn->port);
 392
 393     rh = redisConnectWithTimeout ((char *)rn->host, rn->port, rn->timeout);
 394     if (rh == NULL)
 395     {
 396       ERROR ("redis plugin: unable to connect to node `%s' (%s:%d).", rn->name, rn->host, rn->port);
 397       continue;
 398     }
 399
 400     if (strlen (rn->passwd) > 0)
 401     {
 402       DEBUG ("redis plugin: authenticating node `%s' passwd(%s).", rn->name, rn->passwd);
 403
 404       if ((rr = redisCommand (rh, "AUTH %s", rn->passwd)) == NULL)
 405       {
 406         WARNING ("redis plugin: unable to authenticate on node `%s'.", rn->name);
 407         goto redis_fail;
 408       }
 409
 410       if (rr->type != REDIS_REPLY_STATUS)
 411       {
 412         WARNING ("redis plugin: invalid authentication on node `%s'.", rn->name);
 413         goto redis_fail;
 414       }
 415
 416       freeReplyObject (rr);
 417     }
 418
 419     if ((rr = redisCommand(rh, "INFO")) == NULL)
 420     {
 421       WARNING ("redis plugin: unable to get info from node `%s'.", rn->name);
 422       goto redis_fail;
 423     }
 424
 425     redis_handle_info (rn->name, rr->str, "uptime", NULL, "uptime_in_seconds", DS_TYPE_GAUGE);
 426     redis_handle_info (rn->name, rr->str, "current_connections", "clients", "connected_clients", DS_TYPE_GAUGE);
 427     redis_handle_info (rn->name, rr->str, "blocked_clients", NULL, "blocked_clients", DS_TYPE_GAUGE);
 428     redis_handle_info (rn->name, rr->str, "memory", NULL, "used_memory", DS_TYPE_GAUGE);
 429     redis_handle_info (rn->name, rr->str, "memory_lua", NULL, "used_memory_lua", DS_TYPE_GAUGE);
 430     /* changes_since_last_save: Deprecated in redis version 2.6 and above */
 431     redis_handle_info (rn->name, rr->str, "volatile_changes", NULL, "changes_since_last_save", DS_TYPE_GAUGE);
 432     redis_handle_info (rn->name, rr->str, "total_connections", NULL, "total_connections_received", DS_TYPE_DERIVE);
 433     redis_handle_info (rn->name, rr->str, "total_operations", NULL, "total_commands_processed", DS_TYPE_DERIVE);
 434     redis_handle_info (rn->name, rr->str, "expired_keys", NULL, "expired_keys", DS_TYPE_DERIVE);
 435     redis_handle_info (rn->name, rr->str, "evicted_keys", NULL, "evicted_keys", DS_TYPE_DERIVE);
 436     redis_handle_info (rn->name, rr->str, "pubsub", "channels", "pubsub_channels", DS_TYPE_GAUGE);
 437     redis_handle_info (rn->name, rr->str, "pubsub", "patterns", "pubsub_patterns", DS_TYPE_GAUGE);
 438     redis_handle_info (rn->name, rr->str, "current_connections", "slaves", "connected_slaves", DS_TYPE_GAUGE);
 439     redis_handle_info (rn->name, rr->str, "cache_result", "hits", "keyspace_hits", DS_TYPE_DERIVE);
 440     redis_handle_info (rn->name, rr->str, "cache_result", "misses", "keyspace_misses", DS_TYPE_DERIVE);
 441     redis_handle_info (rn->name, rr->str, "total_bytes", "input", "total_net_input_bytes", DS_TYPE_DERIVE);
 442     redis_handle_info (rn->name, rr->str, "total_bytes", "output", "total_net_output_bytes", DS_TYPE_DERIVE);
 443
 444     for (rq = rn->queries; rq != NULL; rq = rq->next)
 445         redis_handle_query(rh, rn, rq);
 446
 447 redis_fail:
 448     if (rr != NULL)
 449       freeReplyObject (rr);
 450     redisFree (rh);
 451   }
 452
 453   return 0;
 454 }
 455 /* }}} */
 456
 457 void module_register (void) /* {{{ */
 458 {
 459   plugin_register_complex_config ("redis", redis_config);
 460   plugin_register_init ("redis", redis_init);
 461   plugin_register_read ("redis", redis_read);
 462   /* TODO: plugin_register_write: one redis list per value id with
 463    * X elements */
 464 }
 465 /* }}} */
 466
 467 /* vim: set sw=2 sts=2 et fdm=marker : */