|
4 | 4 |
|
5 | 5 | The MQTT data source plugin allows you to visualize streaming MQTT data from within Grafana. |
6 | 6 |
|
7 | | -This datasource is under active development, all feedback and help is encouraged! |
8 | | - |
9 | 7 | ## Requirements |
10 | 8 |
|
11 | 9 | The MQTT data source has the following requirements: |
12 | 10 |
|
13 | 11 | - Grafana user with a server or organization administration role; refer to [Permissions](https://grafana.com/docs/grafana/latest/permissions/). |
14 | 12 | - Access to a MQTT broker. |
15 | 13 |
|
| 14 | +## Configure the data source |
| 15 | + |
| 16 | +[Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) by filling in the following fields: |
| 17 | + |
| 18 | +#### Basic fields |
| 19 | + |
| 20 | +| Field | Description | |
| 21 | +| ----- | -------------------------------------------------- | |
| 22 | +| Name | A name for this particular MQTT data source | |
| 23 | +| URI | The scehme, host, and port of the MQTT Broker. Supported schemes: TCP (tcp://), TLS (tls://), and WebSocket (ws://) | |
| 24 | + |
| 25 | +#### Authentication fields |
| 26 | + |
| 27 | +| Field | Description | |
| 28 | +| -------- | ----------------------------------------------------------------- | |
| 29 | +| Username | (Optional) The username to use when connecting to the MQTT broker | |
| 30 | +| Password | (Optional) The password to use when connecting to the MQTT broker | |
| 31 | + |
| 32 | +## Query the data source |
| 33 | + |
| 34 | +The query editor allows you to specify which MQTT topics the panel will subscribe to. Refer to the [MQTT v3.1.1 specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106) |
| 35 | +for more information about valid topic names and filters. |
| 36 | + |
| 37 | + |
| 38 | + |
16 | 39 | ## Known limitations |
17 | 40 |
|
18 | 41 | - The plugin currently does not support all of the MQTT CONNECT packet options. |
@@ -44,29 +67,3 @@ NOTE: The `yarn build` command above might fail on a non-unix-like system, like |
44 | 67 | 2. From the top-right corner, click the **Add data source** button. |
45 | 68 | 3. Search for `MQTT` in the search field, and hover over the MQTT search result. |
46 | 69 | 4. Click the **Select** button for MQTT. |
47 | | - |
48 | | -## Configure the data source |
49 | | - |
50 | | -[Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) by filling in the following fields: |
51 | | - |
52 | | -#### Basic fields |
53 | | - |
54 | | -| Field | Description | |
55 | | -| ----- | -------------------------------------------------- | |
56 | | -| Name | A name for this particular AppDynamics data source | |
57 | | -| Host | The hostname or IP of the MQTT Broker | |
58 | | -| Port | The port used by the MQTT Broker (default 1883) | |
59 | | - |
60 | | -#### Authentication fields |
61 | | - |
62 | | -| Field | Description | |
63 | | -| -------- | ----------------------------------------------------------------- | |
64 | | -| Username | (Optional) The username to use when connecting to the MQTT broker | |
65 | | -| Password | (Optional) The password to use when connecting to the MQTT broker | |
66 | | - |
67 | | -## Query the data source |
68 | | - |
69 | | -The query editor allows you to specify which MQTT topics the panel will subscribe to. Refer to the [MQTT v3.1.1 specification](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106) |
70 | | -for more information about valid topic names and filters. |
71 | | - |
72 | | - |
0 commit comments