summaryrefslogtreecommitdiffstats
path: root/docs/gw/mqtt.rst
blob: d30705effc4ccd01388647f1e5771f44cc8e2419 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.. _mqtt:

MQTT
========

You can export statistics to an ``MQTT`` server. The
connection should be defined in the Glances configuration file as
following:

.. code-block:: ini

    [mqtt]
    host=localhost
    # Overwrite device name in the topic (see detail in PR#2701)
    #devicename=localhost
    port=883
    tls=true
    user=glances
    password=glances
    topic=glances
    topic_structure=per-metric
    callback_api_version=2

and run Glances with:

.. code-block:: console

    $ glances --export mqtt

The topic_structure field aims at configuring the way stats are exported to MQTT (see #1798):
- per-metric: one event per metric (default behavior)
- per-plugin: one event per plugin