Skip to content

IoTOpen/grafana-datasource-lynx

Repository files navigation

IoTOpen grafana datasource

Installation

Docker

$ docker run -p 3000:3000 \
  -e "GF_INSTALL_PLUGINS="<link to zip-file>" \
  grafana/grafana:latest

Manually

  • Download the plugin zip file from the releases
  • Unzip into grafana plugin directory (defaults to /var/lib/grafana/plugins)
  • Restart grafana

Configure

  • Login to Lynx AAM
  • Go to Profile -> Security -> Generate new API key
  • Copy key to grafana datasource configuration.

Query

All filters will be passed to functionx endpoint as filters. Series will be grouped by all matching functions.

Test from repo

Make sure docker daemon is up and running. There is a script ./grafana-dev.sh that starts a Grafana server and maps the dist dir into grafana plugins.

It automatically installs following plugins:

  • grafana-piechart-panel
  • grafana-worldmap-panel
  • pr0ps-trackmap-panel

Make sure to run the script in the git root directory.

Default username password is admin:helloworld and server is running on http://localhost:3000

Name series after device meta

You can name grafana series after device meta by prefixing the Name by field with @device. and appending the meta key.

@device.name would name the series after the device name instead of the function name.

OAuth2 passthru development

To test oauth2 passthrou feature;

  • create a new oauth2 client via the admin panel (Make sure the application has the openid scope)
  • Edit the docker-compose.oauth2.yaml and replace the EDIT_ME fields with the new credentials
  • Replace host.tld with the host for the oauth2 client

Run docker compose -f docker-compose.oauth2.yaml up --build or npm run serverauth

  • Add datasource and tick the OAuth2 passthru checkbox