Difference between revisions of "Plugin:MQTT"

From collectd Wiki
Jump to: navigation, search
(Added Callback|init)
Line 10: Line 10:
 
}}
 
}}
 
The '''MQTT plugin''' transmits or receives values collected by ''collectd'' via the [http://mqtt.org/ MQTT] protocol.
 
The '''MQTT plugin''' transmits or receives values collected by ''collectd'' via the [http://mqtt.org/ MQTT] protocol.
Data is sent to or received from a "message broker" – a daemon relaying messages.
+
Data is sent to or received from a MQTT Server, also known as a message broker.
The values are encoded in either the [[plain text protocol]] or [[JSON]],
+
The values are encoded and parsed in the [[plain text protocol]].
though only the plain-text protocol can be parsed by the plugin at the moment.
 
Messages can be sent in either ''persistent'' (guaranteed delivery) or ''transient'' (higher efficiency but values may be lost) delivery mode.
 
  
 
== Synopsis ==
 
== Synopsis ==
Line 44: Line 42:
 
  </Plugin>
 
  </Plugin>
  
this registers a writer by the name
+
 
  collectd/
+
 
  
 
== Dependencies ==
 
== Dependencies ==

Revision as of 21:45, 7 September 2015

MQTT plugin
Type: read, write
Callbacks: config, init, write
Status: supported
First version: 5.6
Copyright: 2014-2015 Florian octo Forster
2014 Marc Falzon
License: MIT license
Manpage: collectd.conf(5)
List of Plugins

The MQTT plugin transmits or receives values collected by collectd via the MQTT protocol. Data is sent to or received from a MQTT Server, also known as a message broker. The values are encoded and parsed in the plain text protocol.

Synopsis

<Plugin "mqtt">
  # Send values to an MQTT server
  <Publish "some_name">
    Host "localhost"
#   Port "1883"
#   User "mqttuser"
#   Password "password"
#   ClientId "collectd-hostname"
#   QoS 0
#   Prefix "collectd"
#   Retain true
#   StoreRates false
  </Publish>
  
  # Receive values from an MQTT server
  <Subscribe "some_name">
    Host "localhost"
#   Port "1883"
#   User "mqttuser"
#   Password "password"
#   ClientId "collectd-hostname"
#   QoS 0
#   CleanSession false
#   Topic "subscribetopic"
  </Subscribe>
</Plugin>



Dependencies

See also