Plugins 〉SQLite

Data Source
community

SQLite

  • Overview
  • Installation
  • Change log
  • Related content

Grafana SQLite Datasource

License stability-stable Test Branch Test Release

This is a Grafana backend plugin to allow using a SQLite database as a data source.

Development and Contributing

Any contribution is welcome. Some information regarding the local setup can be found in the DEVELOPMENT.md file.

Plugin Installation

The most up to date (but also most generic) information can always be found here: Grafana Website - Plugin Installation

Installing the Plugin on an Existing Grafana With the CLI

Grafana comes with a command line tool that can be used to install plugins.

  1. Run this command: grafana-cli plugins install frser-sqlite-datasource
  2. Restart the Grafana server.
  3. Login in with a user that has admin rights. This is needed to create datasources.
  4. To make sure the plugin was installed, check the list of installed datasources. Click the Plugins item in the main menu. Both core datasources and installed datasources will appear.

Installing the Plugin Manually on an Existing Grafana (Most up to Date)

If you need a version that is not released (yet) on the Grafana homepage or if the server where Grafana is installed has no access to the Grafana.com server, then the plugin can be downloaded and manually copied to the server.

  1. Get the zip file from Latest release on Github

  2. Extract the zip file into the data/plugins subdirectory for Grafana: unzip <the_download_zip_file> -d <plugin_dir>/

    Finding the plugin directory can sometimes be a challenge as this is platform and settings dependent. A common location for this on Linux devices is /var/lib/grafana/plugins/

  3. Restart the Grafana server

  4. To make sure the plugin was installed, check the list of installed datasources. Click the Plugins item in the main menu. Both core datasources and installed datasources will appear.

ARM6 / RaspberryPi Zero W Support

This plugins supports ARM6 (the version running on RaspberryPi Zero W). There is a problem, though, with Grafana supporting ARM7 (newer Raspberries) and ARM6 at the same time. Grafana chooses the correct plugin by file name. But both ARM6 and ARM7 are named <plugin_dir>/frser-sqlite-datasource/gpx_sqlite-datasource_linux_arm.

Currently the ARM7 build is named like this by default, which is why the "official" plugin distribution does not support ARM6 devices.

A plugin version specifically built for ARM6 devices can be found on the Github release page (see manual installation above).

Configuring the Datasource in Grafana

The only required configuration is the path to the SQLite database (local path on the Grafana Server)

  1. Add an SQLite datasource.
  2. Set the path to the database (the grafana process needs to find the SQLite database under this path).
  3. Save the datasource and use it.

Support for Time Formatted Columns

SQLite has no native "time" format. It actually relies on strings and numbers. Since especially for time series Grafana expects an actual time type, however, the plugin provides a way to infer a real timestamp. This can be set in the query editor by providing the name of the column, which should be reformatted to a timestamp.

The plugin supports two different inputs that can be converted to a "time" depending on the type of the value in the column, that should be formatted as "time":

  1. A number input: It is assumed to be a unix timestamp / unix epoch and will be converted to an integer before converting it to a timestamp.

  2. A string input: The value is expected to be formatted in accordance with RFC3339, e.g. "2006-01-02T15:04:05Z07:00". Edge cases might occur and the parsing library used is the source of truth here: https://golang.org/pkg/time/#pkg-constants.

Timestamps stored as unix epoch should work out of the box, but the string formatting might require adjusting your current format. The below example shows how to convert a "date" column to a parsable timestamp:

WITH converted AS (
   -- a row looks like this (value, date): 1.45, '2020-12-12'
   SELECT value,  date || 'T00:00:00Z' AS datetime FROM raw_table
)
SELECT datetime, value FROM converted ORDER BY datetime ASC

Macros

This plugins supports plugins inspired by the built-in Grafana datasources (e.g. https://grafana.com/docs/grafana/latest/datasources/postgres/#macros).

However, as each macro needs to be re-implemented from scratch only the following macros are supported. Other macros (that you might expect from other SQL databases) do not work

$__unixEpochGroupSeconds(unixEpochColumnName, intervalInSeconds)

Example: $__unixEpochGroupSeconds("time", 10)

Will be replaced by an expression usable in GROUP BY clause. For example: cast(("time" / 10) as int) * 10

$__unixEpochGroupSeconds(unixEpochColumnName, intervalInSeconds, NULL)

Example: $__unixEpochGroupSeconds(timestamp, 10, NULL)

Same as above but with a fill parameter so missing points in that series will be added by grafana and NULL will be used as value.

In case multiple time columns are provided the first one is chosen as the column to determine the gap filling. "First" in this context means first in the SELECT statement. This column to have no NULL values and must be ordered ascending.

For more information, visit the docs on plugin installation.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog

[1.2.0]

Added

  • The response of the plugin includes the final query as metadata and can be checked in the inspector now
  • Macro unixEpochGroupSeconds:
    • replace time columns with an expression to group by
    • Allow filling up missing values with NULL

Fixed

  • return additional time formatted column for time-series formats as normal values (previously they were skipped)

[1.1.0]

Added

  • Experimental support for MacOS (no static linking)

[1.0.3]

Fixed

  • Showing better error messages for certain fail conditions of the plugin health check (e.g. permission error)

[1.0.2]

Fixed

  • Fixed bug preventing using query variables when SQLite is the default datasource (<= Grafana 7.4)

[1.0.1]

Added

  • Enabled the alerting feature for the plugin (no code change)

[1.0.0]

No breaking change was introduced but due to code stability the first major version is released.

Fixed

  • variables like $__interval and $__interval_ms are supported now

[0.2.7]

Changed

  • Changing plugin name to SQLite

  • added category to plugin.json for better grouping on the Grafana homepage

  • updated Readme after first official release of plugin on Grafana homepage

[0.2.6]

Added

  • Documentation about the time conversion in the README and in the query editor help text.

[0.2.5]

Fixed

  • Correct handling of "NUMERIC" columns with mixed data (e.g. float and integer)

[0.2.4]

Added

  • Added option to explicitly convert backend data frame to time series:

    • This requires the initial data frame to be in a Long Format

    • The resulting time series consists of one data frame per metric

[0.2.3]

Changed

  • Releasing arm6 (RaspberryPi Zero) as separate distribution (Github only)

Fixed

  • Renamed the arm7 executable to arm (newer Raspberry Models should run fine now)

[0.2.2]

Changed

  • Different content of zip file published with Github release according to new Grafana v7.3 standards

[0.2.1]

Added

  • Query variables are now supported

[0.2.0]

Added

  • The plugin is now signed

Changed

  • For Signing grafana-toolkit 7.3.3 was necessary. The grafana version to test against was bumped to version 7.3.3

[0.1.3]

Fixed

  • Fixed: Handling of NULL values in queries is now correct

[0.1.2]

First "working" version

Fixed

  • Fixed: Plugin files in the zip file are now executable