1 /**
2 * collectd - src/write_redis.c
3 * Copyright (C) 2010-2015 Florian Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian Forster <ff at octo.it>
25 **/
27 #include "collectd.h"
28 #include "plugin.h"
29 #include "common.h"
30 #include "configfile.h"
32 #include <sys/time.h>
33 #include <hiredis/hiredis.h>
35 #ifndef REDIS_DEFAULT_PREFIX
36 # define REDIS_DEFAULT_PREFIX "collectd/"
37 #endif
39 struct wr_node_s
40 {
41 char name[DATA_MAX_NAME_LEN];
43 char *host;
44 int port;
45 struct timeval timeout;
46 char *prefix;
47 int database;
48 int max_set_size;
49 _Bool store_rates;
51 redisContext *conn;
52 pthread_mutex_t lock;
53 };
54 typedef struct wr_node_s wr_node_t;
56 /*
57 * Functions
58 */
59 static int wr_write (const data_set_t *ds, /* {{{ */
60 const value_list_t *vl,
61 user_data_t *ud)
62 {
63 wr_node_t *node = ud->data;
64 char ident[512];
65 char key[512];
66 char value[512];
67 char time[24];
68 size_t value_size;
69 char *value_ptr;
70 int status;
71 redisReply *rr;
73 status = FORMAT_VL (ident, sizeof (ident), vl);
74 if (status != 0)
75 return (status);
76 ssnprintf (key, sizeof (key), "%s%s",
77 (node->prefix != NULL) ? node->prefix : REDIS_DEFAULT_PREFIX,
78 ident);
79 ssnprintf (time, sizeof (time), "%.9f", CDTIME_T_TO_DOUBLE(vl->time));
81 memset (value, 0, sizeof (value));
82 value_size = sizeof (value);
83 value_ptr = &value[0];
84 status = format_values (value_ptr, value_size, ds, vl, node->store_rates);
85 if (status != 0)
86 return (status);
88 pthread_mutex_lock (&node->lock);
90 if (node->conn == NULL)
91 {
92 node->conn = redisConnectWithTimeout ((char *)node->host, node->port, node->timeout);
93 if (node->conn == NULL)
94 {
95 ERROR ("write_redis plugin: Connecting to host \"%s\" (port %i) failed: Unkown reason",
96 (node->host != NULL) ? node->host : "localhost",
97 (node->port != 0) ? node->port : 6379);
98 pthread_mutex_unlock (&node->lock);
99 return (-1);
100 }
101 else if (node->conn->err)
102 {
103 ERROR ("write_redis plugin: Connecting to host \"%s\" (port %i) failed: %s",
104 (node->host != NULL) ? node->host : "localhost",
105 (node->port != 0) ? node->port : 6379,
106 node->conn->errstr);
107 pthread_mutex_unlock (&node->lock);
108 return (-1);
109 }
111 rr = redisCommand(node->conn, "SELECT %d", node->database);
112 if (rr == NULL)
113 WARNING("SELECT command error. database:%d message:%s", node->database, node->conn->errstr);
114 else
115 freeReplyObject (rr);
116 }
118 rr = redisCommand (node->conn, "ZADD %s %s %s", key, time, value);
119 if (rr == NULL)
120 WARNING("ZADD command error. key:%s message:%s", key, node->conn->errstr);
121 else
122 freeReplyObject (rr);
124 if (node->max_set_size >= 0)
125 {
126 rr = redisCommand (node->conn, "ZREMRANGEBYRANK %s %d %d", key, 0, (-1 * node->max_set_size) - 1);
127 if (rr == NULL)
128 WARNING("ZREMRANGEBYRANK command error. key:%s message:%s", key, node->conn->errstr);
129 else
130 freeReplyObject (rr);
131 }
133 /* TODO(octo): This is more overhead than necessary. Use the cache and
134 * metadata to determine if it is a new metric and call SADD only once for
135 * each metric. */
136 rr = redisCommand (node->conn, "SADD %svalues %s",
137 (node->prefix != NULL) ? node->prefix : REDIS_DEFAULT_PREFIX,
138 ident);
139 if (rr==NULL)
140 WARNING("SADD command error. ident:%s message:%s", ident, node->conn->errstr);
141 else
142 freeReplyObject (rr);
144 pthread_mutex_unlock (&node->lock);
146 return (0);
147 } /* }}} int wr_write */
149 static void wr_config_free (void *ptr) /* {{{ */
150 {
151 wr_node_t *node = ptr;
153 if (node == NULL)
154 return;
156 if (node->conn != NULL)
157 {
158 redisFree (node->conn);
159 node->conn = NULL;
160 }
162 sfree (node->host);
163 sfree (node);
164 } /* }}} void wr_config_free */
166 static int wr_config_node (oconfig_item_t *ci) /* {{{ */
167 {
168 wr_node_t *node;
169 int timeout;
170 int status;
171 int i;
173 node = calloc (1, sizeof (*node));
174 if (node == NULL)
175 return (ENOMEM);
176 node->host = NULL;
177 node->port = 0;
178 node->timeout.tv_sec = 0;
179 node->timeout.tv_usec = 1000;
180 node->conn = NULL;
181 node->prefix = NULL;
182 node->database = 0;
183 node->max_set_size = -1;
184 node->store_rates = 1;
185 pthread_mutex_init (&node->lock, /* attr = */ NULL);
187 status = cf_util_get_string_buffer (ci, node->name, sizeof (node->name));
188 if (status != 0)
189 {
190 sfree (node);
191 return (status);
192 }
194 for (i = 0; i < ci->children_num; i++)
195 {
196 oconfig_item_t *child = ci->children + i;
198 if (strcasecmp ("Host", child->key) == 0)
199 status = cf_util_get_string (child, &node->host);
200 else if (strcasecmp ("Port", child->key) == 0)
201 {
202 status = cf_util_get_port_number (child);
203 if (status > 0)
204 {
205 node->port = status;
206 status = 0;
207 }
208 }
209 else if (strcasecmp ("Timeout", child->key) == 0) {
210 status = cf_util_get_int (child, &timeout);
211 if (status == 0) node->timeout.tv_usec = timeout;
212 }
213 else if (strcasecmp ("Prefix", child->key) == 0) {
214 status = cf_util_get_string (child, &node->prefix);
215 }
216 else if (strcasecmp ("Database", child->key) == 0) {
217 status = cf_util_get_int (child, &node->database);
218 }
219 else if (strcasecmp ("MaxSetSize", child->key) == 0) {
220 status = cf_util_get_int (child, &node->max_set_size);
221 }
222 else if (strcasecmp ("StoreRates", child->key) == 0) {
223 status = cf_util_get_boolean (child, &node->store_rates);
224 }
225 else
226 WARNING ("write_redis plugin: Ignoring unknown config option \"%s\".",
227 child->key);
229 if (status != 0)
230 break;
231 } /* for (i = 0; i < ci->children_num; i++) */
233 if (status == 0)
234 {
235 char cb_name[DATA_MAX_NAME_LEN];
236 user_data_t ud;
238 ssnprintf (cb_name, sizeof (cb_name), "write_redis/%s", node->name);
240 ud.data = node;
241 ud.free_func = wr_config_free;
243 status = plugin_register_write (cb_name, wr_write, &ud);
244 }
246 if (status != 0)
247 wr_config_free (node);
249 return (status);
250 } /* }}} int wr_config_node */
252 static int wr_config (oconfig_item_t *ci) /* {{{ */
253 {
254 int i;
256 for (i = 0; i < ci->children_num; i++)
257 {
258 oconfig_item_t *child = ci->children + i;
260 if (strcasecmp ("Node", child->key) == 0)
261 wr_config_node (child);
262 else
263 WARNING ("write_redis plugin: Ignoring unknown "
264 "configuration option \"%s\" at top level.", child->key);
265 }
267 return (0);
268 } /* }}} int wr_config */
270 void module_register (void)
271 {
272 plugin_register_complex_config ("write_redis", wr_config);
273 }
275 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */