Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grafana/mqtt-datasource
MQTT Datasource for Grafana allows streaming data from any MQTT broker running either locally or remotely.
https://github.com/grafana/mqtt-datasource
grafana-datasource grafana-plugin mqtt mqtt-client mqtt-datasource mqtt-protocol
Last synced: 3 days ago
JSON representation
MQTT Datasource for Grafana allows streaming data from any MQTT broker running either locally or remotely.
- Host: GitHub
- URL: https://github.com/grafana/mqtt-datasource
- Owner: grafana
- License: apache-2.0
- Created: 2021-04-07T21:00:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T20:48:05.000Z (4 months ago)
- Last Synced: 2024-12-16T00:02:33.011Z (10 days ago)
- Topics: grafana-datasource, grafana-plugin, mqtt, mqtt-client, mqtt-datasource, mqtt-protocol
- Language: Go
- Homepage:
- Size: 3.73 MB
- Stars: 175
- Watchers: 153
- Forks: 51
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://drone.grafana.net/grafana/mqtt-datasource)
# MQTT data source for Grafana
The MQTT data source plugin allows you to visualize streaming MQTT data from within Grafana.
## Requirements
The MQTT data source has the following requirements:
- Grafana user with a server or organization administration role; refer to [Permissions](https://grafana.com/docs/grafana/latest/permissions/).
- Access to a MQTT broker.
## Configure the data source
[Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/) by filling in the following fields:
#### Basic fields
| Field | Description |
| ----- | -------------------------------------------------- |
| Name | A name for this particular MQTT data source |
| URI | The scheme, host, and port of the MQTT Broker. Supported schemes: TCP (tcp://), TLS (tls://), and WebSocket (ws://) |
#### Authentication fields
| Field | Description |
| -------- | ----------------------------------------------------------------- |
| Username | (Optional) The username to use when connecting to the MQTT broker |
| Password | (Optional) The password to use when connecting to the MQTT broker |
## Query the data source
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)
for more information about valid topic names and filters.
## Known limitations
- The plugin currently does not support all of the MQTT CONNECT packet options.
- This plugin automatically supports topics publishing numbers, strings, booleans, and JSON formatted values. Nested object values can be extracted using the `Extract Fields` transformation.
- This plugin automatically attaches timestamps to the messages when they are received. Timestamps included in the message body can be parsed using the `Convert field type` transformation.
## Install the plugin
### Installation Pre-requisites
Refer to: [Building a Streaming Datasource Backend Plugin](https://grafana.com/tutorials/build-a-streaming-data-source-plugin/)
Details: [Ubuntu](https://github.com/grafana/mqtt-datasource/issues/15#issuecomment-894477802) [Windows](https://github.com/grafana/mqtt-datasource/issues/15#issuecomment-894534196)
### Meet compatibility requirements
This plugin currently supports MQTT v3.1.x.
__Note: Since this plugin uses the Grafana Live Streaming API, make sure to use Grafana v8.0+__
### Installation Steps
1. Clone the plugin to your Grafana plugins directory.
2. Build the plugin by running `yarn install` and then `yarn build`.
NOTE: The `yarn build` command above might fail on a non-unix-like system, like Windows, where you can try replacing the `rm -rf` command with `rimraf` in the `./package.json` file to make it work.
3. Run `mage reloadPlugin` or restart Grafana for the plugin to load.
### Verify that the plugin is installed
1. In Grafana from the left-hand menu, navigate to **Configuration** > **Data sources**.
2. From the top-right corner, click the **Add data source** button.
3. Search for `MQTT` in the search field, and hover over the MQTT search result.
4. Click the **Select** button for MQTT.