2 * collectd - src/amqp1.c
3 * Copyright(c) 2017 Red Hat Inc.
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 * Andy Smith <ansmith@redhat.com>
31 #include "utils_cmd_putval.h"
32 #include "utils_deq.h"
33 #include "utils_format_graphite.h"
34 #include "utils_format_json.h"
35 #include "utils_random.h"
37 #include <proton/condition.h>
38 #include <proton/connection.h>
39 #include <proton/delivery.h>
40 #include <proton/link.h>
41 #include <proton/message.h>
42 #include <proton/proactor.h>
43 #include <proton/sasl.h>
44 #include <proton/session.h>
45 #include <proton/transport.h>
53 #define AMQP1_FORMAT_JSON 0
54 #define AMQP1_FORMAT_COMMAND 1
55 #define AMQP1_FORMAT_GRAPHITE 2
57 typedef struct amqp1_config_transport_s {
58 DEQ_LINKS(struct amqp1_config_transport_s);
66 } amqp1_config_transport_t;
68 typedef struct amqp1_config_instance_s {
69 DEQ_LINKS(struct amqp1_config_instance_s);
73 unsigned int graphite_flags;
80 } amqp1_config_instance_t;
82 DEQ_DECLARE(amqp1_config_instance_t, amqp1_config_instance_list_t);
84 typedef struct cd_message_s {
85 DEQ_LINKS(struct cd_message_s);
87 amqp1_config_instance_t *instance;
90 DEQ_DECLARE(cd_message_t, cd_message_list_t);
95 static pn_connection_t *conn;
96 static pn_link_t *sender;
97 static pn_proactor_t *proactor;
98 static pthread_mutex_t send_lock;
99 static cd_message_list_t out_messages;
100 static uint64_t cd_tag = 1;
101 static uint64_t acknowledged;
102 static amqp1_config_transport_t *transport;
103 static bool stopping;
104 static bool event_thread_running;
105 static pthread_t event_thread_id;
110 static void cd_message_free(cd_message_t *cdm) {
111 free(cdm->mbuf.start);
113 } /* }}} void cd_message_free */
115 static int amqp1_send_out_messages(pn_link_t *link) /* {{{ */
118 cd_message_list_t to_send;
120 int link_credit = pn_link_credit(link);
130 pthread_mutex_lock(&send_lock);
132 if (link_credit > 0) {
134 cdm = DEQ_HEAD(out_messages);
136 DEQ_REMOVE_HEAD(out_messages);
137 DEQ_INSERT_TAIL(to_send, cdm);
138 if (DEQ_SIZE(to_send) == link_credit)
140 cdm = DEQ_HEAD(out_messages);
142 cd_tag += DEQ_SIZE(to_send);
145 pthread_mutex_unlock(&send_lock);
147 /* message is already formatted and encoded */
148 cdm = DEQ_HEAD(to_send);
150 DEQ_REMOVE_HEAD(to_send);
152 dlv = pn_delivery(link, pn_dtag((const char *)&dtag, sizeof(dtag)));
153 pn_link_send(link, cdm->mbuf.start, cdm->mbuf.size);
154 pn_link_advance(link);
155 if (cdm->instance->pre_settle == true) {
156 pn_delivery_settle(dlv);
159 cd_message_free(cdm);
160 cdm = DEQ_HEAD(to_send);
164 } /* }}} int amqp1_send_out_messages */
166 static void check_condition(pn_event_t *e, pn_condition_t *cond) /* {{{ */
168 if (pn_condition_is_set(cond)) {
169 ERROR("amqp1 plugin: %s: %s: %s", pn_event_type_name(pn_event_type(e)),
170 pn_condition_get_name(cond), pn_condition_get_description(cond));
171 pn_connection_close(pn_event_connection(e));
174 } /* }}} void check_condition */
176 static bool handle(pn_event_t *event) /* {{{ */
179 switch (pn_event_type(event)) {
181 case PN_CONNECTION_INIT: {
182 conn = pn_event_connection(event);
183 pn_connection_set_container(conn, transport->name);
184 pn_connection_open(conn);
185 pn_session_t *ssn = pn_session(conn);
186 pn_session_open(ssn);
187 sender = pn_sender(ssn, "cd-sender");
188 pn_link_set_snd_settle_mode(sender, PN_SND_MIXED);
189 pn_link_open(sender);
194 /* peer has given us credit, send outbound messages */
195 amqp1_send_out_messages(sender);
200 /* acknowledgement from peer that a message was delivered */
201 pn_delivery_t *dlv = pn_event_delivery(event);
202 if (pn_delivery_remote_state(dlv) == PN_ACCEPTED) {
203 pn_delivery_settle(dlv);
209 case PN_CONNECTION_WAKE: {
211 amqp1_send_out_messages(sender);
216 case PN_TRANSPORT_CLOSED: {
217 check_condition(event, pn_transport_condition(pn_event_transport(event)));
221 case PN_CONNECTION_REMOTE_CLOSE: {
222 check_condition(event,
223 pn_session_remote_condition(pn_event_session(event)));
224 pn_connection_close(pn_event_connection(event));
228 case PN_SESSION_REMOTE_CLOSE: {
229 check_condition(event,
230 pn_session_remote_condition(pn_event_session(event)));
231 pn_connection_close(pn_event_connection(event));
235 case PN_LINK_REMOTE_CLOSE:
236 case PN_LINK_REMOTE_DETACH: {
237 check_condition(event, pn_link_remote_condition(pn_event_link(event)));
238 pn_connection_close(pn_event_connection(event));
242 case PN_PROACTOR_INACTIVE: {
250 } /* }}} bool handle */
252 static void *event_thread(void __attribute__((unused)) * arg) /* {{{ */
254 char addr[PN_MAX_ADDR];
258 proactor = pn_proactor();
259 pn_proactor_addr(addr, sizeof(addr), transport->host, transport->port);
262 /* make connection */
263 conn = pn_connection();
264 if (transport->user != NULL) {
265 pn_connection_set_user(conn, transport->user);
266 pn_connection_set_password(conn, transport->password);
268 pn_proactor_connect(proactor, conn, addr);
270 bool engine_running = true;
271 while (engine_running && !stopping) {
272 pn_event_batch_t *events = pn_proactor_wait(proactor);
274 while ((e = pn_event_batch_next(events))) {
275 engine_running = handle(e);
276 if (!engine_running) {
280 pn_proactor_done(proactor, events);
283 pn_proactor_release_connection(conn);
285 DEBUG("amqp1 plugin: retrying connection");
286 int delay = transport->retry_delay;
287 while (delay-- > 0 && !stopping) {
292 pn_proactor_disconnect(proactor, NULL);
294 /* Free the remaining out_messages */
295 cdm = DEQ_HEAD(out_messages);
297 DEQ_REMOVE_HEAD(out_messages);
298 cd_message_free(cdm);
299 cdm = DEQ_HEAD(out_messages);
302 event_thread_running = false;
305 } /* }}} void event_thread */
307 static int encqueue(cd_message_t *cdm,
308 amqp1_config_instance_t *instance) /* {{{ */
310 size_t bufsize = BUFSIZE;
312 pn_message_t *message;
316 message = pn_message();
317 pn_message_set_address(message, instance->send_to);
318 body = pn_message_body(message);
320 pn_data_put_binary(body, pn_bytes(cdm->mbuf.size, cdm->mbuf.start));
323 /* put_binary copies and stores so ok to use mbuf */
324 cdm->mbuf.size = bufsize;
325 while ((status = pn_message_encode(message, (char *)cdm->mbuf.start,
326 &cdm->mbuf.size)) == PN_OVERFLOW) {
327 DEBUG("amqp1 plugin: increasing message buffer size %i",
328 (int)cdm->mbuf.size);
330 cdm->mbuf.start = (char *)realloc(cdm->mbuf.start, cdm->mbuf.size);
334 ERROR("amqp1 plugin: error encoding message: %s",
335 pn_error_text(pn_message_error(message)));
336 pn_message_free(message);
337 cd_message_free(cdm);
341 pthread_mutex_lock(&send_lock);
342 DEQ_INSERT_TAIL(out_messages, cdm);
343 pthread_mutex_unlock(&send_lock);
345 pn_message_free(message);
347 /* activate the sender */
349 pn_connection_wake(conn);
353 } /* }}} int encqueue */
355 static int amqp1_notify(notification_t const *n,
356 user_data_t *user_data) /* {{{ */
358 amqp1_config_instance_t *instance;
360 size_t bfree = BUFSIZE;
363 size_t bufsize = BUFSIZE;
365 if ((n == NULL) || (user_data == NULL))
368 instance = user_data->data;
370 if (instance->notify != true) {
371 ERROR("amqp1 plugin: write notification failed");
374 cdm = (cd_message_t *)malloc(sizeof(cd_message_t));
376 cdm->mbuf = pn_rwbytes(bufsize, (char *)malloc(bufsize));
377 cdm->instance = instance;
379 switch (instance->format) {
380 case AMQP1_FORMAT_JSON:
381 format_json_initialize((char *)cdm->mbuf.start, &bfill, &bfree);
382 status = format_json_notification((char *)cdm->mbuf.start, bufsize, n);
384 ERROR("amqp1 plugin: formatting notification failed");
387 cdm->mbuf.size = strlen(cdm->mbuf.start);
390 ERROR("amqp1 plugin: Invalid notify format (%i).", instance->format);
394 /* encode message and place on outbound queue */
395 status = encqueue(cdm, instance);
398 } /* }}} int amqp1_notify */
400 static int amqp1_write(const data_set_t *ds, const value_list_t *vl, /* {{{ */
401 user_data_t *user_data) {
402 amqp1_config_instance_t *instance;
404 size_t bfree = BUFSIZE;
407 size_t bufsize = BUFSIZE;
409 if ((ds == NULL) || (vl == NULL) || (transport == NULL) ||
413 instance = user_data->data;
415 if (instance->notify != false) {
416 ERROR("amqp1 plugin: write failed");
419 cdm = (cd_message_t *)malloc(sizeof(cd_message_t));
421 cdm->mbuf = pn_rwbytes(bufsize, (char *)malloc(bufsize));
422 cdm->instance = instance;
424 switch (instance->format) {
425 case AMQP1_FORMAT_COMMAND:
426 status = cmd_create_putval((char *)cdm->mbuf.start, bufsize, ds, vl);
428 ERROR("amqp1 plugin: cmd_create_putval failed with status %i.", status);
431 cdm->mbuf.size = strlen(cdm->mbuf.start);
433 case AMQP1_FORMAT_JSON:
434 format_json_initialize((char *)cdm->mbuf.start, &bfill, &bfree);
435 format_json_value_list((char *)cdm->mbuf.start, &bfill, &bfree, ds, vl,
436 instance->store_rates);
437 format_json_finalize((char *)cdm->mbuf.start, &bfill, &bfree);
438 cdm->mbuf.size = strlen(cdm->mbuf.start);
440 case AMQP1_FORMAT_GRAPHITE:
441 status = format_graphite((char *)cdm->mbuf.start, bufsize, ds, vl,
442 instance->prefix, instance->postfix,
443 instance->escape_char, instance->graphite_flags);
445 ERROR("amqp1 plugin: format_graphite failed with status %i.", status);
448 cdm->mbuf.size = strlen(cdm->mbuf.start);
451 ERROR("amqp1 plugin: Invalid write format (%i).", instance->format);
455 /* encode message and place on outboud queue */
456 encqueue(cdm, instance);
459 } /* }}} int amqp1_write */
461 static void amqp1_config_transport_free(void *ptr) /* {{{ */
463 amqp1_config_transport_t *transport = ptr;
465 if (transport == NULL)
468 sfree(transport->name);
469 sfree(transport->host);
470 sfree(transport->user);
471 sfree(transport->password);
472 sfree(transport->address);
475 } /* }}} void amqp1_config_transport_free */
477 static void amqp1_config_instance_free(void *ptr) /* {{{ */
479 amqp1_config_instance_t *instance = ptr;
481 if (instance == NULL)
484 sfree(instance->name);
485 sfree(instance->prefix);
486 sfree(instance->postfix);
489 } /* }}} void amqp1_config_instance_free */
491 static int amqp1_config_instance(oconfig_item_t *ci) /* {{{ */
495 amqp1_config_instance_t *instance;
497 instance = calloc(1, sizeof(*instance));
498 if (instance == NULL) {
499 ERROR("amqp1 plugin: calloc failed.");
503 status = cf_util_get_string(ci, &instance->name);
509 for (int i = 0; i < ci->children_num; i++) {
510 oconfig_item_t *child = ci->children + i;
512 if (strcasecmp("PreSettle", child->key) == 0)
513 status = cf_util_get_boolean(child, &instance->pre_settle);
514 else if (strcasecmp("Notify", child->key) == 0)
515 status = cf_util_get_boolean(child, &instance->notify);
516 else if (strcasecmp("Format", child->key) == 0) {
517 status = cf_util_get_string(child, &key);
520 /* TODO: goto errout */
523 if (strcasecmp(key, "Command") == 0) {
524 instance->format = AMQP1_FORMAT_COMMAND;
525 } else if (strcasecmp(key, "Graphite") == 0) {
526 instance->format = AMQP1_FORMAT_GRAPHITE;
527 } else if (strcasecmp(key, "JSON") == 0) {
528 instance->format = AMQP1_FORMAT_JSON;
530 WARNING("amqp1 plugin: Invalid format string: %s", key);
533 } else if (strcasecmp("StoreRates", child->key) == 0)
534 status = cf_util_get_boolean(child, &instance->store_rates);
535 else if (strcasecmp("GraphiteSeparateInstances", child->key) == 0)
536 status = cf_util_get_flag(child, &instance->graphite_flags,
537 GRAPHITE_SEPARATE_INSTANCES);
538 else if (strcasecmp("GraphiteAlwaysAppendDS", child->key) == 0)
539 status = cf_util_get_flag(child, &instance->graphite_flags,
540 GRAPHITE_ALWAYS_APPEND_DS);
541 else if (strcasecmp("GraphitePreserveSeparator", child->key) == 0)
542 status = cf_util_get_flag(child, &instance->graphite_flags,
543 GRAPHITE_PRESERVE_SEPARATOR);
544 else if (strcasecmp("GraphitePrefix", child->key) == 0)
545 status = cf_util_get_string(child, &instance->prefix);
546 else if (strcasecmp("GraphitePostfix", child->key) == 0)
547 status = cf_util_get_string(child, &instance->postfix);
548 else if (strcasecmp("GraphiteEscapeChar", child->key) == 0) {
549 char *tmp_buff = NULL;
550 status = cf_util_get_string(child, &tmp_buff);
552 if (strlen(tmp_buff) > 1)
553 WARNING("amqp1 plugin: The option \"GraphiteEscapeChar\" handles "
554 "only one character. Others will be ignored.");
555 instance->escape_char = tmp_buff[0];
559 WARNING("amqp1 plugin: Ignoring unknown "
560 "instance configuration option "
568 amqp1_config_instance_free(instance);
571 char tpname[DATA_MAX_NAME_LEN];
572 status = snprintf(tpname, sizeof(tpname), "amqp1/%s", instance->name);
573 if ((status < 0) || (size_t)status >= sizeof(tpname)) {
574 ERROR("amqp1 plugin: Instance name would have been truncated.");
577 status = snprintf(instance->send_to, sizeof(instance->send_to), "/%s/%s",
578 transport->address, instance->name);
579 if ((status < 0) || (size_t)status >= sizeof(instance->send_to)) {
580 ERROR("amqp1 plugin: send_to address would have been truncated.");
583 if (instance->notify == true) {
584 status = plugin_register_notification(
585 tpname, amqp1_notify,
587 .data = instance, .free_func = amqp1_config_instance_free,
590 status = plugin_register_write(
593 .data = instance, .free_func = amqp1_config_instance_free,
598 amqp1_config_instance_free(instance);
603 } /* }}} int amqp1_config_instance */
605 static int amqp1_config_transport(oconfig_item_t *ci) /* {{{ */
609 transport = calloc(1, sizeof(*transport));
610 if (transport == NULL) {
611 ERROR("amqp1 plugin: calloc failed.");
615 /* Initialize transport configuration {{{ */
616 transport->retry_delay = 1;
618 status = cf_util_get_string(ci, &transport->name);
624 for (int i = 0; i < ci->children_num; i++) {
625 oconfig_item_t *child = ci->children + i;
627 if (strcasecmp("Host", child->key) == 0)
628 status = cf_util_get_string(child, &transport->host);
629 else if (strcasecmp("Port", child->key) == 0)
630 status = cf_util_get_string(child, &transport->port);
631 else if (strcasecmp("User", child->key) == 0)
632 status = cf_util_get_string(child, &transport->user);
633 else if (strcasecmp("Password", child->key) == 0)
634 status = cf_util_get_string(child, &transport->password);
635 else if (strcasecmp("Address", child->key) == 0)
636 status = cf_util_get_string(child, &transport->address);
637 else if (strcasecmp("RetryDelay", child->key) == 0)
638 status = cf_util_get_int(child, &transport->retry_delay);
639 else if (strcasecmp("Instance", child->key) == 0)
640 amqp1_config_instance(child);
642 WARNING("amqp1 plugin: Ignoring unknown "
643 "transport configuration option "
652 amqp1_config_transport_free(transport);
655 } /* }}} int amqp1_config_transport */
657 static int amqp1_config(oconfig_item_t *ci) /* {{{ */
660 for (int i = 0; i < ci->children_num; i++) {
661 oconfig_item_t *child = ci->children + i;
663 if (strcasecmp("Transport", child->key) == 0)
664 amqp1_config_transport(child);
666 WARNING("amqp1 plugin: Ignoring unknown config option \%s\".",
671 } /* }}} int amqp1_config */
673 static int amqp1_init(void) /* {{{ */
678 if (transport == NULL) {
679 ERROR("amqp1: init failed, no transport configured");
683 if (proactor == NULL) {
684 pthread_mutex_init(&send_lock, /* attr = */ NULL);
687 plugin_thread_create(&event_thread_id, NULL /* no attributes */,
688 event_thread, NULL /* no argument */, "handle");
690 ERROR("amqp1 plugin: pthread_create failed: %s",
691 sstrerror(errno, errbuf, sizeof(errbuf)));
693 event_thread_running = true;
697 } /* }}} int amqp1_init */
699 static int amqp1_shutdown(void) /* {{{ */
703 /* Stop the proactor thread */
704 if (event_thread_running) {
705 DEBUG("amqp1 plugin: Shutting down proactor thread.");
706 pn_connection_wake(conn);
708 pthread_join(event_thread_id, NULL /* no return value */);
709 memset(&event_thread_id, 0, sizeof(event_thread_id));
711 DEBUG("amqp1 plugin: proactor thread exited.");
713 if (transport != NULL) {
714 amqp1_config_transport_free(transport);
718 } /* }}} int amqp1_shutdown */
720 void module_register(void) {
721 plugin_register_complex_config("amqp1", amqp1_config);
722 plugin_register_init("amqp1", amqp1_init);
723 plugin_register_shutdown("amqp1", amqp1_shutdown);
724 } /* void module_register */