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 "configfile.h"
32 # define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
35 #define REDIS_DEF_HOST "localhost"
36 #define REDIS_DEF_PASSWD ""
37 #define REDIS_DEF_PORT 6379
38 #define REDIS_DEF_TIMEOUT 2000
39 #define MAX_REDIS_NODE_NAME 64
41 /* Redis plugin configuration example:
53 typedef struct redis_node_s redis_node_t;
56 char name[MAX_REDIS_NODE_NAME];
57 char host[HOST_NAME_MAX];
58 char passwd[HOST_NAME_MAX];
65 static redis_node_t *nodes_head = NULL;
67 static int redis_node_add (const redis_node_t *rn) /* {{{ */
69 redis_node_t *rn_copy;
72 /* Check for duplicates first */
73 for (rn_ptr = nodes_head; rn_ptr != NULL; rn_ptr = rn_ptr->next)
74 if (strcmp (rn->name, rn_ptr->name) == 0)
79 ERROR ("redis plugin: A node with the name `%s' already exists.",
84 rn_copy = malloc (sizeof (*rn_copy));
87 ERROR ("redis plugin: malloc failed adding redis_node to the tree.");
91 memcpy (rn_copy, rn, sizeof (*rn_copy));
94 DEBUG ("redis plugin: Adding node \"%s\".", rn->name);
96 if (nodes_head == NULL)
101 while (rn_ptr->next != NULL)
102 rn_ptr = rn_ptr->next;
103 rn_ptr->next = rn_copy;
109 static int redis_config_node (oconfig_item_t *ci) /* {{{ */
115 memset (&rn, 0, sizeof (rn));
116 sstrncpy (rn.host, REDIS_DEF_HOST, sizeof (rn.host));
117 rn.port = REDIS_DEF_PORT;
118 rn.timeout = REDIS_DEF_TIMEOUT;
120 status = cf_util_get_string_buffer (ci, rn.name, sizeof (rn.name));
124 for (i = 0; i < ci->children_num; i++)
126 oconfig_item_t *option = ci->children + i;
128 if (strcasecmp ("Host", option->key) == 0)
129 status = cf_util_get_string_buffer (option, rn.host, sizeof (rn.host));
130 else if (strcasecmp ("Port", option->key) == 0)
132 status = cf_util_get_port_number (option);
139 else if (strcasecmp ("Timeout", option->key) == 0)
140 status = cf_util_get_int (option, &rn.timeout);
141 else if (strcasecmp ("Password", option->key) == 0)
142 status = cf_util_get_string_buffer (option, rn.passwd, sizeof (rn.passwd));
144 WARNING ("redis plugin: Option `%s' not allowed inside a `Node' "
145 "block. I'll ignore this option.", option->key);
154 return (redis_node_add (&rn));
155 } /* }}} int redis_config_node */
157 static int redis_config (oconfig_item_t *ci) /* {{{ */
161 for (i = 0; i < ci->children_num; i++)
163 oconfig_item_t *option = ci->children + i;
165 if (strcasecmp ("Node", option->key) == 0)
166 redis_config_node (option);
168 WARNING ("redis plugin: Option `%s' not allowed in redis"
169 " configuration. It will be ignored.", option->key);
172 if (nodes_head == NULL)
174 ERROR ("redis plugin: No valid node configuration could be found.");
181 __attribute__ ((nonnull(2)))
182 static void redis_submit_g (char *plugin_instance,
183 const char *type, const char *type_instance,
184 gauge_t value) /* {{{ */
187 value_list_t vl = VALUE_LIST_INIT;
189 values[0].gauge = value;
193 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
194 sstrncpy (vl.plugin, "redis", sizeof (vl.plugin));
195 if (plugin_instance != NULL)
196 sstrncpy (vl.plugin_instance, plugin_instance,
197 sizeof (vl.plugin_instance));
198 sstrncpy (vl.type, type, sizeof (vl.type));
199 if (type_instance != NULL)
200 sstrncpy (vl.type_instance, type_instance,
201 sizeof (vl.type_instance));
203 plugin_dispatch_values (&vl);
206 __attribute__ ((nonnull(2)))
207 static void redis_submit_d (char *plugin_instance,
208 const char *type, const char *type_instance,
209 derive_t value) /* {{{ */
212 value_list_t vl = VALUE_LIST_INIT;
214 values[0].derive = value;
218 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
219 sstrncpy (vl.plugin, "redis", sizeof (vl.plugin));
220 if (plugin_instance != NULL)
221 sstrncpy (vl.plugin_instance, plugin_instance,
222 sizeof (vl.plugin_instance));
223 sstrncpy (vl.type, type, sizeof (vl.type));
224 if (type_instance != NULL)
225 sstrncpy (vl.type_instance, type_instance,
226 sizeof (vl.type_instance));
228 plugin_dispatch_values (&vl);
231 static int redis_init (void) /* {{{ */
233 redis_node_t rn = { "default", REDIS_DEF_HOST, REDIS_DEF_PASSWD,
234 REDIS_DEF_PORT, REDIS_DEF_TIMEOUT, /* next = */ NULL };
236 if (nodes_head == NULL)
237 redis_node_add (&rn);
240 } /* }}} int redis_init */
242 static int redis_read (void) /* {{{ */
246 for (rn = nodes_head; rn != NULL; rn = rn->next)
253 DEBUG ("redis plugin: querying info from node `%s' (%s:%d).", rn->name, rn->host, rn->port);
255 rh = credis_connect (rn->host, rn->port, rn->timeout);
258 ERROR ("redis plugin: unable to connect to node `%s' (%s:%d).", rn->name, rn->host, rn->port);
262 if (strlen (rn->passwd) > 0)
264 DEBUG ("redis plugin: authenticanting node `%s' passwd(%s).", rn->name, rn->passwd);
265 status = credis_auth(rh, rn->passwd);
268 WARNING ("redis plugin: unable to authenticate on node `%s'.", rn->name);
274 memset (&info, 0, sizeof (info));
275 status = credis_info (rh, &info);
278 WARNING ("redis plugin: unable to get info from node `%s'.", rn->name);
283 /* typedef struct _cr_info {
284 * char redis_version[CREDIS_VERSION_STRING_SIZE];
285 * int bgsave_in_progress;
286 * int connected_clients;
287 * int connected_slaves;
288 * unsigned int used_memory;
289 * long long changes_since_last_save;
290 * int last_save_time;
291 * long long total_connections_received;
292 * long long total_commands_processed;
293 * int uptime_in_seconds;
294 * int uptime_in_days;
298 DEBUG ("redis plugin: received info from node `%s': connected_clients = %d; "
299 "connected_slaves = %d; used_memory = %lu; changes_since_last_save = %lld; "
300 "bgsave_in_progress = %d; total_connections_received = %lld; "
301 "total_commands_processed = %lld; uptime_in_seconds = %ld", rn->name,
302 info.connected_clients, info.connected_slaves, info.used_memory,
303 info.changes_since_last_save, info.bgsave_in_progress,
304 info.total_connections_received, info.total_commands_processed,
305 info.uptime_in_seconds);
307 redis_submit_g (rn->name, "current_connections", "clients", info.connected_clients);
308 redis_submit_g (rn->name, "current_connections", "slaves", info.connected_slaves);
309 redis_submit_g (rn->name, "memory", "used", info.used_memory);
310 redis_submit_g (rn->name, "volatile_changes", NULL, info.changes_since_last_save);
311 redis_submit_d (rn->name, "total_connections", NULL, info.total_connections_received);
312 redis_submit_d (rn->name, "total_operations", NULL, info.total_commands_processed);
321 void module_register (void) /* {{{ */
323 plugin_register_complex_config ("redis", redis_config);
324 plugin_register_init ("redis", redis_init);
325 plugin_register_read ("redis", redis_read);
326 /* TODO: plugin_register_write: one redis list per value id with
331 /* vim: set sw=2 sts=2 et fdm=marker : */