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;
62 static int kafka_handle(struct kafka_topic_context *);
63 static int kafka_write(const data_set_t *, const value_list_t *, user_data_t *);
64 static int32_t kafka_partition(const rd_kafka_topic_t *, const void *, size_t,
65 int32_t, void *, void *);
67 #if defined HAVE_LIBRDKAFKA_LOGGER || defined HAVE_LIBRDKAFKA_LOG_CB
68 static void kafka_log(const rd_kafka_t *, int, const char *, const char *);
70 static void kafka_log(const rd_kafka_t *rkt, int level,
71 const char *fac, const char *msg)
73 plugin_log(level, "%s", msg);
77 static int32_t kafka_partition(const rd_kafka_topic_t *rkt,
78 const void *keydata, size_t keylen,
79 int32_t partition_cnt, void *p, void *m)
81 uint32_t key = *((uint32_t *)keydata );
82 uint32_t target = key % partition_cnt;
83 int32_t i = partition_cnt;
85 while (--i > 0 && !rd_kafka_topic_partition_available(rkt, target)) {
86 target = (target + 1) % partition_cnt;
91 static int kafka_handle(struct kafka_topic_context *ctx) /* {{{ */
94 rd_kafka_conf_t *conf;
95 rd_kafka_topic_conf_t *topic_conf;
97 if (ctx->kafka != NULL && ctx->topic != NULL)
100 if (ctx->kafka == NULL) {
101 if ((conf = rd_kafka_conf_dup(ctx->kafka_conf)) == NULL) {
102 ERROR("write_kafka plugin: cannot duplicate kafka config");
106 if ((ctx->kafka = rd_kafka_new(RD_KAFKA_PRODUCER, conf,
107 errbuf, sizeof(errbuf))) == NULL) {
108 ERROR("write_kafka plugin: cannot create kafka handle.");
112 rd_kafka_conf_destroy(ctx->kafka_conf);
113 ctx->kafka_conf = NULL;
115 INFO ("write_kafka plugin: created KAFKA handle : %s", rd_kafka_name(ctx->kafka));
117 #if defined(HAVE_LIBRDKAFKA_LOGGER) && !defined(HAVE_LIBRDKAFKA_LOG_CB)
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,
154 size_t bfree = sizeof(buffer);
157 struct kafka_topic_context *ctx = ud->data;
159 if ((ds == NULL) || (vl == NULL) || (ctx == NULL))
162 pthread_mutex_lock (&ctx->lock);
163 status = kafka_handle(ctx);
164 pthread_mutex_unlock (&ctx->lock);
168 bzero(buffer, sizeof(buffer));
170 switch (ctx->format) {
171 case KAFKA_FORMAT_COMMAND:
172 status = create_putval(buffer, sizeof(buffer), ds, vl);
174 ERROR("write_kafka plugin: create_putval failed with status %i.",
178 blen = strlen(buffer);
180 case KAFKA_FORMAT_JSON:
181 format_json_initialize(buffer, &bfill, &bfree);
182 format_json_value_list(buffer, &bfill, &bfree, ds, vl,
184 format_json_finalize(buffer, &bfill, &bfree);
185 blen = strlen(buffer);
187 case KAFKA_FORMAT_GRAPHITE:
188 status = format_graphite(buffer, sizeof(buffer), ds, vl,
189 ctx->prefix, ctx->postfix, ctx->escape_char,
190 ctx->graphite_flags);
192 ERROR("write_kafka plugin: format_graphite failed with status %i.",
196 blen = strlen(buffer);
199 ERROR("write_kafka plugin: invalid format %i.", ctx->format);
205 keylen = strlen (key);
207 rd_kafka_produce(ctx->topic, RD_KAFKA_PARTITION_UA,
208 RD_KAFKA_MSG_F_COPY, buffer, blen,
212 } /* }}} int kafka_write */
214 static void kafka_topic_context_free(void *p) /* {{{ */
216 struct kafka_topic_context *ctx = p;
221 if (ctx->topic_name != NULL)
222 sfree(ctx->topic_name);
223 if (ctx->topic != NULL)
224 rd_kafka_topic_destroy(ctx->topic);
225 if (ctx->conf != NULL)
226 rd_kafka_topic_conf_destroy(ctx->conf);
227 if (ctx->kafka_conf != NULL)
228 rd_kafka_conf_destroy(ctx->kafka_conf);
229 if (ctx->kafka != NULL)
230 rd_kafka_destroy(ctx->kafka);
233 } /* }}} void kafka_topic_context_free */
235 static void kafka_config_topic(rd_kafka_conf_t *conf, oconfig_item_t *ci) /* {{{ */
239 struct kafka_topic_context *tctx;
242 char callback_name[DATA_MAX_NAME_LEN];
245 oconfig_item_t *child;
246 rd_kafka_conf_res_t ret;
248 if ((tctx = calloc(1, sizeof (*tctx))) == NULL) {
249 ERROR ("write_kafka plugin: calloc failed.");
253 tctx->escape_char = '.';
254 tctx->store_rates = 1;
255 tctx->format = KAFKA_FORMAT_JSON;
257 if ((tctx->kafka_conf = rd_kafka_conf_dup(conf)) == NULL) {
259 ERROR("write_kafka plugin: cannot allocate memory for kafka config");
263 #ifdef HAVE_LIBRDKAFKA_LOG_CB
264 rd_kafka_conf_set_log_cb(tctx->kafka_conf, kafka_log);
267 if ((tctx->conf = rd_kafka_topic_conf_new()) == NULL) {
268 rd_kafka_conf_destroy(tctx->kafka_conf);
270 ERROR ("write_kafka plugin: cannot create topic configuration.");
274 if (ci->values_num != 1) {
275 WARNING("kafka topic name needed.");
279 if (ci->values[0].type != OCONFIG_TYPE_STRING) {
280 WARNING("kafka topic needs a string argument.");
284 if ((tctx->topic_name = strdup(ci->values[0].value.string)) == NULL) {
285 ERROR("write_kafka plugin: cannot copy topic name.");
289 for (i = 0; i < ci->children_num; i++) {
291 * The code here could be simplified but makes room
292 * for easy adding of new options later on.
294 child = &ci->children[i];
297 if (strcasecmp ("Property", child->key) == 0) {
298 if (child->values_num != 2) {
299 WARNING("kafka properties need both a key and a value.");
302 if (child->values[0].type != OCONFIG_TYPE_STRING ||
303 child->values[1].type != OCONFIG_TYPE_STRING) {
304 WARNING("kafka properties needs string arguments.");
307 key = child->values[0].value.string;
308 val = child->values[1].value.string;
309 ret = rd_kafka_topic_conf_set(tctx->conf,key, val,
310 errbuf, sizeof(errbuf));
311 if (ret != RD_KAFKA_CONF_OK) {
312 WARNING("cannot set kafka topic property %s to %s: %s.",
317 } else if (strcasecmp ("Key", child->key) == 0) {
318 cf_util_get_string (child, &tctx->key);
319 } else if (strcasecmp ("Format", child->key) == 0) {
320 status = cf_util_get_string(child, &key);
326 if (strcasecmp(key, "Command") == 0) {
327 tctx->format = KAFKA_FORMAT_COMMAND;
329 } else if (strcasecmp(key, "Graphite") == 0) {
330 tctx->format = KAFKA_FORMAT_GRAPHITE;
332 } else if (strcasecmp(key, "Json") == 0) {
333 tctx->format = KAFKA_FORMAT_JSON;
336 WARNING ("write_kafka plugin: Invalid format string: %s",
342 } else if (strcasecmp ("StoreRates", child->key) == 0) {
343 status = cf_util_get_boolean (child, &tctx->store_rates);
344 (void) cf_util_get_flag (child, &tctx->graphite_flags,
345 GRAPHITE_STORE_RATES);
347 } else if (strcasecmp ("GraphiteSeparateInstances", child->key) == 0) {
348 status = cf_util_get_flag (child, &tctx->graphite_flags,
349 GRAPHITE_SEPARATE_INSTANCES);
351 } else if (strcasecmp ("GraphiteAlwaysAppendDS", child->key) == 0) {
352 status = cf_util_get_flag (child, &tctx->graphite_flags,
353 GRAPHITE_ALWAYS_APPEND_DS);
355 } else if (strcasecmp ("GraphitePrefix", child->key) == 0) {
356 status = cf_util_get_string (child, &tctx->prefix);
357 } else if (strcasecmp ("GraphitePostfix", child->key) == 0) {
358 status = cf_util_get_string (child, &tctx->postfix);
359 } else if (strcasecmp ("GraphiteEscapeChar", child->key) == 0) {
360 char *tmp_buff = NULL;
361 status = cf_util_get_string (child, &tmp_buff);
362 if (strlen (tmp_buff) > 1)
363 WARNING ("write_kafka plugin: The option \"GraphiteEscapeChar\" handles "
364 "only one character. Others will be ignored.");
365 tctx->escape_char = tmp_buff[0];
368 WARNING ("write_kafka plugin: Invalid directive: %s.", child->key);
375 rd_kafka_topic_conf_set_partitioner_cb(tctx->conf, kafka_partition);
376 rd_kafka_topic_conf_set_opaque(tctx->conf, tctx);
378 ssnprintf(callback_name, sizeof(callback_name),
379 "write_kafka/%s", tctx->topic_name);
382 ud.free_func = kafka_topic_context_free;
384 status = plugin_register_write (callback_name, kafka_write, &ud);
386 WARNING ("write_kafka plugin: plugin_register_write (\"%s\") "
387 "failed with status %i.",
388 callback_name, status);
392 pthread_mutex_init (&tctx->lock, /* attr = */ NULL);
396 if (tctx->topic_name != NULL)
397 free(tctx->topic_name);
398 if (tctx->conf != NULL)
399 rd_kafka_topic_conf_destroy(tctx->conf);
400 if (tctx->kafka_conf != NULL)
401 rd_kafka_conf_destroy(tctx->kafka_conf);
403 } /* }}} int kafka_config_topic */
405 static int kafka_config(oconfig_item_t *ci) /* {{{ */
408 oconfig_item_t *child;
409 rd_kafka_conf_t *conf;
410 rd_kafka_conf_res_t ret;
413 if ((conf = rd_kafka_conf_new()) == NULL) {
414 WARNING("cannot allocate kafka configuration.");
417 for (i = 0; i < ci->children_num; i++) {
418 child = &ci->children[i];
420 if (strcasecmp("Topic", child->key) == 0) {
421 kafka_config_topic (conf, child);
422 } else if (strcasecmp(child->key, "Property") == 0) {
426 if (child->values_num != 2) {
427 WARNING("kafka properties need both a key and a value.");
430 if (child->values[0].type != OCONFIG_TYPE_STRING ||
431 child->values[1].type != OCONFIG_TYPE_STRING) {
432 WARNING("kafka properties needs string arguments.");
435 if ((key = strdup(child->values[0].value.string)) == NULL) {
436 WARNING("cannot allocate memory for attribute key.");
439 if ((val = strdup(child->values[1].value.string)) == NULL) {
440 WARNING("cannot allocate memory for attribute value.");
444 ret = rd_kafka_conf_set(conf, key, val, errbuf, sizeof(errbuf));
445 if (ret != RD_KAFKA_CONF_OK) {
446 WARNING("cannot set kafka property %s to %s: %s",
455 WARNING ("write_kafka plugin: Ignoring unknown "
456 "configuration option \"%s\" at top level.",
461 rd_kafka_conf_destroy(conf);
465 rd_kafka_conf_destroy(conf);
467 } /* }}} int kafka_config */
469 void module_register(void)
471 plugin_register_complex_config ("write_kafka", kafka_config);