f9777a9b2a6f390c4ed4eec927f0e01465538f16
1 /**
2 * collectd - src/amqp.c
3 * Copyright (C) 2009 Sebastien Pahl
4 * Copyright (C) 2010-2012 Florian Forster
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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.
23 *
24 * Authors:
25 * Sebastien Pahl <sebastien.pahl at dotcloud.com>
26 * Florian Forster <octo at collectd.org>
27 **/
29 #include "collectd.h"
31 #include "common.h"
32 #include "plugin.h"
33 #include "utils_cmd_putval.h"
34 #include "utils_format_json.h"
35 #include "utils_format_graphite.h"
37 #include <amqp.h>
38 #include <amqp_framing.h>
40 #ifdef HAVE_AMQP_TCP_SOCKET_H
41 # include <amqp_tcp_socket.h>
42 #endif
43 #ifdef HAVE_AMQP_SOCKET_H
44 # include <amqp_socket.h>
45 #endif
46 #ifdef HAVE_AMQP_TCP_SOCKET
47 #if defined HAVE_DECL_AMQP_SOCKET_CLOSE && !HAVE_DECL_AMQP_SOCKET_CLOSE
48 /* rabbitmq-c does not currently ship amqp_socket.h
49 * and, thus, does not define this function. */
50 int amqp_socket_close(amqp_socket_t *);
51 #endif
52 #endif
54 /* Defines for the delivery mode. I have no idea why they're not defined by the
55 * library.. */
56 #define CAMQP_DM_VOLATILE 1
57 #define CAMQP_DM_PERSISTENT 2
59 #define CAMQP_FORMAT_COMMAND 1
60 #define CAMQP_FORMAT_JSON 2
61 #define CAMQP_FORMAT_GRAPHITE 3
63 #define CAMQP_CHANNEL 1
65 /*
66 * Data types
67 */
68 struct camqp_config_s
69 {
70 _Bool publish;
71 char *name;
73 char *host;
74 int port;
75 char *vhost;
76 char *user;
77 char *password;
79 char *exchange;
80 char *routing_key;
82 /* Number of seconds to wait before connection is retried */
83 int connection_retry_delay;
85 /* publish only */
86 uint8_t delivery_mode;
87 _Bool store_rates;
88 int format;
89 /* publish & graphite format only */
90 char *prefix;
91 char *postfix;
92 char escape_char;
93 unsigned int graphite_flags;
95 /* subscribe only */
96 char *exchange_type;
97 char *queue;
98 _Bool queue_durable;
99 _Bool queue_auto_delete;
101 amqp_connection_state_t connection;
102 pthread_mutex_t lock;
103 };
104 typedef struct camqp_config_s camqp_config_t;
106 /*
107 * Global variables
108 */
109 static const char *def_host = "localhost";
110 static const char *def_vhost = "/";
111 static const char *def_user = "guest";
112 static const char *def_password = "guest";
113 static const char *def_exchange = "amq.fanout";
115 static pthread_t *subscriber_threads = NULL;
116 static size_t subscriber_threads_num = 0;
117 static _Bool subscriber_threads_running = 1;
119 #define CONF(c,f) (((c)->f != NULL) ? (c)->f : def_##f)
121 /*
122 * Functions
123 */
124 static void camqp_close_connection (camqp_config_t *conf) /* {{{ */
125 {
126 int sockfd;
128 if ((conf == NULL) || (conf->connection == NULL))
129 return;
131 sockfd = amqp_get_sockfd (conf->connection);
132 amqp_channel_close (conf->connection, CAMQP_CHANNEL, AMQP_REPLY_SUCCESS);
133 amqp_connection_close (conf->connection, AMQP_REPLY_SUCCESS);
134 amqp_destroy_connection (conf->connection);
135 close (sockfd);
136 conf->connection = NULL;
137 } /* }}} void camqp_close_connection */
139 static void camqp_config_free (void *ptr) /* {{{ */
140 {
141 camqp_config_t *conf = ptr;
143 if (conf == NULL)
144 return;
146 camqp_close_connection (conf);
148 sfree (conf->name);
149 sfree (conf->host);
150 sfree (conf->vhost);
151 sfree (conf->user);
152 sfree (conf->password);
153 sfree (conf->exchange);
154 sfree (conf->exchange_type);
155 sfree (conf->queue);
156 sfree (conf->routing_key);
157 sfree (conf->prefix);
158 sfree (conf->postfix);
161 sfree (conf);
162 } /* }}} void camqp_config_free */
164 static char *camqp_bytes_cstring (amqp_bytes_t *in) /* {{{ */
165 {
166 char *ret;
168 if ((in == NULL) || (in->bytes == NULL))
169 return (NULL);
171 ret = malloc (in->len + 1);
172 if (ret == NULL)
173 return (NULL);
175 memcpy (ret, in->bytes, in->len);
176 ret[in->len] = 0;
178 return (ret);
179 } /* }}} char *camqp_bytes_cstring */
181 static _Bool camqp_is_error (camqp_config_t *conf) /* {{{ */
182 {
183 amqp_rpc_reply_t r;
185 r = amqp_get_rpc_reply (conf->connection);
186 if (r.reply_type == AMQP_RESPONSE_NORMAL)
187 return (0);
189 return (1);
190 } /* }}} _Bool camqp_is_error */
192 static char *camqp_strerror (camqp_config_t *conf, /* {{{ */
193 char *buffer, size_t buffer_size)
194 {
195 amqp_rpc_reply_t r;
197 r = amqp_get_rpc_reply (conf->connection);
198 switch (r.reply_type)
199 {
200 case AMQP_RESPONSE_NORMAL:
201 sstrncpy (buffer, "Success", buffer_size);
202 break;
204 case AMQP_RESPONSE_NONE:
205 sstrncpy (buffer, "Missing RPC reply type", buffer_size);
206 break;
208 case AMQP_RESPONSE_LIBRARY_EXCEPTION:
209 #if HAVE_AMQP_RPC_REPLY_T_LIBRARY_ERRNO
210 if (r.library_errno)
211 return (sstrerror (r.library_errno, buffer, buffer_size));
212 #else
213 if (r.library_error)
214 return (sstrerror (r.library_error, buffer, buffer_size));
215 #endif
216 else
217 sstrncpy (buffer, "End of stream", buffer_size);
218 break;
220 case AMQP_RESPONSE_SERVER_EXCEPTION:
221 if (r.reply.id == AMQP_CONNECTION_CLOSE_METHOD)
222 {
223 amqp_connection_close_t *m = r.reply.decoded;
224 char *tmp = camqp_bytes_cstring (&m->reply_text);
225 ssnprintf (buffer, buffer_size, "Server connection error %d: %s",
226 m->reply_code, tmp);
227 sfree (tmp);
228 }
229 else if (r.reply.id == AMQP_CHANNEL_CLOSE_METHOD)
230 {
231 amqp_channel_close_t *m = r.reply.decoded;
232 char *tmp = camqp_bytes_cstring (&m->reply_text);
233 ssnprintf (buffer, buffer_size, "Server channel error %d: %s",
234 m->reply_code, tmp);
235 sfree (tmp);
236 }
237 else
238 {
239 ssnprintf (buffer, buffer_size, "Server error method %#"PRIx32,
240 r.reply.id);
241 }
242 break;
244 default:
245 ssnprintf (buffer, buffer_size, "Unknown reply type %i",
246 (int) r.reply_type);
247 }
249 return (buffer);
250 } /* }}} char *camqp_strerror */
252 #if HAVE_AMQP_RPC_REPLY_T_LIBRARY_ERRNO
253 static int camqp_create_exchange (camqp_config_t *conf) /* {{{ */
254 {
255 amqp_exchange_declare_ok_t *ed_ret;
257 if (conf->exchange_type == NULL)
258 return (0);
260 ed_ret = amqp_exchange_declare (conf->connection,
261 /* channel = */ CAMQP_CHANNEL,
262 /* exchange = */ amqp_cstring_bytes (conf->exchange),
263 /* type = */ amqp_cstring_bytes (conf->exchange_type),
264 /* passive = */ 0,
265 /* durable = */ 0,
266 /* auto_delete = */ 1,
267 /* arguments = */ AMQP_EMPTY_TABLE);
268 if ((ed_ret == NULL) && camqp_is_error (conf))
269 {
270 char errbuf[1024];
271 ERROR ("amqp plugin: amqp_exchange_declare failed: %s",
272 camqp_strerror (conf, errbuf, sizeof (errbuf)));
273 camqp_close_connection (conf);
274 return (-1);
275 }
277 INFO ("amqp plugin: Successfully created exchange \"%s\" "
278 "with type \"%s\".",
279 conf->exchange, conf->exchange_type);
281 return (0);
282 } /* }}} int camqp_create_exchange */
283 #else
284 static int camqp_create_exchange (camqp_config_t *conf) /* {{{ */
285 {
286 amqp_exchange_declare_ok_t *ed_ret;
287 amqp_table_t argument_table;
288 struct amqp_table_entry_t_ argument_table_entries[1];
290 if (conf->exchange_type == NULL)
291 return (0);
293 /* Valid arguments: "auto_delete", "internal" */
294 argument_table.num_entries = STATIC_ARRAY_SIZE (argument_table_entries);
295 argument_table.entries = argument_table_entries;
296 argument_table_entries[0].key = amqp_cstring_bytes ("auto_delete");
297 argument_table_entries[0].value.kind = AMQP_FIELD_KIND_BOOLEAN;
298 argument_table_entries[0].value.value.boolean = 1;
300 ed_ret = amqp_exchange_declare (conf->connection,
301 /* channel = */ CAMQP_CHANNEL,
302 /* exchange = */ amqp_cstring_bytes (conf->exchange),
303 /* type = */ amqp_cstring_bytes (conf->exchange_type),
304 /* passive = */ 0,
305 /* durable = */ 0,
306 #if defined(AMQP_VERSION) && AMQP_VERSION >= 0x00060000
307 /* auto delete = */ 0,
308 /* internal = */ 0,
309 #endif
310 /* arguments = */ argument_table);
311 if ((ed_ret == NULL) && camqp_is_error (conf))
312 {
313 char errbuf[1024];
314 ERROR ("amqp plugin: amqp_exchange_declare failed: %s",
315 camqp_strerror (conf, errbuf, sizeof (errbuf)));
316 camqp_close_connection (conf);
317 return (-1);
318 }
320 INFO ("amqp plugin: Successfully created exchange \"%s\" "
321 "with type \"%s\".",
322 conf->exchange, conf->exchange_type);
324 return (0);
325 } /* }}} int camqp_create_exchange */
326 #endif
328 static int camqp_setup_queue (camqp_config_t *conf) /* {{{ */
329 {
330 amqp_queue_declare_ok_t *qd_ret;
331 amqp_basic_consume_ok_t *cm_ret;
333 qd_ret = amqp_queue_declare (conf->connection,
334 /* channel = */ CAMQP_CHANNEL,
335 /* queue = */ (conf->queue != NULL)
336 ? amqp_cstring_bytes (conf->queue)
337 : AMQP_EMPTY_BYTES,
338 /* passive = */ 0,
339 /* durable = */ conf->queue_durable,
340 /* exclusive = */ 0,
341 /* auto_delete = */ conf->queue_auto_delete,
342 /* arguments = */ AMQP_EMPTY_TABLE);
343 if (qd_ret == NULL)
344 {
345 ERROR ("amqp plugin: amqp_queue_declare failed.");
346 camqp_close_connection (conf);
347 return (-1);
348 }
350 if (conf->queue == NULL)
351 {
352 conf->queue = camqp_bytes_cstring (&qd_ret->queue);
353 if (conf->queue == NULL)
354 {
355 ERROR ("amqp plugin: camqp_bytes_cstring failed.");
356 camqp_close_connection (conf);
357 return (-1);
358 }
360 INFO ("amqp plugin: Created queue \"%s\".", conf->queue);
361 }
362 DEBUG ("amqp plugin: Successfully created queue \"%s\".", conf->queue);
364 /* bind to an exchange */
365 if (conf->exchange != NULL)
366 {
367 amqp_queue_bind_ok_t *qb_ret;
369 assert (conf->queue != NULL);
370 qb_ret = amqp_queue_bind (conf->connection,
371 /* channel = */ CAMQP_CHANNEL,
372 /* queue = */ amqp_cstring_bytes (conf->queue),
373 /* exchange = */ amqp_cstring_bytes (conf->exchange),
374 /* routing_key = */ (conf->routing_key != NULL)
375 ? amqp_cstring_bytes (conf->routing_key)
376 : AMQP_EMPTY_BYTES,
377 /* arguments = */ AMQP_EMPTY_TABLE);
378 if ((qb_ret == NULL) && camqp_is_error (conf))
379 {
380 char errbuf[1024];
381 ERROR ("amqp plugin: amqp_queue_bind failed: %s",
382 camqp_strerror (conf, errbuf, sizeof (errbuf)));
383 camqp_close_connection (conf);
384 return (-1);
385 }
387 DEBUG ("amqp plugin: Successfully bound queue \"%s\" to exchange \"%s\".",
388 conf->queue, conf->exchange);
389 } /* if (conf->exchange != NULL) */
391 cm_ret = amqp_basic_consume (conf->connection,
392 /* channel = */ CAMQP_CHANNEL,
393 /* queue = */ amqp_cstring_bytes (conf->queue),
394 /* consumer_tag = */ AMQP_EMPTY_BYTES,
395 /* no_local = */ 0,
396 /* no_ack = */ 1,
397 /* exclusive = */ 0,
398 /* arguments = */ AMQP_EMPTY_TABLE
399 );
400 if ((cm_ret == NULL) && camqp_is_error (conf))
401 {
402 char errbuf[1024];
403 ERROR ("amqp plugin: amqp_basic_consume failed: %s",
404 camqp_strerror (conf, errbuf, sizeof (errbuf)));
405 camqp_close_connection (conf);
406 return (-1);
407 }
409 return (0);
410 } /* }}} int camqp_setup_queue */
412 static int camqp_connect (camqp_config_t *conf) /* {{{ */
413 {
414 static time_t last_connect_time = 0;
416 amqp_rpc_reply_t reply;
417 int status;
418 #ifdef HAVE_AMQP_TCP_SOCKET
419 amqp_socket_t *socket;
420 #else
421 int sockfd;
422 #endif
424 if (conf->connection != NULL)
425 return (0);
427 time_t now = time(NULL);
428 if (now < (last_connect_time + conf->connection_retry_delay))
429 {
430 DEBUG("amqp plugin: skipping connection retry, "
431 "ConnectionRetryDelay: %d", conf->connection_retry_delay);
432 return(1);
433 }
434 else
435 {
436 DEBUG ("amqp plugin: retrying connection");
437 last_connect_time = now;
438 }
440 conf->connection = amqp_new_connection ();
441 if (conf->connection == NULL)
442 {
443 ERROR ("amqp plugin: amqp_new_connection failed.");
444 return (ENOMEM);
445 }
447 #ifdef HAVE_AMQP_TCP_SOCKET
448 # define CLOSE_SOCKET() /* amqp_destroy_connection() closes the socket for us */
449 /* TODO: add support for SSL using amqp_ssl_socket_new
450 * and related functions */
451 socket = amqp_tcp_socket_new (conf->connection);
452 if (! socket)
453 {
454 ERROR ("amqp plugin: amqp_tcp_socket_new failed.");
455 amqp_destroy_connection (conf->connection);
456 conf->connection = NULL;
457 return (ENOMEM);
458 }
460 status = amqp_socket_open (socket, CONF(conf, host), conf->port);
461 if (status < 0)
462 {
463 char errbuf[1024];
464 status *= -1;
465 ERROR ("amqp plugin: amqp_socket_open failed: %s",
466 sstrerror (status, errbuf, sizeof (errbuf)));
467 amqp_destroy_connection (conf->connection);
468 conf->connection = NULL;
469 return (status);
470 }
471 #else /* HAVE_AMQP_TCP_SOCKET */
472 # define CLOSE_SOCKET() close(sockfd)
473 /* this interface is deprecated as of rabbitmq-c 0.4 */
474 sockfd = amqp_open_socket (CONF(conf, host), conf->port);
475 if (sockfd < 0)
476 {
477 char errbuf[1024];
478 status = (-1) * sockfd;
479 ERROR ("amqp plugin: amqp_open_socket failed: %s",
480 sstrerror (status, errbuf, sizeof (errbuf)));
481 amqp_destroy_connection (conf->connection);
482 conf->connection = NULL;
483 return (status);
484 }
485 amqp_set_sockfd (conf->connection, sockfd);
486 #endif
488 reply = amqp_login (conf->connection, CONF(conf, vhost),
489 /* channel max = */ 0,
490 /* frame max = */ 131072,
491 /* heartbeat = */ 0,
492 /* authentication = */ AMQP_SASL_METHOD_PLAIN,
493 CONF(conf, user), CONF(conf, password));
494 if (reply.reply_type != AMQP_RESPONSE_NORMAL)
495 {
496 ERROR ("amqp plugin: amqp_login (vhost = %s, user = %s) failed.",
497 CONF(conf, vhost), CONF(conf, user));
498 amqp_destroy_connection (conf->connection);
499 CLOSE_SOCKET ();
500 conf->connection = NULL;
501 return (1);
502 }
504 amqp_channel_open (conf->connection, /* channel = */ 1);
505 /* FIXME: Is checking "reply.reply_type" really correct here? How does
506 * it get set? --octo */
507 if (reply.reply_type != AMQP_RESPONSE_NORMAL)
508 {
509 ERROR ("amqp plugin: amqp_channel_open failed.");
510 amqp_connection_close (conf->connection, AMQP_REPLY_SUCCESS);
511 amqp_destroy_connection (conf->connection);
512 CLOSE_SOCKET ();
513 conf->connection = NULL;
514 return (1);
515 }
517 INFO ("amqp plugin: Successfully opened connection to vhost \"%s\" "
518 "on %s:%i.", CONF(conf, vhost), CONF(conf, host), conf->port);
520 status = camqp_create_exchange (conf);
521 if (status != 0)
522 return (status);
524 if (!conf->publish)
525 return (camqp_setup_queue (conf));
526 return (0);
527 } /* }}} int camqp_connect */
529 static int camqp_shutdown (void) /* {{{ */
530 {
531 DEBUG ("amqp plugin: Shutting down %zu subscriber threads.",
532 subscriber_threads_num);
534 subscriber_threads_running = 0;
535 for (size_t i = 0; i < subscriber_threads_num; i++)
536 {
537 /* FIXME: Sending a signal is not very elegant here. Maybe find out how
538 * to use a timeout in the thread and check for the variable in regular
539 * intervals. */
540 pthread_kill (subscriber_threads[i], SIGTERM);
541 pthread_join (subscriber_threads[i], /* retval = */ NULL);
542 }
544 subscriber_threads_num = 0;
545 sfree (subscriber_threads);
547 DEBUG ("amqp plugin: All subscriber threads exited.");
549 return (0);
550 } /* }}} int camqp_shutdown */
552 /*
553 * Subscribing code
554 */
555 static int camqp_read_body (camqp_config_t *conf, /* {{{ */
556 size_t body_size, const char *content_type)
557 {
558 char body[body_size + 1];
559 char *body_ptr;
560 size_t received;
561 amqp_frame_t frame;
562 int status;
564 memset (body, 0, sizeof (body));
565 body_ptr = &body[0];
566 received = 0;
568 while (received < body_size)
569 {
570 status = amqp_simple_wait_frame (conf->connection, &frame);
571 if (status < 0)
572 {
573 char errbuf[1024];
574 status = (-1) * status;
575 ERROR ("amqp plugin: amqp_simple_wait_frame failed: %s",
576 sstrerror (status, errbuf, sizeof (errbuf)));
577 camqp_close_connection (conf);
578 return (status);
579 }
581 if (frame.frame_type != AMQP_FRAME_BODY)
582 {
583 NOTICE ("amqp plugin: Unexpected frame type: %#"PRIx8,
584 frame.frame_type);
585 return (-1);
586 }
588 if ((body_size - received) < frame.payload.body_fragment.len)
589 {
590 WARNING ("amqp plugin: Body is larger than indicated by header.");
591 return (-1);
592 }
594 memcpy (body_ptr, frame.payload.body_fragment.bytes,
595 frame.payload.body_fragment.len);
596 body_ptr += frame.payload.body_fragment.len;
597 received += frame.payload.body_fragment.len;
598 } /* while (received < body_size) */
600 if (strcasecmp ("text/collectd", content_type) == 0)
601 {
602 status = cmd_handle_putval (stderr, body);
603 if (status != 0)
604 ERROR ("amqp plugin: cmd_handle_putval failed with status %i.",
605 status);
606 return (status);
607 }
608 else if (strcasecmp ("application/json", content_type) == 0)
609 {
610 ERROR ("amqp plugin: camqp_read_body: Parsing JSON data has not "
611 "been implemented yet. FIXME!");
612 return (0);
613 }
614 else
615 {
616 ERROR ("amqp plugin: camqp_read_body: Unknown content type \"%s\".",
617 content_type);
618 return (EINVAL);
619 }
621 /* not reached */
622 return (0);
623 } /* }}} int camqp_read_body */
625 static int camqp_read_header (camqp_config_t *conf) /* {{{ */
626 {
627 int status;
628 amqp_frame_t frame;
629 amqp_basic_properties_t *properties;
630 char *content_type;
632 status = amqp_simple_wait_frame (conf->connection, &frame);
633 if (status < 0)
634 {
635 char errbuf[1024];
636 status = (-1) * status;
637 ERROR ("amqp plugin: amqp_simple_wait_frame failed: %s",
638 sstrerror (status, errbuf, sizeof (errbuf)));
639 camqp_close_connection (conf);
640 return (status);
641 }
643 if (frame.frame_type != AMQP_FRAME_HEADER)
644 {
645 NOTICE ("amqp plugin: Unexpected frame type: %#"PRIx8,
646 frame.frame_type);
647 return (-1);
648 }
650 properties = frame.payload.properties.decoded;
651 content_type = camqp_bytes_cstring (&properties->content_type);
652 if (content_type == NULL)
653 {
654 ERROR ("amqp plugin: Unable to determine content type.");
655 return (-1);
656 }
658 status = camqp_read_body (conf,
659 (size_t) frame.payload.properties.body_size,
660 content_type);
662 sfree (content_type);
663 return (status);
664 } /* }}} int camqp_read_header */
666 static void *camqp_subscribe_thread (void *user_data) /* {{{ */
667 {
668 camqp_config_t *conf = user_data;
669 int status;
671 cdtime_t interval = plugin_get_interval ();
673 while (subscriber_threads_running)
674 {
675 amqp_frame_t frame;
677 status = camqp_connect (conf);
678 if (status != 0)
679 {
680 struct timespec ts_interval;
681 ERROR ("amqp plugin: camqp_connect failed. "
682 "Will sleep for %.3f seconds.",
683 CDTIME_T_TO_DOUBLE (interval));
684 CDTIME_T_TO_TIMESPEC (interval, &ts_interval);
685 nanosleep (&ts_interval, /* remaining = */ NULL);
686 continue;
687 }
689 status = amqp_simple_wait_frame (conf->connection, &frame);
690 if (status < 0)
691 {
692 struct timespec ts_interval;
693 ERROR ("amqp plugin: amqp_simple_wait_frame failed. "
694 "Will sleep for %.3f seconds.",
695 CDTIME_T_TO_DOUBLE (interval));
696 camqp_close_connection (conf);
697 CDTIME_T_TO_TIMESPEC (interval, &ts_interval);
698 nanosleep (&ts_interval, /* remaining = */ NULL);
699 continue;
700 }
702 if (frame.frame_type != AMQP_FRAME_METHOD)
703 {
704 DEBUG ("amqp plugin: Unexpected frame type: %#"PRIx8,
705 frame.frame_type);
706 continue;
707 }
709 if (frame.payload.method.id != AMQP_BASIC_DELIVER_METHOD)
710 {
711 DEBUG ("amqp plugin: Unexpected method id: %#"PRIx32,
712 frame.payload.method.id);
713 continue;
714 }
716 camqp_read_header (conf);
718 amqp_maybe_release_buffers (conf->connection);
719 } /* while (subscriber_threads_running) */
721 camqp_config_free (conf);
722 pthread_exit (NULL);
723 return (NULL);
724 } /* }}} void *camqp_subscribe_thread */
726 static int camqp_subscribe_init (camqp_config_t *conf) /* {{{ */
727 {
728 int status;
729 pthread_t *tmp;
731 tmp = realloc (subscriber_threads,
732 sizeof (*subscriber_threads) * (subscriber_threads_num + 1));
733 if (tmp == NULL)
734 {
735 ERROR ("amqp plugin: realloc failed.");
736 sfree (subscriber_threads);
737 return (ENOMEM);
738 }
739 subscriber_threads = tmp;
740 tmp = subscriber_threads + subscriber_threads_num;
741 memset (tmp, 0, sizeof (*tmp));
743 status = plugin_thread_create (tmp, /* attr = */ NULL,
744 camqp_subscribe_thread, conf);
745 if (status != 0)
746 {
747 char errbuf[1024];
748 ERROR ("amqp plugin: pthread_create failed: %s",
749 sstrerror (status, errbuf, sizeof (errbuf)));
750 return (status);
751 }
753 subscriber_threads_num++;
755 return (0);
756 } /* }}} int camqp_subscribe_init */
758 /*
759 * Publishing code
760 */
761 /* XXX: You must hold "conf->lock" when calling this function! */
762 static int camqp_write_locked (camqp_config_t *conf, /* {{{ */
763 const char *buffer, const char *routing_key)
764 {
765 int status;
767 status = camqp_connect (conf);
768 if (status != 0)
769 return (status);
771 amqp_basic_properties_t props = {
772 ._flags = AMQP_BASIC_CONTENT_TYPE_FLAG
773 | AMQP_BASIC_DELIVERY_MODE_FLAG
774 | AMQP_BASIC_APP_ID_FLAG,
775 .delivery_mode = conf->delivery_mode,
776 .app_id = amqp_cstring_bytes("collectd")
777 };
779 if (conf->format == CAMQP_FORMAT_COMMAND)
780 props.content_type = amqp_cstring_bytes("text/collectd");
781 else if (conf->format == CAMQP_FORMAT_JSON)
782 props.content_type = amqp_cstring_bytes("application/json");
783 else if (conf->format == CAMQP_FORMAT_GRAPHITE)
784 props.content_type = amqp_cstring_bytes("text/graphite");
785 else
786 assert (23 == 42);
788 status = amqp_basic_publish(conf->connection,
789 /* channel = */ 1,
790 amqp_cstring_bytes(CONF(conf, exchange)),
791 amqp_cstring_bytes (routing_key),
792 /* mandatory = */ 0,
793 /* immediate = */ 0,
794 &props,
795 amqp_cstring_bytes(buffer));
796 if (status != 0)
797 {
798 ERROR ("amqp plugin: amqp_basic_publish failed with status %i.",
799 status);
800 camqp_close_connection (conf);
801 }
803 return (status);
804 } /* }}} int camqp_write_locked */
806 static int camqp_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
807 user_data_t *user_data)
808 {
809 camqp_config_t *conf = user_data->data;
810 char routing_key[6 * DATA_MAX_NAME_LEN];
811 char buffer[8192];
812 int status;
814 if ((ds == NULL) || (vl == NULL) || (conf == NULL))
815 return (EINVAL);
817 if (conf->routing_key != NULL)
818 {
819 sstrncpy (routing_key, conf->routing_key, sizeof (routing_key));
820 }
821 else
822 {
823 ssnprintf (routing_key, sizeof (routing_key), "collectd/%s/%s/%s/%s/%s",
824 vl->host,
825 vl->plugin, vl->plugin_instance,
826 vl->type, vl->type_instance);
828 /* Switch slashes (the only character forbidden by collectd) and dots
829 * (the separation character used by AMQP). */
830 for (size_t i = 0; routing_key[i] != 0; i++)
831 {
832 if (routing_key[i] == '.')
833 routing_key[i] = '/';
834 else if (routing_key[i] == '/')
835 routing_key[i] = '.';
836 }
837 }
839 if (conf->format == CAMQP_FORMAT_COMMAND)
840 {
841 status = cmd_create_putval (buffer, sizeof (buffer), ds, vl);
842 if (status != 0)
843 {
844 ERROR ("amqp plugin: cmd_create_putval failed with status %i.",
845 status);
846 return (status);
847 }
848 }
849 else if (conf->format == CAMQP_FORMAT_JSON)
850 {
851 size_t bfree = sizeof (buffer);
852 size_t bfill = 0;
854 format_json_initialize (buffer, &bfill, &bfree);
855 format_json_value_list (buffer, &bfill, &bfree, ds, vl, conf->store_rates);
856 format_json_finalize (buffer, &bfill, &bfree);
857 }
858 else if (conf->format == CAMQP_FORMAT_GRAPHITE)
859 {
860 status = format_graphite (buffer, sizeof (buffer), ds, vl,
861 conf->prefix, conf->postfix, conf->escape_char,
862 conf->graphite_flags);
863 if (status != 0)
864 {
865 ERROR ("amqp plugin: format_graphite failed with status %i.",
866 status);
867 return (status);
868 }
869 }
870 else
871 {
872 ERROR ("amqp plugin: Invalid format (%i).", conf->format);
873 return (-1);
874 }
876 pthread_mutex_lock (&conf->lock);
877 status = camqp_write_locked (conf, buffer, routing_key);
878 pthread_mutex_unlock (&conf->lock);
880 return (status);
881 } /* }}} int camqp_write */
883 /*
884 * Config handling
885 */
886 static int camqp_config_set_format (oconfig_item_t *ci, /* {{{ */
887 camqp_config_t *conf)
888 {
889 char *string;
890 int status;
892 string = NULL;
893 status = cf_util_get_string (ci, &string);
894 if (status != 0)
895 return (status);
897 assert (string != NULL);
898 if (strcasecmp ("Command", string) == 0)
899 conf->format = CAMQP_FORMAT_COMMAND;
900 else if (strcasecmp ("JSON", string) == 0)
901 conf->format = CAMQP_FORMAT_JSON;
902 else if (strcasecmp ("Graphite", string) == 0)
903 conf->format = CAMQP_FORMAT_GRAPHITE;
904 else
905 {
906 WARNING ("amqp plugin: Invalid format string: %s",
907 string);
908 }
910 free (string);
912 return (0);
913 } /* }}} int config_set_string */
915 static int camqp_config_connection (oconfig_item_t *ci, /* {{{ */
916 _Bool publish)
917 {
918 camqp_config_t *conf;
919 int status;
921 conf = calloc (1, sizeof (*conf));
922 if (conf == NULL)
923 {
924 ERROR ("amqp plugin: calloc failed.");
925 return (ENOMEM);
926 }
928 /* Initialize "conf" {{{ */
929 conf->publish = publish;
930 conf->name = NULL;
931 conf->format = CAMQP_FORMAT_COMMAND;
932 conf->host = NULL;
933 conf->port = 5672;
934 conf->vhost = NULL;
935 conf->user = NULL;
936 conf->password = NULL;
937 conf->exchange = NULL;
938 conf->routing_key = NULL;
939 conf->connection_retry_delay = 0;
941 /* publish only */
942 conf->delivery_mode = CAMQP_DM_VOLATILE;
943 conf->store_rates = 0;
944 conf->graphite_flags = 0;
945 /* publish & graphite only */
946 conf->prefix = NULL;
947 conf->postfix = NULL;
948 conf->escape_char = '_';
949 /* subscribe only */
950 conf->exchange_type = NULL;
951 conf->queue = NULL;
952 conf->queue_durable = 0;
953 conf->queue_auto_delete = 1;
954 /* general */
955 conf->connection = NULL;
956 pthread_mutex_init (&conf->lock, /* attr = */ NULL);
957 /* }}} */
959 status = cf_util_get_string (ci, &conf->name);
960 if (status != 0)
961 {
962 sfree (conf);
963 return (status);
964 }
966 for (int i = 0; i < ci->children_num; i++)
967 {
968 oconfig_item_t *child = ci->children + i;
970 if (strcasecmp ("Host", child->key) == 0)
971 status = cf_util_get_string (child, &conf->host);
972 else if (strcasecmp ("Port", child->key) == 0)
973 {
974 status = cf_util_get_port_number (child);
975 if (status > 0)
976 {
977 conf->port = status;
978 status = 0;
979 }
980 }
981 else if (strcasecmp ("VHost", child->key) == 0)
982 status = cf_util_get_string (child, &conf->vhost);
983 else if (strcasecmp ("User", child->key) == 0)
984 status = cf_util_get_string (child, &conf->user);
985 else if (strcasecmp ("Password", child->key) == 0)
986 status = cf_util_get_string (child, &conf->password);
987 else if (strcasecmp ("Exchange", child->key) == 0)
988 status = cf_util_get_string (child, &conf->exchange);
989 else if ((strcasecmp ("ExchangeType", child->key) == 0) && !publish)
990 status = cf_util_get_string (child, &conf->exchange_type);
991 else if ((strcasecmp ("Queue", child->key) == 0) && !publish)
992 status = cf_util_get_string (child, &conf->queue);
993 else if ((strcasecmp ("QueueDurable", child->key) == 0) && !publish)
994 status = cf_util_get_boolean (child, &conf->queue_durable);
995 else if ((strcasecmp ("QueueAutoDelete", child->key) == 0) && !publish)
996 status = cf_util_get_boolean (child, &conf->queue_auto_delete);
997 else if (strcasecmp ("RoutingKey", child->key) == 0)
998 status = cf_util_get_string (child, &conf->routing_key);
999 else if ((strcasecmp ("Persistent", child->key) == 0) && publish)
1000 {
1001 _Bool tmp = 0;
1002 status = cf_util_get_boolean (child, &tmp);
1003 if (tmp)
1004 conf->delivery_mode = CAMQP_DM_PERSISTENT;
1005 else
1006 conf->delivery_mode = CAMQP_DM_VOLATILE;
1007 }
1008 else if ((strcasecmp ("StoreRates", child->key) == 0) && publish)
1009 {
1010 status = cf_util_get_boolean (child, &conf->store_rates);
1011 (void) cf_util_get_flag (child, &conf->graphite_flags,
1012 GRAPHITE_STORE_RATES);
1013 }
1014 else if ((strcasecmp ("Format", child->key) == 0) && publish)
1015 status = camqp_config_set_format (child, conf);
1016 else if ((strcasecmp ("GraphiteSeparateInstances", child->key) == 0) && publish)
1017 status = cf_util_get_flag (child, &conf->graphite_flags,
1018 GRAPHITE_SEPARATE_INSTANCES);
1019 else if ((strcasecmp ("GraphiteAlwaysAppendDS", child->key) == 0) && publish)
1020 status = cf_util_get_flag (child, &conf->graphite_flags,
1021 GRAPHITE_ALWAYS_APPEND_DS);
1022 else if ((strcasecmp ("GraphitePrefix", child->key) == 0) && publish)
1023 status = cf_util_get_string (child, &conf->prefix);
1024 else if ((strcasecmp ("GraphitePostfix", child->key) == 0) && publish)
1025 status = cf_util_get_string (child, &conf->postfix);
1026 else if ((strcasecmp ("GraphiteEscapeChar", child->key) == 0) && publish)
1027 {
1028 char *tmp_buff = NULL;
1029 status = cf_util_get_string (child, &tmp_buff);
1030 if (strlen (tmp_buff) > 1)
1031 WARNING ("amqp plugin: The option \"GraphiteEscapeChar\" handles "
1032 "only one character. Others will be ignored.");
1033 conf->escape_char = tmp_buff[0];
1034 sfree (tmp_buff);
1035 }
1036 else if (strcasecmp ("ConnectionRetryDelay", child->key) == 0)
1037 status = cf_util_get_int (child, &conf->connection_retry_delay);
1038 else
1039 WARNING ("amqp plugin: Ignoring unknown "
1040 "configuration option \"%s\".", child->key);
1042 if (status != 0)
1043 break;
1044 } /* for (i = 0; i < ci->children_num; i++) */
1046 if ((status == 0) && (conf->exchange == NULL))
1047 {
1048 if (conf->exchange_type != NULL)
1049 WARNING ("amqp plugin: The option \"ExchangeType\" was given "
1050 "without the \"Exchange\" option. It will be ignored.");
1052 if (!publish && (conf->routing_key != NULL))
1053 WARNING ("amqp plugin: The option \"RoutingKey\" was given "
1054 "without the \"Exchange\" option. It will be ignored.");
1056 }
1058 if (status != 0)
1059 {
1060 camqp_config_free (conf);
1061 return (status);
1062 }
1064 if (conf->exchange != NULL)
1065 {
1066 DEBUG ("amqp plugin: camqp_config_connection: exchange = %s;",
1067 conf->exchange);
1068 }
1070 if (publish)
1071 {
1072 char cbname[128];
1073 ssnprintf (cbname, sizeof (cbname), "amqp/%s", conf->name);
1075 status = plugin_register_write (cbname, camqp_write,
1076 &(user_data_t) {
1077 .data = conf,
1078 .free_func = camqp_config_free,
1079 });
1080 if (status != 0)
1081 {
1082 camqp_config_free (conf);
1083 return (status);
1084 }
1085 }
1086 else
1087 {
1088 status = camqp_subscribe_init (conf);
1089 if (status != 0)
1090 {
1091 camqp_config_free (conf);
1092 return (status);
1093 }
1094 }
1096 return (0);
1097 } /* }}} int camqp_config_connection */
1099 static int camqp_config (oconfig_item_t *ci) /* {{{ */
1100 {
1101 for (int i = 0; i < ci->children_num; i++)
1102 {
1103 oconfig_item_t *child = ci->children + i;
1105 if (strcasecmp ("Publish", child->key) == 0)
1106 camqp_config_connection (child, /* publish = */ 1);
1107 else if (strcasecmp ("Subscribe", child->key) == 0)
1108 camqp_config_connection (child, /* publish = */ 0);
1109 else
1110 WARNING ("amqp plugin: Ignoring unknown config option \"%s\".",
1111 child->key);
1112 } /* for (ci->children_num) */
1114 return (0);
1115 } /* }}} int camqp_config */
1117 void module_register (void)
1118 {
1119 plugin_register_complex_config ("amqp", camqp_config);
1120 plugin_register_shutdown ("amqp", camqp_shutdown);
1121 } /* void module_register */
1123 /* vim: set sw=4 sts=4 et fdm=marker : */