Skip to content

GreptimeTeam/greptimedb-grafana-datasource

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GreptimeDB DataSource for Grafana

GitHub Release GitHub License This is a Grafana data source plugin built for GreptimeDB. This plugin is built on top of original Grafana ClickHouse data source and enhanced for GreptimeDB's additional features.

Installation

Grab the latest release from release page, Unzip the file to your grafana plugin directory.

Use grafana cli to download and install

Install signed version

grafana cli --pluginUrl https://github.com/GreptimeTeam/greptimedb-grafana-datasource/releases/latest/download/info8fcc-greptimedb-datasource.zip plugins install info8fcc

Install unsigned version

If there is some error when installing signed version, use unsigned version

you need to set grafana ini file to use unsigned plugin.

allow_loading_unsigned_plugins = info8fcc-greptimedb-datasource

If you are using Grafana inside Docker, you need to export the variable:

GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=info8fcc-greptimedb-datasource
grafana cli --pluginUrl https://github.com/GreptimeTeam/greptimedb-grafana-datasource/releases/latest/download/info8fcc-greptimedb-datasource-unsigned.zip plugins install info8fcc

Note that you may need to restart your grafana server after installing the plugin.

Docker Image

We also build Grafana docker image that includes GreptimeDB datasource by default. To run the docker image:

docker pull greptime/grafana-greptimedb:latest
docker run -p 3000:3000 greptime/grafana-greptimedb:latest

You can log in Grafana by visiting http://localhost:3000. The default username and password are both set to admin.

Docs

See our setup guide from our docs.

Connection

Connection

Use The Query Builder

  • Table: Presents data in a structured table format. Optimized for datasets without a timestamp field. Table Query
  • Time Series: Provides data that includes a timestamp field, for time series visualization. Time Series
  • Logs: Supplies data formatted for log analysis. Logs
  • Traces: Provides detailed trace data. Traces

Development

Yarn 1.x is required for this project. Execute these commands in code root folder

  1. Install dependencies

    yarn install
  2. Build plugin in development mode and run in watch mode

    yarn run dev
  3. Build backend plugin binaries for Linux, Windows and Darwin:

    mage -v build:linux
  4. Start Docker Service

    docker compose up

License

GreptimeDB uses the Apache License 2.0 to strike a balance between open contributions and allowing you to use the software however you want.