2 * collectd - src/amqp.c
3 * Copyright (C) 2009 Sebastien Pahl
4 * Copyright (C) 2010 Florian Forster
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
25 * Sebastien Pahl <sebastien.pahl at dotcloud.com>
26 * Florian Forster <octo at verplant.org>
38 #include "utils_cmd_putval.h"
39 #include "utils_format_json.h"
42 #include <amqp_framing.h>
44 /* Defines for the delivery mode. I have no idea why they're not defined by the
46 #define CAMQP_DM_VOLATILE 1
47 #define CAMQP_DM_PERSISTENT 2
49 #define CAMQP_FORMAT_COMMAND 1
50 #define CAMQP_FORMAT_JSON 2
52 #define CAMQP_CHANNEL 1
72 uint8_t delivery_mode;
80 amqp_connection_state_t connection;
83 typedef struct camqp_config_s camqp_config_t;
88 static const char *def_host = "localhost";
89 static const char *def_vhost = "/";
90 static const char *def_user = "guest";
91 static const char *def_password = "guest";
92 static const char *def_exchange = "amq.fanout";
94 static pthread_t *subscriber_threads = NULL;
95 static size_t subscriber_threads_num = 0;
96 static _Bool subscriber_threads_running = 1;
98 #define CONF(c,f) (((c)->f != NULL) ? (c)->f : def_##f)
103 static void camqp_close_connection (camqp_config_t *conf) /* {{{ */
107 if ((conf == NULL) || (conf->connection == NULL))
110 sockfd = amqp_get_sockfd (conf->connection);
111 amqp_channel_close (conf->connection, CAMQP_CHANNEL, AMQP_REPLY_SUCCESS);
112 amqp_connection_close (conf->connection, AMQP_REPLY_SUCCESS);
113 amqp_destroy_connection (conf->connection);
115 conf->connection = NULL;
116 } /* }}} void camqp_close_connection */
118 static void camqp_config_free (void *ptr) /* {{{ */
120 camqp_config_t *conf = ptr;
125 camqp_close_connection (conf);
131 sfree (conf->password);
132 sfree (conf->exchange);
133 sfree (conf->exchange_type);
135 sfree (conf->routing_key);
138 } /* }}} void camqp_config_free */
140 static char *camqp_bytes_cstring (amqp_bytes_t *in) /* {{{ */
144 if ((in == NULL) || (in->bytes == NULL))
147 ret = malloc (in->len + 1);
151 memcpy (ret, in->bytes, in->len);
155 } /* }}} char *camqp_bytes_cstring */
157 static _Bool camqp_is_error (camqp_config_t *conf) /* {{{ */
161 r = amqp_get_rpc_reply (conf->connection);
162 if (r.reply_type == AMQP_RESPONSE_NORMAL)
166 } /* }}} _Bool camqp_is_error */
168 static char *camqp_strerror (camqp_config_t *conf, /* {{{ */
169 char *buffer, size_t buffer_size)
173 r = amqp_get_rpc_reply (conf->connection);
174 switch (r.reply_type)
176 case AMQP_RESPONSE_NORMAL:
177 sstrncpy (buffer, "Success", sizeof (buffer));
180 case AMQP_RESPONSE_NONE:
181 sstrncpy (buffer, "Missing RPC reply type", sizeof (buffer));
184 case AMQP_RESPONSE_LIBRARY_EXCEPTION:
186 return (sstrerror (r.library_errno, buffer, buffer_size));
188 sstrncpy (buffer, "End of stream", sizeof (buffer));
191 case AMQP_RESPONSE_SERVER_EXCEPTION:
192 if (r.reply.id == AMQP_CONNECTION_CLOSE_METHOD)
194 amqp_connection_close_t *m = r.reply.decoded;
195 char *tmp = camqp_bytes_cstring (&m->reply_text);
196 ssnprintf (buffer, buffer_size, "Server connection error %d: %s",
200 else if (r.reply.id == AMQP_CHANNEL_CLOSE_METHOD)
202 amqp_channel_close_t *m = r.reply.decoded;
203 char *tmp = camqp_bytes_cstring (&m->reply_text);
204 ssnprintf (buffer, buffer_size, "Server channel error %d: %s",
210 ssnprintf (buffer, buffer_size, "Server error method %#"PRIx32,
216 ssnprintf (buffer, buffer_size, "Unknown reply type %i",
221 } /* }}} char *camqp_strerror */
223 static int camqp_create_exchange (camqp_config_t *conf) /* {{{ */
225 amqp_exchange_declare_ok_t *ed_ret;
227 if (conf->exchange_type == NULL)
230 ed_ret = amqp_exchange_declare (conf->connection,
231 /* channel = */ CAMQP_CHANNEL,
232 /* exchange = */ amqp_cstring_bytes (conf->exchange),
233 /* type = */ amqp_cstring_bytes (conf->exchange_type),
236 /* auto_delete = */ 1,
237 /* arguments = */ AMQP_EMPTY_TABLE);
238 if ((ed_ret == NULL) && camqp_is_error (conf))
241 ERROR ("amqp plugin: amqp_exchange_declare failed: %s",
242 camqp_strerror (conf, errbuf, sizeof (errbuf)));
243 camqp_close_connection (conf);
247 INFO ("amqp plugin: Successfully created exchange \"%s\" "
249 conf->exchange, conf->exchange_type);
252 } /* }}} int camqp_create_exchange */
254 static int camqp_setup_queue (camqp_config_t *conf) /* {{{ */
256 amqp_queue_declare_ok_t *qd_ret;
257 amqp_basic_consume_ok_t *cm_ret;
259 qd_ret = amqp_queue_declare (conf->connection,
260 /* channel = */ CAMQP_CHANNEL,
261 /* queue = */ (conf->queue != NULL)
262 ? amqp_cstring_bytes (conf->queue)
267 /* auto_delete = */ 1,
268 /* arguments = */ AMQP_EMPTY_TABLE);
271 ERROR ("amqp plugin: amqp_queue_declare failed.");
272 camqp_close_connection (conf);
276 if (conf->queue == NULL)
278 conf->queue = camqp_bytes_cstring (&qd_ret->queue);
279 if (conf->queue == NULL)
281 ERROR ("amqp plugin: camqp_bytes_cstring failed.");
282 camqp_close_connection (conf);
286 INFO ("amqp plugin: Created queue \"%s\".", conf->queue);
288 DEBUG ("amqp plugin: Successfully created queue \"%s\".", conf->queue);
290 /* bind to an exchange */
291 if (conf->exchange != NULL)
293 amqp_queue_bind_ok_t *qb_ret;
295 assert (conf->queue != NULL);
296 qb_ret = amqp_queue_bind (conf->connection,
297 /* channel = */ CAMQP_CHANNEL,
298 /* queue = */ amqp_cstring_bytes (conf->queue),
299 /* exchange = */ amqp_cstring_bytes (conf->exchange),
300 /* routing_key = */ (conf->routing_key != NULL)
301 ? amqp_cstring_bytes (conf->routing_key)
303 /* arguments = */ AMQP_EMPTY_TABLE);
304 if ((qb_ret == NULL) && camqp_is_error (conf))
307 ERROR ("amqp plugin: amqp_queue_bind failed: %s",
308 camqp_strerror (conf, errbuf, sizeof (errbuf)));
309 camqp_close_connection (conf);
313 DEBUG ("amqp plugin: Successfully bound queue \"%s\" to exchange \"%s\".",
314 conf->queue, conf->exchange);
315 } /* if (conf->exchange != NULL) */
317 cm_ret = amqp_basic_consume (conf->connection,
318 /* channel = */ CAMQP_CHANNEL,
319 /* queue = */ amqp_cstring_bytes (conf->queue),
320 /* consumer_tag = */ AMQP_EMPTY_BYTES,
323 /* exclusive = */ 0);
324 if ((cm_ret == NULL) && camqp_is_error (conf))
327 ERROR ("amqp plugin: amqp_basic_consume failed: %s",
328 camqp_strerror (conf, errbuf, sizeof (errbuf)));
329 camqp_close_connection (conf);
334 } /* }}} int camqp_setup_queue */
336 static int camqp_connect (camqp_config_t *conf) /* {{{ */
338 amqp_rpc_reply_t reply;
342 if (conf->connection != NULL)
345 conf->connection = amqp_new_connection ();
346 if (conf->connection == NULL)
348 ERROR ("amqp plugin: amqp_new_connection failed.");
352 sockfd = amqp_open_socket (CONF(conf, host), conf->port);
356 status = (-1) * sockfd;
357 ERROR ("amqp plugin: amqp_open_socket failed: %s",
358 sstrerror (status, errbuf, sizeof (errbuf)));
359 amqp_destroy_connection (conf->connection);
360 conf->connection = NULL;
363 amqp_set_sockfd (conf->connection, sockfd);
365 reply = amqp_login (conf->connection, CONF(conf, vhost),
366 /* channel max = */ 0,
367 /* frame max = */ 131072,
369 /* authentication = */ AMQP_SASL_METHOD_PLAIN,
370 CONF(conf, user), CONF(conf, password));
371 if (reply.reply_type != AMQP_RESPONSE_NORMAL)
373 ERROR ("amqp plugin: amqp_login (vhost = %s, user = %s) failed.",
374 CONF(conf, vhost), CONF(conf, user));
375 amqp_destroy_connection (conf->connection);
377 conf->connection = NULL;
381 amqp_channel_open (conf->connection, /* channel = */ 1);
382 /* FIXME: Is checking "reply.reply_type" really correct here? How does
383 * it get set? --octo */
384 if (reply.reply_type != AMQP_RESPONSE_NORMAL)
386 ERROR ("amqp plugin: amqp_channel_open failed.");
387 amqp_connection_close (conf->connection, AMQP_REPLY_SUCCESS);
388 amqp_destroy_connection (conf->connection);
390 conf->connection = NULL;
394 INFO ("amqp plugin: Successfully opened connection to vhost \"%s\" "
395 "on %s:%i.", CONF(conf, vhost), CONF(conf, host), conf->port);
397 status = camqp_create_exchange (conf);
402 return (camqp_setup_queue (conf));
404 } /* }}} int camqp_connect */
406 static int shutdown (void) /* {{{ */
410 DEBUG ("amqp plugin: Shutting down %zu subscriber threads.",
411 subscriber_threads_num);
413 subscriber_threads_running = 0;
414 for (i = 0; i < subscriber_threads_num; i++)
416 /* FIXME: Sending a signal is not very elegant here. Maybe find out how
417 * to use a timeout in the thread and check for the variable in regular
419 pthread_kill (subscriber_threads[i], SIGTERM);
420 pthread_join (subscriber_threads[i], /* retval = */ NULL);
423 subscriber_threads_num = 0;
424 sfree (subscriber_threads);
426 DEBUG ("amqp plugin: All subscriber threads exited.");
429 } /* }}} int shutdown */
434 static int camqp_read_body (camqp_config_t *conf, /* {{{ */
435 size_t body_size, const char *content_type)
437 char body[body_size + 1];
443 memset (body, 0, sizeof (body));
447 while (received < body_size)
449 status = amqp_simple_wait_frame (conf->connection, &frame);
453 status = (-1) * status;
454 ERROR ("amqp plugin: amqp_simple_wait_frame failed: %s",
455 sstrerror (status, errbuf, sizeof (errbuf)));
456 camqp_close_connection (conf);
460 if (frame.frame_type != AMQP_FRAME_BODY)
462 NOTICE ("amqp plugin: Unexpected frame type: %#"PRIx8,
467 if ((body_size - received) < frame.payload.body_fragment.len)
469 WARNING ("amqp plugin: Body is larger than indicated by header.");
473 memcpy (body_ptr, frame.payload.body_fragment.bytes,
474 frame.payload.body_fragment.len);
475 body_ptr += frame.payload.body_fragment.len;
476 received += frame.payload.body_fragment.len;
477 } /* while (received < body_size) */
479 if (strcasecmp ("text/collectd", content_type) == 0)
481 status = handle_putval (stderr, body);
483 ERROR ("amqp plugin: handle_putval failed with status %i.",
487 else if (strcasecmp ("application/json", content_type) == 0)
489 ERROR ("amqp plugin: camqp_read_body: Parsing JSON data has not "
490 "been implemented yet. FIXME!");
495 ERROR ("amqp plugin: camqp_read_body: Unknown content type \"%s\".",
502 } /* }}} int camqp_read_body */
504 static int camqp_read_header (camqp_config_t *conf) /* {{{ */
508 amqp_basic_properties_t *properties;
511 status = amqp_simple_wait_frame (conf->connection, &frame);
515 status = (-1) * status;
516 ERROR ("amqp plugin: amqp_simple_wait_frame failed: %s",
517 sstrerror (status, errbuf, sizeof (errbuf)));
518 camqp_close_connection (conf);
522 if (frame.frame_type != AMQP_FRAME_HEADER)
524 NOTICE ("amqp plugin: Unexpected frame type: %#"PRIx8,
529 properties = frame.payload.properties.decoded;
530 content_type = camqp_bytes_cstring (&properties->content_type);
531 if (content_type == NULL)
533 ERROR ("amqp plugin: Unable to determine content type.");
537 status = camqp_read_body (conf,
538 (size_t) frame.payload.properties.body_size,
541 sfree (content_type);
543 } /* }}} int camqp_read_header */
545 static void *camqp_subscribe_thread (void *user_data) /* {{{ */
547 camqp_config_t *conf = user_data;
550 while (subscriber_threads_running)
554 status = camqp_connect (conf);
557 ERROR ("amqp plugin: camqp_connect failed. "
558 "Will sleep for %i seconds.", interval_g);
563 status = amqp_simple_wait_frame (conf->connection, &frame);
566 ERROR ("amqp plugin: amqp_simple_wait_frame failed. "
567 "Will sleep for %i seconds.", interval_g);
568 camqp_close_connection (conf);
573 if (frame.frame_type != AMQP_FRAME_METHOD)
575 DEBUG ("amqp plugin: Unexpected frame type: %#"PRIx8,
580 if (frame.payload.method.id != AMQP_BASIC_DELIVER_METHOD)
582 DEBUG ("amqp plugin: Unexpected method id: %#"PRIx32,
583 frame.payload.method.id);
587 status = camqp_read_header (conf);
589 amqp_maybe_release_buffers (conf->connection);
590 } /* while (subscriber_threads_running) */
592 camqp_config_free (conf);
594 } /* }}} void *camqp_subscribe_thread */
596 static int camqp_subscribe_init (camqp_config_t *conf) /* {{{ */
601 tmp = realloc (subscriber_threads,
602 sizeof (*subscriber_threads) * (subscriber_threads_num + 1));
605 ERROR ("amqp plugin: realloc failed.");
606 camqp_config_free (conf);
609 subscriber_threads = tmp;
610 tmp = subscriber_threads + subscriber_threads_num;
611 memset (tmp, 0, sizeof (*tmp));
613 status = pthread_create (tmp, /* attr = */ NULL,
614 camqp_subscribe_thread, conf);
618 ERROR ("amqp plugin: pthread_create failed: %s",
619 sstrerror (status, errbuf, sizeof (errbuf)));
620 camqp_config_free (conf);
624 subscriber_threads_num++;
627 } /* }}} int camqp_subscribe_init */
632 static int camqp_write_locked (camqp_config_t *conf, /* {{{ */
633 const char *buffer, const char *routing_key)
635 amqp_basic_properties_t props;
638 status = camqp_connect (conf);
642 memset (&props, 0, sizeof (props));
643 props._flags = AMQP_BASIC_CONTENT_TYPE_FLAG
644 | AMQP_BASIC_DELIVERY_MODE_FLAG
645 | AMQP_BASIC_APP_ID_FLAG;
646 if (conf->format == CAMQP_FORMAT_COMMAND)
647 props.content_type = amqp_cstring_bytes("text/collectd");
648 else if (conf->format == CAMQP_FORMAT_JSON)
649 props.content_type = amqp_cstring_bytes("application/json");
652 props.delivery_mode = conf->delivery_mode;
653 props.app_id = amqp_cstring_bytes("collectd");
655 status = amqp_basic_publish(conf->connection,
657 amqp_cstring_bytes(CONF(conf, exchange)),
658 amqp_cstring_bytes (routing_key),
662 amqp_cstring_bytes(buffer));
665 ERROR ("amqp plugin: amqp_basic_publish failed with status %i.",
667 camqp_close_connection (conf);
671 } /* }}} int camqp_write_locked */
673 static int camqp_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
674 user_data_t *user_data)
676 camqp_config_t *conf = user_data->data;
677 char routing_key[6 * DATA_MAX_NAME_LEN];
681 if ((ds == NULL) || (vl == NULL) || (conf == NULL))
684 memset (buffer, 0, sizeof (buffer));
686 if (conf->routing_key != NULL)
688 sstrncpy (routing_key, conf->routing_key, sizeof (routing_key));
693 ssnprintf (routing_key, sizeof (routing_key), "collectd/%s/%s/%s/%s/%s",
695 vl->plugin, vl->plugin_instance,
696 vl->type, vl->type_instance);
698 /* Switch slashes (the only character forbidden by collectd) and dots
699 * (the separation character used by AMQP). */
700 for (i = 0; routing_key[i] != 0; i++)
702 if (routing_key[i] == '.')
703 routing_key[i] = '/';
704 else if (routing_key[i] == '/')
705 routing_key[i] = '.';
709 if (conf->format == CAMQP_FORMAT_COMMAND)
711 status = create_putval (buffer, sizeof (buffer), ds, vl);
714 ERROR ("amqp plugin: create_putval failed with status %i.",
719 else if (conf->format == CAMQP_FORMAT_JSON)
721 size_t bfree = sizeof (buffer);
724 format_json_initialize (buffer, &bfill, &bfree);
725 format_json_value_list (buffer, &bfill, &bfree, ds, vl, conf->store_rates);
726 format_json_finalize (buffer, &bfill, &bfree);
730 ERROR ("amqp plugin: Invalid format (%i).", conf->format);
734 pthread_mutex_lock (&conf->lock);
735 status = camqp_write_locked (conf, buffer, routing_key);
736 pthread_mutex_unlock (&conf->lock);
739 } /* }}} int camqp_write */
744 static int camqp_config_set_format (oconfig_item_t *ci, /* {{{ */
745 camqp_config_t *conf)
751 status = cf_util_get_string (ci, &string);
755 assert (string != NULL);
756 if (strcasecmp ("Command", string) == 0)
757 conf->format = CAMQP_FORMAT_COMMAND;
758 else if (strcasecmp ("JSON", string) == 0)
759 conf->format = CAMQP_FORMAT_JSON;
762 WARNING ("amqp plugin: Invalid format string: %s",
769 } /* }}} int config_set_string */
771 static int camqp_config_connection (oconfig_item_t *ci, /* {{{ */
774 camqp_config_t *conf;
778 conf = malloc (sizeof (*conf));
781 ERROR ("amqp plugin: malloc failed.");
785 /* Initialize "conf" {{{ */
786 memset (conf, 0, sizeof (*conf));
787 conf->publish = publish;
789 conf->format = CAMQP_FORMAT_COMMAND;
794 conf->password = NULL;
795 conf->exchange = NULL;
796 conf->routing_key = NULL;
798 conf->delivery_mode = CAMQP_DM_VOLATILE;
799 conf->store_rates = 0;
801 conf->exchange_type = NULL;
804 conf->connection = NULL;
805 pthread_mutex_init (&conf->lock, /* attr = */ NULL);
808 status = cf_util_get_string (ci, &conf->name);
815 for (i = 0; i < ci->children_num; i++)
817 oconfig_item_t *child = ci->children + i;
819 if (strcasecmp ("Host", child->key) == 0)
820 status = cf_util_get_string (child, &conf->host);
821 else if (strcasecmp ("Port", child->key) == 0)
823 status = cf_util_get_port_number (child);
830 else if (strcasecmp ("VHost", child->key) == 0)
831 status = cf_util_get_string (child, &conf->vhost);
832 else if (strcasecmp ("User", child->key) == 0)
833 status = cf_util_get_string (child, &conf->user);
834 else if (strcasecmp ("Password", child->key) == 0)
835 status = cf_util_get_string (child, &conf->password);
836 else if (strcasecmp ("Exchange", child->key) == 0)
837 status = cf_util_get_string (child, &conf->exchange);
838 else if ((strcasecmp ("ExchangeType", child->key) == 0) && !publish)
839 status = cf_util_get_string (child, &conf->exchange_type);
840 else if ((strcasecmp ("Queue", child->key) == 0) && !publish)
841 status = cf_util_get_string (child, &conf->queue);
842 else if (strcasecmp ("RoutingKey", child->key) == 0)
843 status = cf_util_get_string (child, &conf->routing_key);
844 else if ((strcasecmp ("Persistent", child->key) == 0) && publish)
847 status = cf_util_get_boolean (child, &tmp);
849 conf->delivery_mode = CAMQP_DM_PERSISTENT;
851 conf->delivery_mode = CAMQP_DM_VOLATILE;
853 else if ((strcasecmp ("StoreRates", child->key) == 0) && publish)
854 status = cf_util_get_boolean (child, &conf->store_rates);
855 else if ((strcasecmp ("Format", child->key) == 0) && publish)
856 status = camqp_config_set_format (child, conf);
858 WARNING ("amqp plugin: Ignoring unknown "
859 "configuration option \"%s\".", child->key);
863 } /* for (i = 0; i < ci->children_num; i++) */
865 if ((status == 0) && !publish && (conf->exchange == NULL))
867 if (conf->routing_key != NULL)
868 WARNING ("amqp plugin: The option \"RoutingKey\" was given "
869 "without the \"Exchange\" option. It will be ignored.");
871 if (conf->exchange_type != NULL)
872 WARNING ("amqp plugin: The option \"ExchangeType\" was given "
873 "without the \"Exchange\" option. It will be ignored.");
878 camqp_config_free (conf);
882 if (conf->exchange != NULL)
884 DEBUG ("amqp plugin: camqp_config_connection: exchange = %s;",
891 user_data_t ud = { conf, camqp_config_free };
893 ssnprintf (cbname, sizeof (cbname), "amqp/%s", conf->name);
895 status = plugin_register_write (cbname, camqp_write, &ud);
898 camqp_config_free (conf);
904 status = camqp_subscribe_init (conf);
907 camqp_config_free (conf);
913 } /* }}} int camqp_config_connection */
915 static int camqp_config (oconfig_item_t *ci) /* {{{ */
919 for (i = 0; i < ci->children_num; i++)
921 oconfig_item_t *child = ci->children + i;
923 if (strcasecmp ("Publish", child->key) == 0)
924 camqp_config_connection (child, /* publish = */ 1);
925 else if (strcasecmp ("Subscribe", child->key) == 0)
926 camqp_config_connection (child, /* publish = */ 0);
928 WARNING ("amqp plugin: Ignoring unknown config option \"%s\".",
930 } /* for (ci->children_num) */
933 } /* }}} int camqp_config */
935 void module_register (void)
937 plugin_register_complex_config ("amqp", camqp_config);
938 plugin_register_shutdown ("amqp", shutdown);
939 } /* void module_register */
941 /* vim: set sw=4 sts=4 et fdm=marker : */