Building and installing the MQTT plugin

[mmohamed15]

i have a small problem in building the Grafana mqtt plugin
i tried to build it in windows but i failed specially when i run the yarn build command i always get that -rm and mage in not recognized
then i switched to try to build it in ubuntu linux but i also faced the problem of mage is not recognized even though i had installed go and tried to install mage
can you help me in setting the necessary setup to be able to build the mqtt plugin correctly i hope that it will be bundled with grafana 8.1 release and this didn't happen
maybe how i can install mage orn something like that

[atifali]

make sure to satisfy the pre-requisites from here: https://grafana.com/tutorials/build-a-streaming-data-source-plugin/
for mage follow the instructions here (assuming the system already has golang installed): https://magefile.org/

[whbruce]

Here's what I had to do on Ubuntu 20. It's non-trivial...

Installing

Ubuntu 20 supports Grafana v7.0, but we need Grafana 8.0 as it supports streaming data sources (e.g. MQTT).

$ sudo apt-get install -y gnupg2 curl
$ curl https://packages.grafana.com/gpg.key | sudo apt-key add -
$ sudo add-apt-repository "deb https://packages.grafana.com/oss/deb stable main"
$ sudo apt-get update
$ sudo apt-get -y install grafana

Dashboard will be served on port 3000. Default username and password are "admin", you'll be prompted to change password.

Add MQTT Data Source

Install prerequisites

Yarn

$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt update
$ sudo apt -y install yarn

Node v14

$ curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -
$ sudo apt update
$ sudo apt -y install nodejs
$ node --version
v14.17.4

Go

$ sudo apt -y install golang
$ mkdir -p ~/go
$ go version
go version go1.13.8 linux/amd64

Add the following to your environment (e.g. .bashrc)

$ export GOPATH=~/go
$ export PATH=$PATH:$GOPATH/bin

Mage

$ go get -u -d github.com/magefile/mage
$ cd $GOPATH/src/github.com/magefile/mage
$ go run bootstrap.go
$ mage -version
Mage Build Tool v1.11.0-2-g4cf3cfc
Build Date: 2021-08-03T11:57:28-07:00
Commit: 4cf3cfc
built with: go1.13.8

Build data source

$ mkdir grafana-plugins
$ cd grafana-plugins
$ https://github.com/grafana/mqtt-datasource.git
$ cd mqtt-datasource
$ yarn build
$ yarn install

Add data source to grafana

Edit vi /etc/grafana/grafana.ini.

Add data source folder

Look for # Directory where grafana will automatically scan and look for plugins and update as follows

# Directory where grafana will automatically scan and look for plugins
;plugins = /var/lib/grafana/plugins
plugins = /path/to/grafana-plugins

Allow unsigned sources

Look for [plugins] section and update as follows

[plugins]
;enable_alpha = false
;app_tls_skip_verify_insecure = false
# Enter a comma-separated list of plugin identifiers to identify plugins that are allowed to be loaded even if they lack a valid signature.
allow_loading_unsigned_plugins = grafana-mqtt-datasource

Restart service

sudo systemctl start grafana-server

[mmohamed15]

can you help me for the same steps for windows

[whbruce]

Sorry, can't help, I'm only working on Linux. And I'm only a few days ahead of you in ramping on this project.

[mmohamed15]

Ok i found a small hint you need to change the the command rm to rimraf in the package.json file i will try to make a guide to for building this plugin for windows

[mmohamed15]

How to Build the grafana MQTT plugin for windows 10 :-

1.Download Nodejs version 14 or higher from https://nodejs.org/
2.Install Nodejs using recommended settings
3.To install yarn go to windows start menu choose the cmd and type "npm install --global yarn"
4.Download Go language for windows from https://golang.org/
5.Install Go language
6.Download Mage from github repository https://github.com/magefile/mage by clicking the code (green button ) and choose download zip
7.Extract the downloaded zip file to the path of GO lanuguage
8.From Windows start menu open cmd and go the bath of the extracted mage folder
9.Type "go run bootstrap.go"
10.In the mqtt-datasource-plugin open the file package.json and change the written commands in the fifth line from after the build command from "rm" to "rimraf" and save the file
11.Proceed with the written procedure to install the plugin as described in the readme file

[atifali]

@whbruce @mmohamed15 appreciate the detailed pre-requisite installation guides 👏
have referenced these in the docs, see: #16. closing this issue now.

[DonatoD]

Sorry, it's normal, on window, have all this warning?

[KirannBhavaraju]

@whbruce and @mmohamed15 , isnt the npm package @grafana/toolkit found here, installed as npm i @grafana/toolkit -g also a dependency to for the yarn build step to be successful?

It is under devDependencies in the package.json so running yarn install before doing yarn build step should work.

[Potemkinkuliss]

Im am trying to install this plugin inside a container with grafana installed running ubuntu (grafana:8.2.2-ubuntu) on a linux mashine.
Everything works until go run bootstrap.go. I receive:

root@fb9bae54db75:~/go/src/github.com/magefile/mage# go build -o /root/go/bin/mage -ldflags=-X "github.com/magefile/mage/mage.timestamp=2021-10-27T22:12:25Z" -X "github.com/magefile/mage/mage.commitHash=4cf3cfc" -X "github.com/magefile/mage/mage.gitTag=v1.11.0-2-g4cf3cfc" github.com/magefile/mage
can't load package: package github.com/magefile/mage/mage.timestamp=2021-10-27T22:12:25Z: malformed module path "github.com/magefile/mage/mage.timestamp=2021-10-27T22:12:25Z": invalid char '='
can't load package: package -X: malformed module path "-X": leading dash
can't load package: package github.com/magefile/mage/mage.commitHash=4cf3cfc: malformed module path "github.com/magefile/mage/mage.commitHash=4cf3cfc": invalid char '='
can't load package: package github.com/magefile/mage/mage.gitTag=v1.11.0-2-g4cf3cfc: malformed module path "github.com/magefile/mage/mage.gitTag=v1.11.0-2-g4cf3cfc": invalid char '='

NAME="Ubuntu"
VERSION="20.04.3 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.3 LTS"

Any thoughts?

[SStarosielec]

10.In the mqtt-datasource-plugin open the file package.json and change the written commands in the fifth line from after the build command from "rm" to "rimraf"

it works better to replace "rm -rf dist && ..." by "del /F /Q dist && ..." on windows.

[Anto79-ops]

hi, wondering if you can help. I have Ubuntu 20 and followed these instructions as written above except

1. ran "yarn install" first than "yarn build" at the end there
2. No errors in any of the steps, except some dependency warnings like @DonatoD reported

Continuing with the instructions, I modified the config file as described, but still, the plugin is NOT showing up in data source add-on/ pluging search when in Grafana desktop. what have I done wrong? more details here