https://github.com/timeplus-io/proton-grafana-source
Grafana data source plugin for Timeplus
https://github.com/timeplus-io/proton-grafana-source
Last synced: 2 months ago
JSON representation
Grafana data source plugin for Timeplus
- Host: GitHub
- URL: https://github.com/timeplus-io/proton-grafana-source
- Owner: timeplus-io
- License: apache-2.0
- Created: 2023-09-28T22:35:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-12T21:19:35.000Z (7 months ago)
- Last Synced: 2025-12-13T05:08:00.776Z (7 months ago)
- Language: Go
- Homepage:
- Size: 22.7 MB
- Stars: 2
- Watchers: 10
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Timeplus Grafana Datasource
Grafana data source plugin to connect to Timeplus and visualize streaming or batch queries.
## Overview / Introduction
As the core engine of [Timeplus Enterprise](https://timeplus.com), [Proton](https://github.com/timeplus-io/proton) is a single binary for streaming analytics. It helps data engineers and platform engineers solve complex real-time analytics use cases.
## Requirements
Grafana v11.3 or above (older versions may work but not verified)
A running Timeplus Proton or Timeplus Enterprise instance with TCP port 8463 (for database connection) and HTTP port 3218 (for query analazyer REST API).
## Getting Started
### Use the pre-built Docker Compose
The [docker-compose.yaml](docker-compose.yaml) in this folder ships a Grafana container, with the proton plugin pre-installed, as well as a data generator.
You start it with `docker compose up` and go to http://localhost:3000 to view the Carsharing dashboard.
A data source for Timeplus is created automatically.
### Query Variables
You can define dashboard variables with this data source. Please make sure turning off the streaming query mode in the SQL to populate the variable values, and only return 1 or 2 columns. When there is 1 column returned, it will be set as both value and label. If there are 2 columns, the first column will be set as value and the second column as the label. You can also refer to `__from` and `__to` variables in the SQL to get the time range of the dashboard, e.g.:
```sql
SELECT distinct product_id FROM table(coinbase) where _tp_time < to_datetime($__to/1000) and _tp_time > to_datetime($__from/1000)
```
## Development
### Backend
1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version:
```bash
go get -u github.com/grafana/grafana-plugin-sdk-go
go mod tidy
```
2. Build backend plugin binaries for Linux, Windows and Darwin:
```bash
brew install mage
mage -v
```
mage build:linuxARM will fail, which is okay. Only 64bit OS are supported.
3. List all available Mage targets for additional commands:
```bash
mage -l
```
### Frontend
1. Install dependencies
```bash
npm install
```
2. Build plugin in development mode and run in watch mode (Ctrl+C to stop)
```bash
npm run dev
```
3. Build plugin in production mode
```bash
npm run build
```
4. Sign the plugin
```bash
export GRAFANA_ACCESS_POLICY_TOKEN=
npm run sign
```
5. Distribute the plugin
```bash
make package
```
## Learn more
Below you can find source code for existing app plugins and other related documentation.
- [Basic data source plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/datasource-basic#readme)
- [`plugin.json` documentation](https://grafana.com/developers/plugin-tools/reference-plugin-json)
- [How to sign a plugin?](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/)