2 * collectd - src/mqtt.c
3 * Copyright (C) 2014 Marc Falzon
4 * Copyright (C) 2014,2015 Florian octo 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 * Marc Falzon <marc at baha dot mu>
26 * Florian octo Forster <octo at collectd.org>
27 * Jan-Piet Mens <jpmens at gmail.com>
30 // Reference: http://mosquitto.org/api/files/mosquitto-h.html
36 #include "utils_complain.h"
38 #include <mosquitto.h>
40 #define MQTT_MAX_TOPIC_SIZE 1024
41 #define MQTT_MAX_MESSAGE_SIZE MQTT_MAX_TOPIC_SIZE + 1024
42 #define MQTT_DEFAULT_HOST "localhost"
43 #define MQTT_DEFAULT_PORT 1883
44 #define MQTT_DEFAULT_TOPIC_PREFIX "collectd"
45 #define MQTT_DEFAULT_TOPIC "collectd/#"
46 #ifndef MQTT_KEEPALIVE
47 #define MQTT_KEEPALIVE 60
49 #ifndef SSL_VERIFY_PEER
50 #define SSL_VERIFY_PEER 1
56 struct mqtt_client_conf {
60 struct mosquitto *mosq;
69 char *cacertificatefile;
70 char *certificatefile;
71 char *certificatekeyfile;
86 c_complain_t complaint_cantpublish;
89 typedef struct mqtt_client_conf mqtt_client_conf_t;
91 static mqtt_client_conf_t **subscribers = NULL;
92 static size_t subscribers_num = 0;
97 #if LIBMOSQUITTO_MAJOR == 0
98 static char const *mosquitto_strerror(int code) {
100 case MOSQ_ERR_SUCCESS:
101 return "MOSQ_ERR_SUCCESS";
103 return "MOSQ_ERR_NOMEM";
104 case MOSQ_ERR_PROTOCOL:
105 return "MOSQ_ERR_PROTOCOL";
107 return "MOSQ_ERR_INVAL";
108 case MOSQ_ERR_NO_CONN:
109 return "MOSQ_ERR_NO_CONN";
110 case MOSQ_ERR_CONN_REFUSED:
111 return "MOSQ_ERR_CONN_REFUSED";
112 case MOSQ_ERR_NOT_FOUND:
113 return "MOSQ_ERR_NOT_FOUND";
114 case MOSQ_ERR_CONN_LOST:
115 return "MOSQ_ERR_CONN_LOST";
117 return "MOSQ_ERR_SSL";
118 case MOSQ_ERR_PAYLOAD_SIZE:
119 return "MOSQ_ERR_PAYLOAD_SIZE";
120 case MOSQ_ERR_NOT_SUPPORTED:
121 return "MOSQ_ERR_NOT_SUPPORTED";
123 return "MOSQ_ERR_AUTH";
124 case MOSQ_ERR_ACL_DENIED:
125 return "MOSQ_ERR_ACL_DENIED";
126 case MOSQ_ERR_UNKNOWN:
127 return "MOSQ_ERR_UNKNOWN";
129 return "MOSQ_ERR_ERRNO";
132 return "UNKNOWN ERROR CODE";
135 /* provided by libmosquitto */
138 static void mqtt_free(mqtt_client_conf_t *conf) {
143 (void)mosquitto_disconnect(conf->mosq);
145 (void)mosquitto_destroy(conf->mosq);
148 sfree(conf->username);
149 sfree(conf->password);
150 sfree(conf->client_id);
151 sfree(conf->topic_prefix);
155 static char *strip_prefix(char *topic) {
158 for (size_t i = 0; topic[i] != 0; i++)
166 char *tmp = strchr(topic, '/');
176 static void on_message(
177 #if LIBMOSQUITTO_MAJOR == 0
179 __attribute__((unused)) struct mosquitto *m,
181 __attribute__((unused)) void *arg, const struct mosquitto_message *msg) {
182 value_list_t vl = VALUE_LIST_INIT;
183 data_set_t const *ds;
189 if (msg->payloadlen <= 0) {
190 DEBUG("mqtt plugin: message has empty payload");
194 topic = strdup(msg->topic);
195 name = strip_prefix(topic);
197 status = parse_identifier_vl(name, &vl);
199 ERROR("mqtt plugin: Unable to parse topic \"%s\".", topic);
205 ds = plugin_get_ds(vl.type);
207 ERROR("mqtt plugin: Unknown type: \"%s\".", vl.type);
211 vl.values = calloc(ds->ds_num, sizeof(*vl.values));
212 if (vl.values == NULL) {
213 ERROR("mqtt plugin: calloc failed.");
216 vl.values_len = ds->ds_num;
218 payload = malloc(msg->payloadlen + 1);
219 if (payload == NULL) {
220 ERROR("mqtt plugin: malloc for payload buffer failed.");
224 memmove(payload, msg->payload, msg->payloadlen);
225 payload[msg->payloadlen] = 0;
227 DEBUG("mqtt plugin: payload = \"%s\"", payload);
228 status = parse_values(payload, &vl, ds);
230 ERROR("mqtt plugin: Unable to parse payload \"%s\".", payload);
237 plugin_dispatch_values(&vl);
239 } /* void on_message */
241 /* must hold conf->lock when calling. */
242 static int mqtt_reconnect(mqtt_client_conf_t *conf) {
248 status = mosquitto_reconnect(conf->mosq);
249 if (status != MOSQ_ERR_SUCCESS) {
251 ERROR("mqtt_connect_broker: mosquitto_connect failed: %s",
252 (status == MOSQ_ERR_ERRNO) ? sstrerror(errno, errbuf, sizeof(errbuf))
253 : mosquitto_strerror(status));
259 c_release(LOG_INFO, &conf->complaint_cantpublish,
260 "mqtt plugin: successfully reconnected to broker \"%s:%d\"",
261 conf->host, conf->port);
264 } /* mqtt_reconnect */
266 /* must hold conf->lock when calling. */
267 static int mqtt_connect(mqtt_client_conf_t *conf) {
268 char const *client_id;
271 if (conf->mosq != NULL)
272 return mqtt_reconnect(conf);
275 client_id = conf->client_id;
277 client_id = hostname_g;
279 #if LIBMOSQUITTO_MAJOR == 0
280 conf->mosq = mosquitto_new(client_id, /* user data = */ conf);
283 mosquitto_new(client_id, conf->clean_session, /* user data = */ conf);
285 if (conf->mosq == NULL) {
286 ERROR("mqtt plugin: mosquitto_new failed");
290 #if LIBMOSQUITTO_MAJOR != 0
291 if (conf->cacertificatefile) {
292 status = mosquitto_tls_set(conf->mosq, conf->cacertificatefile, NULL,
293 conf->certificatefile, conf->certificatekeyfile,
294 /* pw_callback */ NULL);
295 if (status != MOSQ_ERR_SUCCESS) {
296 ERROR("mqtt plugin: cannot mosquitto_tls_set: %s",
297 mosquitto_strerror(status));
298 mosquitto_destroy(conf->mosq);
303 status = mosquitto_tls_opts_set(conf->mosq, SSL_VERIFY_PEER,
304 conf->tlsprotocol, conf->ciphersuite);
305 if (status != MOSQ_ERR_SUCCESS) {
306 ERROR("mqtt plugin: cannot mosquitto_tls_opts_set: %s",
307 mosquitto_strerror(status));
308 mosquitto_destroy(conf->mosq);
313 status = mosquitto_tls_insecure_set(conf->mosq, false);
314 if (status != MOSQ_ERR_SUCCESS) {
315 ERROR("mqtt plugin: cannot mosquitto_tls_insecure_set: %s",
316 mosquitto_strerror(status));
317 mosquitto_destroy(conf->mosq);
324 if (conf->username && conf->password) {
326 mosquitto_username_pw_set(conf->mosq, conf->username, conf->password);
327 if (status != MOSQ_ERR_SUCCESS) {
329 ERROR("mqtt plugin: mosquitto_username_pw_set failed: %s",
330 (status == MOSQ_ERR_ERRNO)
331 ? sstrerror(errno, errbuf, sizeof(errbuf))
332 : mosquitto_strerror(status));
334 mosquitto_destroy(conf->mosq);
340 #if LIBMOSQUITTO_MAJOR == 0
341 status = mosquitto_connect(conf->mosq, conf->host, conf->port,
342 /* keepalive = */ MQTT_KEEPALIVE,
343 /* clean session = */ conf->clean_session);
346 mosquitto_connect(conf->mosq, conf->host, conf->port, MQTT_KEEPALIVE);
348 if (status != MOSQ_ERR_SUCCESS) {
350 ERROR("mqtt plugin: mosquitto_connect failed: %s",
351 (status == MOSQ_ERR_ERRNO) ? sstrerror(errno, errbuf, sizeof(errbuf))
352 : mosquitto_strerror(status));
354 mosquitto_destroy(conf->mosq);
359 if (!conf->publish) {
360 mosquitto_message_callback_set(conf->mosq, on_message);
363 mosquitto_subscribe(conf->mosq,
364 /* message_id = */ NULL, conf->topic, conf->qos);
365 if (status != MOSQ_ERR_SUCCESS) {
366 ERROR("mqtt plugin: Subscribing to \"%s\" failed: %s", conf->topic,
367 mosquitto_strerror(status));
369 mosquitto_disconnect(conf->mosq);
370 mosquitto_destroy(conf->mosq);
380 static void *subscribers_thread(void *arg) {
381 mqtt_client_conf_t *conf = arg;
387 status = mqtt_connect(conf);
393 /* The documentation says "0" would map to the default (1000ms), but
394 * that does not work on some versions. */
395 #if LIBMOSQUITTO_MAJOR == 0
396 status = mosquitto_loop(conf->mosq, /* timeout = */ 1000 /* ms */);
398 status = mosquitto_loop(conf->mosq,
399 /* timeout[ms] = */ 1000,
400 /* max_packets = */ 100);
402 if (status == MOSQ_ERR_CONN_LOST) {
405 } else if (status != MOSQ_ERR_SUCCESS) {
406 ERROR("mqtt plugin: mosquitto_loop failed: %s",
407 mosquitto_strerror(status));
408 mosquitto_destroy(conf->mosq);
414 DEBUG("mqtt plugin: mosquitto_loop succeeded.");
415 } /* while (conf->loop) */
418 } /* void *subscribers_thread */
420 static int publish(mqtt_client_conf_t *conf, char const *topic,
421 void const *payload, size_t payload_len) {
424 pthread_mutex_lock(&conf->lock);
426 status = mqtt_connect(conf);
428 pthread_mutex_unlock(&conf->lock);
429 ERROR("mqtt plugin: unable to reconnect to broker");
433 status = mosquitto_publish(conf->mosq, /* message_id */ NULL, topic,
434 #if LIBMOSQUITTO_MAJOR == 0
435 (uint32_t)payload_len, payload,
437 (int)payload_len, payload,
439 conf->qos, conf->retain);
440 if (status != MOSQ_ERR_SUCCESS) {
442 c_complain(LOG_ERR, &conf->complaint_cantpublish,
443 "mqtt plugin: mosquitto_publish failed: %s",
444 (status == MOSQ_ERR_ERRNO)
445 ? sstrerror(errno, errbuf, sizeof(errbuf))
446 : mosquitto_strerror(status));
447 /* Mark our connection "down" regardless of the error as a safety
448 * measure; we will try to reconnect the next time we have to publish a
452 pthread_mutex_unlock(&conf->lock);
456 pthread_mutex_unlock(&conf->lock);
460 static int format_topic(char *buf, size_t buf_len, data_set_t const *ds,
461 value_list_t const *vl, mqtt_client_conf_t *conf) {
462 char name[MQTT_MAX_TOPIC_SIZE];
465 if ((conf->topic_prefix == NULL) || (conf->topic_prefix[0] == 0))
466 return (FORMAT_VL(buf, buf_len, vl));
468 status = FORMAT_VL(name, sizeof(name), vl);
472 status = ssnprintf(buf, buf_len, "%s/%s", conf->topic_prefix, name);
473 if ((status < 0) || (((size_t)status) >= buf_len))
477 } /* int format_topic */
479 static int mqtt_write(const data_set_t *ds, const value_list_t *vl,
480 user_data_t *user_data) {
481 mqtt_client_conf_t *conf;
482 char topic[MQTT_MAX_TOPIC_SIZE];
483 char payload[MQTT_MAX_MESSAGE_SIZE];
486 if ((user_data == NULL) || (user_data->data == NULL))
488 conf = user_data->data;
490 status = format_topic(topic, sizeof(topic), ds, vl, conf);
492 ERROR("mqtt plugin: format_topic failed with status %d.", status);
496 status = format_values(payload, sizeof(payload), ds, vl, conf->store_rates);
498 ERROR("mqtt plugin: format_values failed with status %d.", status);
502 status = publish(conf, topic, payload, strlen(payload) + 1);
504 ERROR("mqtt plugin: publish failed: %s", mosquitto_strerror(status));
515 * ClientId "collectd"
522 * CACert "ca.pem" Enables TLS if set
523 * CertificateFile "client-cert.pem" optional
524 * CertificateKeyFile "client-key.pem" optional
525 * TLSProtocol "tlsv1.2" optional
528 static int mqtt_config_publisher(oconfig_item_t *ci) {
529 mqtt_client_conf_t *conf;
533 conf = calloc(1, sizeof(*conf));
535 ERROR("mqtt plugin: calloc failed.");
541 status = cf_util_get_string(ci, &conf->name);
547 conf->host = strdup(MQTT_DEFAULT_HOST);
548 conf->port = MQTT_DEFAULT_PORT;
549 conf->client_id = NULL;
551 conf->topic_prefix = strdup(MQTT_DEFAULT_TOPIC_PREFIX);
552 conf->store_rates = 1;
554 status = pthread_mutex_init(&conf->lock, NULL);
560 C_COMPLAIN_INIT(&conf->complaint_cantpublish);
562 for (int i = 0; i < ci->children_num; i++) {
563 oconfig_item_t *child = ci->children + i;
564 if (strcasecmp("Host", child->key) == 0)
565 cf_util_get_string(child, &conf->host);
566 else if (strcasecmp("Port", child->key) == 0) {
567 int tmp = cf_util_get_port_number(child);
569 ERROR("mqtt plugin: Invalid port number.");
572 } else if (strcasecmp("ClientId", child->key) == 0)
573 cf_util_get_string(child, &conf->client_id);
574 else if (strcasecmp("User", child->key) == 0)
575 cf_util_get_string(child, &conf->username);
576 else if (strcasecmp("Password", child->key) == 0)
577 cf_util_get_string(child, &conf->password);
578 else if (strcasecmp("QoS", child->key) == 0) {
580 status = cf_util_get_int(child, &tmp);
581 if ((status != 0) || (tmp < 0) || (tmp > 2))
582 ERROR("mqtt plugin: Not a valid QoS setting.");
585 } else if (strcasecmp("Prefix", child->key) == 0)
586 cf_util_get_string(child, &conf->topic_prefix);
587 else if (strcasecmp("StoreRates", child->key) == 0)
588 cf_util_get_boolean(child, &conf->store_rates);
589 else if (strcasecmp("Retain", child->key) == 0)
590 cf_util_get_boolean(child, &conf->retain);
591 else if (strcasecmp("CACert", child->key) == 0)
592 cf_util_get_string(child, &conf->cacertificatefile);
593 else if (strcasecmp("CertificateFile", child->key) == 0)
594 cf_util_get_string(child, &conf->certificatefile);
595 else if (strcasecmp("CertificateKeyFile", child->key) == 0)
596 cf_util_get_string(child, &conf->certificatekeyfile);
597 else if (strcasecmp("TLSProtocol", child->key) == 0)
598 cf_util_get_string(child, &conf->tlsprotocol);
599 else if (strcasecmp("CipherSuite", child->key) == 0)
600 cf_util_get_string(child, &conf->ciphersuite);
602 ERROR("mqtt plugin: Unknown config option: %s", child->key);
605 ssnprintf(cb_name, sizeof(cb_name), "mqtt/%s", conf->name);
606 plugin_register_write(cb_name, mqtt_write, &(user_data_t){
610 } /* mqtt_config_publisher */
616 * ClientId "collectd"
622 static int mqtt_config_subscriber(oconfig_item_t *ci) {
623 mqtt_client_conf_t **tmp;
624 mqtt_client_conf_t *conf;
627 conf = calloc(1, sizeof(*conf));
629 ERROR("mqtt plugin: calloc failed.");
635 status = cf_util_get_string(ci, &conf->name);
641 conf->host = strdup(MQTT_DEFAULT_HOST);
642 conf->port = MQTT_DEFAULT_PORT;
643 conf->client_id = NULL;
645 conf->topic = strdup(MQTT_DEFAULT_TOPIC);
646 conf->clean_session = 1;
648 status = pthread_mutex_init(&conf->lock, NULL);
654 C_COMPLAIN_INIT(&conf->complaint_cantpublish);
656 for (int i = 0; i < ci->children_num; i++) {
657 oconfig_item_t *child = ci->children + i;
658 if (strcasecmp("Host", child->key) == 0)
659 cf_util_get_string(child, &conf->host);
660 else if (strcasecmp("Port", child->key) == 0) {
661 status = cf_util_get_port_number(child);
663 ERROR("mqtt plugin: Invalid port number.");
666 } else if (strcasecmp("ClientId", child->key) == 0)
667 cf_util_get_string(child, &conf->client_id);
668 else if (strcasecmp("User", child->key) == 0)
669 cf_util_get_string(child, &conf->username);
670 else if (strcasecmp("Password", child->key) == 0)
671 cf_util_get_string(child, &conf->password);
672 else if (strcasecmp("QoS", child->key) == 0) {
674 status = cf_util_get_int(child, &qos);
675 if ((status != 0) || (qos < 0) || (qos > 2))
676 ERROR("mqtt plugin: Not a valid QoS setting.");
679 } else if (strcasecmp("Topic", child->key) == 0)
680 cf_util_get_string(child, &conf->topic);
681 else if (strcasecmp("CleanSession", child->key) == 0)
682 cf_util_get_boolean(child, &conf->clean_session);
684 ERROR("mqtt plugin: Unknown config option: %s", child->key);
687 tmp = realloc(subscribers, sizeof(*subscribers) * (subscribers_num + 1));
689 ERROR("mqtt plugin: realloc failed.");
694 subscribers[subscribers_num] = conf;
698 } /* mqtt_config_subscriber */
710 static int mqtt_config(oconfig_item_t *ci) {
711 for (int i = 0; i < ci->children_num; i++) {
712 oconfig_item_t *child = ci->children + i;
714 if (strcasecmp("Publish", child->key) == 0)
715 mqtt_config_publisher(child);
716 else if (strcasecmp("Subscribe", child->key) == 0)
717 mqtt_config_subscriber(child);
719 ERROR("mqtt plugin: Unknown config option: %s", child->key);
723 } /* int mqtt_config */
725 static int mqtt_init(void) {
726 mosquitto_lib_init();
728 for (size_t i = 0; i < subscribers_num; i++) {
731 if (subscribers[i]->loop)
734 status = plugin_thread_create(&subscribers[i]->thread,
736 /* func = */ subscribers_thread,
737 /* args = */ subscribers[i],
738 /* name = */ "mqtt");
741 ERROR("mqtt plugin: pthread_create failed: %s",
742 sstrerror(errno, errbuf, sizeof(errbuf)));
750 void module_register(void) {
751 plugin_register_complex_config("mqtt", mqtt_config);
752 plugin_register_init("mqtt", mqtt_init);
753 } /* void module_register */