2 * collectd - src/write_kafka.c
3 * Copyright (C) 2014 Pierre-Yves Ritschard
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Pierre-Yves Ritschard <pyr at spootnik.org>
30 #include "configfile.h"
31 #include "utils_cache.h"
32 #include "utils_cmd_putval.h"
33 #include "utils_format_graphite.h"
34 #include "utils_format_json.h"
35 #include "utils_crc32.h"
38 #include <librdkafka/rdkafka.h>
43 struct kafka_topic_context {
44 #define KAFKA_FORMAT_JSON 0
45 #define KAFKA_FORMAT_COMMAND 1
46 #define KAFKA_FORMAT_GRAPHITE 2
48 unsigned int graphite_flags;
50 rd_kafka_topic_conf_t *conf;
51 rd_kafka_topic_t *topic;
52 rd_kafka_conf_t *kafka_conf;
63 static int kafka_handle(struct kafka_topic_context *);
64 static int kafka_write(const data_set_t *, const value_list_t *, user_data_t *);
65 static int32_t kafka_partition(const rd_kafka_topic_t *, const void *, size_t,
66 int32_t, void *, void *);
68 #if defined HAVE_LIBRDKAFKA_LOGGER || defined HAVE_LIBRDKAFKA_LOG_CB
69 static void kafka_log(const rd_kafka_t *, int, const char *, const char *);
71 static void kafka_log(const rd_kafka_t *rkt, int level,
72 const char *fac, const char *msg)
74 plugin_log(level, "%s", msg);
78 static int32_t kafka_partition(const rd_kafka_topic_t *rkt,
79 const void *keydata, size_t keylen,
80 int32_t partition_cnt, void *p, void *m)
82 uint32_t key = *((uint32_t *)keydata );
83 uint32_t target = key % partition_cnt;
84 int32_t i = partition_cnt;
86 while (--i > 0 && !rd_kafka_topic_partition_available(rkt, target)) {
87 target = (target + 1) % partition_cnt;
92 static int kafka_handle(struct kafka_topic_context *ctx) /* {{{ */
95 rd_kafka_conf_t *conf;
96 rd_kafka_topic_conf_t *topic_conf;
98 if (ctx->kafka != NULL && ctx->topic != NULL)
101 if (ctx->kafka == NULL) {
102 if ((conf = rd_kafka_conf_dup(ctx->kafka_conf)) == NULL) {
103 ERROR("write_kafka plugin: cannot duplicate kafka config");
107 if ((ctx->kafka = rd_kafka_new(RD_KAFKA_PRODUCER, conf,
108 errbuf, sizeof(errbuf))) == NULL) {
109 ERROR("write_kafka plugin: cannot create kafka handle.");
113 rd_kafka_conf_destroy(ctx->kafka_conf);
114 ctx->kafka_conf = NULL;
116 INFO ("write_kafka plugin: created KAFKA handle : %s", rd_kafka_name(ctx->kafka));
118 #ifdef HAVE_LIBRDKAFKA_LOGGER
119 rd_kafka_set_logger(ctx->kafka, kafka_log);
123 if (ctx->topic == NULL ) {
124 if ((topic_conf = rd_kafka_topic_conf_dup(ctx->conf)) == NULL) {
125 ERROR("write_kafka plugin: cannot duplicate kafka topic config");
129 if ((ctx->topic = rd_kafka_topic_new(ctx->kafka, ctx->topic_name,
130 topic_conf)) == NULL) {
131 ERROR("write_kafka plugin: cannot create topic : %s\n",
132 rd_kafka_err2str(rd_kafka_errno2err(errno)));
136 rd_kafka_topic_conf_destroy(ctx->conf);
139 INFO ("write_kafka plugin: handle created for topic : %s", rd_kafka_topic_name(ctx->topic));
144 } /* }}} int kafka_handle */
146 static int kafka_write(const data_set_t *ds, /* {{{ */
147 const value_list_t *vl,
153 size_t bfree = sizeof(buffer);
156 struct kafka_topic_context *ctx = ud->data;
158 if ((ds == NULL) || (vl == NULL) || (ctx == NULL))
161 pthread_mutex_lock (&ctx->lock);
162 status = kafka_handle(ctx);
163 pthread_mutex_unlock (&ctx->lock);
167 bzero(buffer, sizeof(buffer));
169 switch (ctx->format) {
170 case KAFKA_FORMAT_COMMAND:
171 status = create_putval(buffer, sizeof(buffer), ds, vl);
173 ERROR("write_kafka plugin: create_putval failed with status %i.",
177 blen = strlen(buffer);
179 case KAFKA_FORMAT_JSON:
180 format_json_initialize(buffer, &bfill, &bfree);
181 format_json_value_list(buffer, &bfill, &bfree, ds, vl,
183 format_json_finalize(buffer, &bfill, &bfree);
184 blen = strlen(buffer);
186 case KAFKA_FORMAT_GRAPHITE:
187 status = format_graphite(buffer, sizeof(buffer), ds, vl,
188 ctx->prefix, ctx->postfix, ctx->escape_char,
189 ctx->graphite_flags);
191 ERROR("write_kafka plugin: format_graphite failed with status %i.",
195 blen = strlen(buffer);
198 ERROR("write_kafka plugin: invalid format %i.", ctx->format);
203 * We partition our stream by metric name
210 rd_kafka_produce(ctx->topic, RD_KAFKA_PARTITION_UA,
211 RD_KAFKA_MSG_F_COPY, buffer, blen,
212 &key, sizeof(key), NULL);
215 } /* }}} int kafka_write */
217 static void kafka_topic_context_free(void *p) /* {{{ */
219 struct kafka_topic_context *ctx = p;
224 if (ctx->topic_name != NULL)
225 sfree(ctx->topic_name);
226 if (ctx->topic != NULL)
227 rd_kafka_topic_destroy(ctx->topic);
228 if (ctx->conf != NULL)
229 rd_kafka_topic_conf_destroy(ctx->conf);
230 if (ctx->kafka_conf != NULL)
231 rd_kafka_conf_destroy(ctx->kafka_conf);
232 if (ctx->kafka != NULL)
233 rd_kafka_destroy(ctx->kafka);
236 } /* }}} void kafka_topic_context_free */
238 static void kafka_config_topic(rd_kafka_conf_t *conf, oconfig_item_t *ci) /* {{{ */
242 struct kafka_topic_context *tctx;
245 char callback_name[DATA_MAX_NAME_LEN];
248 oconfig_item_t *child;
249 rd_kafka_conf_res_t ret;
251 if ((tctx = calloc(1, sizeof (*tctx))) == NULL) {
252 ERROR ("write_kafka plugin: calloc failed.");
256 tctx->escape_char = '.';
257 tctx->store_rates = 1;
258 tctx->format = KAFKA_FORMAT_JSON;
260 if ((tctx->kafka_conf = rd_kafka_conf_dup(conf)) == NULL) {
262 ERROR("write_kafka plugin: cannot allocate memory for kafka config");
266 #ifdef HAVE_LIBRDKAFKA_LOG_CB
267 rd_kafka_conf_set_log_cb(tctx->kafka_conf, kafka_log);
270 if ((tctx->conf = rd_kafka_topic_conf_new()) == NULL) {
271 rd_kafka_conf_destroy(tctx->kafka_conf);
273 ERROR ("write_kafka plugin: cannot create topic configuration.");
277 if (ci->values_num != 1) {
278 WARNING("kafka topic name needed.");
282 if (ci->values[0].type != OCONFIG_TYPE_STRING) {
283 WARNING("kafka topic needs a string argument.");
287 if ((tctx->topic_name = strdup(ci->values[0].value.string)) == NULL) {
288 ERROR("write_kafka plugin: cannot copy topic name.");
292 for (i = 0; i < ci->children_num; i++) {
294 * The code here could be simplified but makes room
295 * for easy adding of new options later on.
297 child = &ci->children[i];
300 if (strcasecmp ("Property", child->key) == 0) {
301 if (child->values_num != 2) {
302 WARNING("kafka properties need both a key and a value.");
305 if (child->values[0].type != OCONFIG_TYPE_STRING ||
306 child->values[1].type != OCONFIG_TYPE_STRING) {
307 WARNING("kafka properties needs string arguments.");
310 key = child->values[0].value.string;
311 val = child->values[1].value.string;
312 ret = rd_kafka_topic_conf_set(tctx->conf,key, val,
313 errbuf, sizeof(errbuf));
314 if (ret != RD_KAFKA_CONF_OK) {
315 WARNING("cannot set kafka topic property %s to %s: %s.",
320 } else if (strcasecmp ("Key", child->key) == 0) {
321 char *tmp_buf = NULL;
322 status = cf_util_get_string(child, &tmp_buf);
324 WARNING("write_kafka plugin: invalid key supplied");
328 if (strcasecmp(tmp_buf, "Random") != 0) {
330 tctx->key = crc32_buffer((u_char *)tmp_buf, strlen(tmp_buf));
334 } else if (strcasecmp ("Format", child->key) == 0) {
335 status = cf_util_get_string(child, &key);
341 if (strcasecmp(key, "Command") == 0) {
342 tctx->format = KAFKA_FORMAT_COMMAND;
344 } else if (strcasecmp(key, "Graphite") == 0) {
345 tctx->format = KAFKA_FORMAT_GRAPHITE;
347 } else if (strcasecmp(key, "Json") == 0) {
348 tctx->format = KAFKA_FORMAT_JSON;
351 WARNING ("write_kafka plugin: Invalid format string: %s",
357 } else if (strcasecmp ("StoreRates", child->key) == 0) {
358 status = cf_util_get_boolean (child, &tctx->store_rates);
359 (void) cf_util_get_flag (child, &tctx->graphite_flags,
360 GRAPHITE_STORE_RATES);
362 } else if (strcasecmp ("GraphiteSeparateInstances", child->key) == 0) {
363 status = cf_util_get_flag (child, &tctx->graphite_flags,
364 GRAPHITE_SEPARATE_INSTANCES);
366 } else if (strcasecmp ("GraphiteAlwaysAppendDS", child->key) == 0) {
367 status = cf_util_get_flag (child, &tctx->graphite_flags,
368 GRAPHITE_ALWAYS_APPEND_DS);
370 } else if (strcasecmp ("GraphitePrefix", child->key) == 0) {
371 status = cf_util_get_string (child, &tctx->prefix);
372 } else if (strcasecmp ("GraphitePostfix", child->key) == 0) {
373 status = cf_util_get_string (child, &tctx->postfix);
374 } else if (strcasecmp ("GraphiteEscapeChar", child->key) == 0) {
375 char *tmp_buff = NULL;
376 status = cf_util_get_string (child, &tmp_buff);
377 if (strlen (tmp_buff) > 1)
378 WARNING ("write_kafka plugin: The option \"GraphiteEscapeChar\" handles "
379 "only one character. Others will be ignored.");
380 tctx->escape_char = tmp_buff[0];
383 WARNING ("write_kafka plugin: Invalid directive: %s.", child->key);
390 rd_kafka_topic_conf_set_partitioner_cb(tctx->conf, kafka_partition);
391 rd_kafka_topic_conf_set_opaque(tctx->conf, tctx);
393 ssnprintf(callback_name, sizeof(callback_name),
394 "write_kafka/%s", tctx->topic_name);
397 ud.free_func = kafka_topic_context_free;
399 status = plugin_register_write (callback_name, kafka_write, &ud);
401 WARNING ("write_kafka plugin: plugin_register_write (\"%s\") "
402 "failed with status %i.",
403 callback_name, status);
407 pthread_mutex_init (&tctx->lock, /* attr = */ NULL);
411 if (tctx->topic_name != NULL)
412 free(tctx->topic_name);
413 if (tctx->conf != NULL)
414 rd_kafka_topic_conf_destroy(tctx->conf);
415 if (tctx->kafka_conf != NULL)
416 rd_kafka_conf_destroy(tctx->kafka_conf);
418 } /* }}} int kafka_config_topic */
420 static int kafka_config(oconfig_item_t *ci) /* {{{ */
423 oconfig_item_t *child;
424 rd_kafka_conf_t *conf;
425 rd_kafka_conf_res_t ret;
428 if ((conf = rd_kafka_conf_new()) == NULL) {
429 WARNING("cannot allocate kafka configuration.");
432 for (i = 0; i < ci->children_num; i++) {
433 child = &ci->children[i];
435 if (strcasecmp("Topic", child->key) == 0) {
436 kafka_config_topic (conf, child);
437 } else if (strcasecmp(child->key, "Property") == 0) {
441 if (child->values_num != 2) {
442 WARNING("kafka properties need both a key and a value.");
445 if (child->values[0].type != OCONFIG_TYPE_STRING ||
446 child->values[1].type != OCONFIG_TYPE_STRING) {
447 WARNING("kafka properties needs string arguments.");
450 if ((key = strdup(child->values[0].value.string)) == NULL) {
451 WARNING("cannot allocate memory for attribute key.");
454 if ((val = strdup(child->values[1].value.string)) == NULL) {
455 WARNING("cannot allocate memory for attribute value.");
459 ret = rd_kafka_conf_set(conf, key, val, errbuf, sizeof(errbuf));
460 if (ret != RD_KAFKA_CONF_OK) {
461 WARNING("cannot set kafka property %s to %s: %s",
470 WARNING ("write_kafka plugin: Ignoring unknown "
471 "configuration option \"%s\" at top level.",
476 rd_kafka_conf_destroy(conf);
480 rd_kafka_conf_destroy(conf);
482 } /* }}} int kafka_config */
484 void module_register(void)
486 plugin_register_complex_config ("write_kafka", kafka_config);