Skip to content

Latest commit

 

History

History
116 lines (79 loc) · 3.21 KB

README.md

File metadata and controls

116 lines (79 loc) · 3.21 KB
Raw

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 Prometheus data source and enhanced for GreptimeDB's additional features.

Screenshots

PromQL query builder with additional field selector.

explore

Time-series data rendered with GreptimeDB data source.

dashboard

Installation

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

You can also use grafana cli to download and install

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

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

Quick Preview using Docker

We built a docker compose file that integrated GreptimeDB, Prometheus, Prometheus Node Exporter, Grafana and this plugin together.

git clone https://github.com/GreptimeTeam/greptimedb-grafana-datasource.git
cd docker
docker compose up

You can also try out this plugin from a Grafana docker image:

docker run -d -p 3000:3000 --name=grafana --rm \
  -e "GF_INSTALL_PLUGINS=https://github.com/GreptimeTeam/greptimedb-grafana-datasource/releases/latest/download/info8fcc-greptimedb-datasource.zip;info8fcc" \
  grafana/grafana-oss

Docs

See our setup guide from our docs.

Features and Roadmap

We started this plugin from forking Grafana's built-in Prometheus plugin. The goal of this plugin is to provide visualization support for all native types of GreptimeDB data.

  • Time series panels
    • PromQL
      • GreptimeDB's additional field selector
    • SQL
      • Time macro
  • Event UI
    • Event
  • Settings UI
    • DB name input
    • Authentication

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

Community

Join our community slack channel #grafana for discussion of this plugin.

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.