grafana-flightsql-datasource

README

Grafana Flight SQL Datasource

⚠ This library is experimental and under active development. The configuration it provides could change at any time so use at your own risk.

This is a plugin for Grafana that enables queries to Flight SQL APIs.

Installation

Download the latest release:

$ curl -L https://github.com/influxdata/grafana-flightsql-datasource/releases/download/v0.1.0/influxdata-flightsql-datasource-0.1.1.zip

Unzip the release into your Grafana plugins directory:

$ unzip influxdata-flightsql-datasource-0.1.1.zip -d grafana-plugins/

Configuration

1. Point Grafana to this the plugins directory. You have two options:

   • Edit the paths.plugins directive in your grafana.ini:

     [paths]
     plugins = grafana-plugins/
     

   • OR set the relevant environment variable where Grafana is started:

     GF_PATHS_PLUGINS=grafana-plugins/
     

2. The plugin is not yet signed so you will need to add it to the Grafana configuration of allowed unsigned plugins.

   • Add the following to your grafana.ini:

     [plugins]
     allow_loading_unsigned_plugins = influxdata-flightsql-datasource
     

   • OR set the relevant environment variable where Grafana is started:

     GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=influxdata-flightsql-datasource
     

3. Navigate to the Locally Running Grafana.

4. Follow the instructions in Adding a Flight SQL Datasource.

📖 Further documentation about Grafana configuration.

Usage

Adding a Flight SQL Datasource

1. Open the side menu by clicking the Grafana icon in the top header.
2. In the side menu under the Dashboards link you should find a link named Data Sources.
3. Click the + Add data source button in the top header.
4. Select FlightSQL from the Type dropdown.

Configuring the Plugin

• Host: Provide the host:port of your Flight SQL client.

• AuthType Select between none, username/password and token.

• Token: If auth type is token provide a bearer token for accessing your client.

• Username/Password iF auth type is username and password provide a username and password.

• Require TLS/SSL: Either enable or disable TLS based on the configuration of your client.

• MetaData Provide optional key, value pairs that you need sent to your Flight SQL client.

Vendor-specific connectivity documentation can be found in the wiki.

Using the Query Builder

The default view is a query builder which is in active development:

• Begin by selecting the table from the dropdown.
• This will auto populate your available columns for your select statement. Use the + and - buttons to add or remove additional where statements.
• You can overwrite a dropdown field by typing in your desired value (e.g. *).
• The where field is a text entry where you can define any where clauses. Use the + and - buttons to add or remove additional where statements.
• You can switch to a raw SQL input by pressing the "Edit SQL" button. This will show you the query you have been building thus far and allow you to enter any query.
• Press the "Run query" button to see your results.
• From there you can add to dashboards and create any additional dashboards you like.

Development

See DEVELOPMENT.md.