1 /**
2 * collectd - src/utils_format_kairosdb.c
3 * Copyright (C) 2016 Aurelien beorn Rougemont
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 * Aurelien beorn Rougemont <beorn at gandi dot net>
25 **/
27 #include "collectd.h"
29 #include "common.h"
30 #include "plugin.h"
32 #include "utils_cache.h"
33 #include "utils_format_kairosdb.h"
35 /* This is the KAIROSDB format for write_http output
36 *
37 * Target format
38 * [
39 * {
40 * "name":"collectd.vmem"
41 * "datapoints":
42 * [
43 * [1453897164060, 97.000000]
44 * ],
45 * "tags":
46 * {
47 * "host": "fqdn.domain.tld",
48 * "plugin_instance": "vmpage_number",
49 * "type": "kernel_stack",
50 * "ds": "value"
51 * ""
52 * }
53 * }
54 * ]
55 */
57 static int kairosdb_escape_string(char *buffer, size_t buffer_size, /* {{{ */
58 const char *string) {
59 size_t dst_pos;
61 if ((buffer == NULL) || (string == NULL))
62 return -EINVAL;
64 if (buffer_size < 3)
65 return -ENOMEM;
67 dst_pos = 0;
69 #define BUFFER_ADD(c) \
70 do { \
71 if (dst_pos >= (buffer_size - 1)) { \
72 buffer[buffer_size - 1] = 0; \
73 return -ENOMEM; \
74 } \
75 buffer[dst_pos] = (c); \
76 dst_pos++; \
77 } while (0)
79 /* Escape special characters */
80 /* authorize -_. and alpha num but also escapes " */
81 BUFFER_ADD('"');
82 for (size_t src_pos = 0; string[src_pos] != 0; src_pos++) {
83 if (isalnum(string[src_pos]) || 0x2d == string[src_pos] ||
84 0x2e == string[src_pos] || 0x5f == string[src_pos])
85 BUFFER_ADD(tolower(string[src_pos]));
86 } /* for */
87 BUFFER_ADD('"');
88 buffer[dst_pos] = 0;
90 #undef BUFFER_ADD
92 return 0;
93 } /* }}} int kairosdb_escape_string */
95 static int values_to_kairosdb(char *buffer, size_t buffer_size, /* {{{ */
96 const data_set_t *ds, const value_list_t *vl,
97 int store_rates, size_t ds_idx) {
98 size_t offset = 0;
99 gauge_t *rates = NULL;
101 memset(buffer, 0, buffer_size);
103 #define BUFFER_ADD(...) \
104 do { \
105 int status; \
106 status = ssnprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
107 if (status < 1) { \
108 sfree(rates); \
109 return -1; \
110 } else if (((size_t)status) >= (buffer_size - offset)) { \
111 sfree(rates); \
112 return -ENOMEM; \
113 } else \
114 offset += ((size_t)status); \
115 } while (0)
117 if (ds->ds[ds_idx].type == DS_TYPE_GAUGE) {
118 if (isfinite(vl->values[ds_idx].gauge)) {
119 BUFFER_ADD("[[");
120 BUFFER_ADD("%" PRIu64, CDTIME_T_TO_MS(vl->time));
121 BUFFER_ADD(",");
122 BUFFER_ADD(JSON_GAUGE_FORMAT, vl->values[ds_idx].gauge);
123 } else {
124 DEBUG("utils_format_kairosdb: invalid vl->values[ds_idx].gauge for "
125 "%s|%s|%s|%s|%s",
126 vl->plugin, vl->plugin_instance, vl->type, vl->type_instance,
127 ds->ds[ds_idx].name);
128 return -1;
129 }
130 } else if (store_rates) {
131 if (rates == NULL)
132 rates = uc_get_rate(ds, vl);
133 if (rates == NULL) {
134 WARNING("utils_format_kairosdb: uc_get_rate failed for %s|%s|%s|%s|%s",
135 vl->plugin, vl->plugin_instance, vl->type, vl->type_instance,
136 ds->ds[ds_idx].name);
138 return -1;
139 }
141 if (isfinite(rates[ds_idx])) {
142 BUFFER_ADD("[[");
143 BUFFER_ADD("%" PRIu64, CDTIME_T_TO_MS(vl->time));
144 BUFFER_ADD(",");
145 BUFFER_ADD(JSON_GAUGE_FORMAT, rates[ds_idx]);
146 } else {
147 WARNING("utils_format_kairosdb: invalid rates[ds_idx] for %s|%s|%s|%s|%s",
148 vl->plugin, vl->plugin_instance, vl->type, vl->type_instance,
149 ds->ds[ds_idx].name);
150 sfree(rates);
151 return -1;
152 }
153 } else if (ds->ds[ds_idx].type == DS_TYPE_COUNTER) {
154 BUFFER_ADD("[[");
155 BUFFER_ADD("%" PRIu64, CDTIME_T_TO_MS(vl->time));
156 BUFFER_ADD(",");
157 BUFFER_ADD("%llu", vl->values[ds_idx].counter);
158 } else if (ds->ds[ds_idx].type == DS_TYPE_DERIVE) {
159 BUFFER_ADD("[[");
160 BUFFER_ADD("%" PRIu64, CDTIME_T_TO_MS(vl->time));
161 BUFFER_ADD(",");
162 BUFFER_ADD("%" PRIi64, vl->values[ds_idx].derive);
163 } else if (ds->ds[ds_idx].type == DS_TYPE_ABSOLUTE) {
164 BUFFER_ADD("[[");
165 BUFFER_ADD("%" PRIu64, CDTIME_T_TO_MS(vl->time));
166 BUFFER_ADD(",");
167 BUFFER_ADD("%" PRIu64, vl->values[ds_idx].absolute);
168 } else {
169 ERROR("format_kairosdb: Unknown data source type: %i", ds->ds[ds_idx].type);
170 sfree(rates);
171 return -1;
172 }
173 BUFFER_ADD("]]");
175 #undef BUFFER_ADD
177 DEBUG("format_kairosdb: values_to_kairosdb: buffer = %s;", buffer);
178 sfree(rates);
179 return 0;
180 } /* }}} int values_to_kairosdb */
182 static int value_list_to_kairosdb(char *buffer, size_t buffer_size, /* {{{ */
183 const data_set_t *ds, const value_list_t *vl,
184 int store_rates,
185 char const *const *http_attrs,
186 size_t http_attrs_num, int data_ttl) {
187 char temp[512];
188 size_t offset = 0;
189 int status;
191 memset(buffer, 0, buffer_size);
193 #define BUFFER_ADD(...) \
194 do { \
195 status = ssnprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
196 if (status < 1) \
197 return -1; \
198 else if (((size_t)status) >= (buffer_size - offset)) \
199 return -ENOMEM; \
200 else \
201 offset += ((size_t)status); \
202 } while (0)
204 #define BUFFER_ADD_KEYVAL(key, value) \
205 do { \
206 status = kairosdb_escape_string(temp, sizeof(temp), (value)); \
207 if (status != 0) \
208 return status; \
209 BUFFER_ADD(",\"%s\": %s", (key), temp); \
210 } while (0)
212 for (size_t i = 0; i < ds->ds_num; i++) {
213 /* All value lists have a leading comma. The first one will be replaced with
214 * a square bracket in `format_kairosdb_finalize'. */
215 BUFFER_ADD(",{");
217 BUFFER_ADD("\"name\":\"collectd");
219 BUFFER_ADD(".%s", vl->plugin);
221 status = values_to_kairosdb(temp, sizeof(temp), ds, vl, store_rates, i);
222 if (status != 0)
223 return status;
225 BUFFER_ADD("\", \"datapoints\": %s", temp);
227 /*
228 * Now adds meta data to metric as tags
229 */
231 memset(temp, 0, sizeof(temp));
233 if (data_ttl != 0)
234 BUFFER_ADD(", \"ttl\": %i", data_ttl);
236 BUFFER_ADD(", \"tags\":\{");
238 BUFFER_ADD("\"host\": \"%s\"", vl->host);
239 for (size_t j = 0; j < http_attrs_num; j += 2) {
240 BUFFER_ADD(", \"%s\":", http_attrs[j]);
241 BUFFER_ADD(" \"%s\"", http_attrs[j + 1]);
242 }
244 if (strlen(vl->plugin_instance))
245 BUFFER_ADD_KEYVAL("plugin_instance", vl->plugin_instance);
246 BUFFER_ADD_KEYVAL("type", vl->type);
247 if (strlen(vl->type_instance))
248 BUFFER_ADD_KEYVAL("type_instance", vl->type_instance);
249 if (ds->ds_num != 1)
250 BUFFER_ADD_KEYVAL("ds", ds->ds[i].name);
251 BUFFER_ADD("}}");
252 } /* for ds->ds_num */
254 #undef BUFFER_ADD_KEYVAL
255 #undef BUFFER_ADD
257 DEBUG("format_kairosdb: value_list_to_kairosdb: buffer = %s;", buffer);
259 return 0;
260 } /* }}} int value_list_to_kairosdb */
262 static int format_kairosdb_value_list_nocheck(
263 char *buffer, /* {{{ */
264 size_t *ret_buffer_fill, size_t *ret_buffer_free, const data_set_t *ds,
265 const value_list_t *vl, int store_rates, size_t temp_size,
266 char const *const *http_attrs, size_t http_attrs_num, int data_ttl) {
267 char temp[temp_size];
268 int status;
270 status = value_list_to_kairosdb(temp, sizeof(temp), ds, vl, store_rates,
271 http_attrs, http_attrs_num, data_ttl);
272 if (status != 0)
273 return status;
274 temp_size = strlen(temp);
276 memcpy(buffer + (*ret_buffer_fill), temp, temp_size + 1);
277 (*ret_buffer_fill) += temp_size;
278 (*ret_buffer_free) -= temp_size;
280 return 0;
281 } /* }}} int format_kairosdb_value_list_nocheck */
283 int format_kairosdb_initialize(char *buffer, /* {{{ */
284 size_t *ret_buffer_fill,
285 size_t *ret_buffer_free) {
286 size_t buffer_fill;
287 size_t buffer_free;
289 if ((buffer == NULL) || (ret_buffer_fill == NULL) ||
290 (ret_buffer_free == NULL))
291 return -EINVAL;
293 buffer_fill = *ret_buffer_fill;
294 buffer_free = *ret_buffer_free;
296 buffer_free = buffer_fill + buffer_free;
297 buffer_fill = 0;
299 if (buffer_free < 3)
300 return -ENOMEM;
302 memset(buffer, 0, buffer_free);
303 *ret_buffer_fill = buffer_fill;
304 *ret_buffer_free = buffer_free;
306 return 0;
307 } /* }}} int format_kairosdb_initialize */
309 int format_kairosdb_finalize(char *buffer, /* {{{ */
310 size_t *ret_buffer_fill, size_t *ret_buffer_free) {
311 size_t pos;
313 if ((buffer == NULL) || (ret_buffer_fill == NULL) ||
314 (ret_buffer_free == NULL))
315 return -EINVAL;
317 if (*ret_buffer_free < 2)
318 return -ENOMEM;
320 /* Replace the leading comma added in `value_list_to_kairosdb' with a square
321 * bracket. */
322 if (buffer[0] != ',')
323 return -EINVAL;
324 buffer[0] = '[';
326 pos = *ret_buffer_fill;
327 buffer[pos] = ']';
328 buffer[pos + 1] = 0;
330 (*ret_buffer_fill)++;
331 (*ret_buffer_free)--;
333 return 0;
334 } /* }}} int format_kairosdb_finalize */
336 int format_kairosdb_value_list(char *buffer, /* {{{ */
337 size_t *ret_buffer_fill, size_t *ret_buffer_free,
338 const data_set_t *ds, const value_list_t *vl,
339 int store_rates, char const *const *http_attrs,
340 size_t http_attrs_num, int data_ttl) {
341 if ((buffer == NULL) || (ret_buffer_fill == NULL) ||
342 (ret_buffer_free == NULL) || (ds == NULL) || (vl == NULL))
343 return -EINVAL;
345 if (*ret_buffer_free < 3)
346 return -ENOMEM;
348 return format_kairosdb_value_list_nocheck(buffer, ret_buffer_fill,
349 ret_buffer_free, ds, vl,
350 store_rates,
351 (*ret_buffer_free) - 2,
352 http_attrs, http_attrs_num,
353 data_ttl);
354 } /* }}} int format_kairosdb_value_list */
356 /* vim: set sw=2 sts=2 et fdm=marker : */