Grafana data source plugin for HarperDB

Getting started

Requires Grafana 7.0 or higher.

Clone this repo into your grafana/plugins directory.

This plugin is not yet signed, so you'll need to configure Grafana to load it anyway.

Configuration

When you create a new Grafana datasource with this plugin, you'll need to give it the full URL (including port) to your HarperDB Operations API endpoint.

Then you'll need to give Grafana the username and password you'd like to use to access your HarperDB instance.

Development

Backend

1. Update Grafana plugin SDK for Go dependency to the latest minor version:

   go get -u github.com/grafana/grafana-plugin-sdk-go
   go mod tidy

2. Build backend plugin binaries for Linux, Windows and Darwin:

   mage -v

3. List all available Mage targets for additional commands:

   mage -l

Frontend

1. Install dependencies

   npm install

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

   npm run dev

3. Build plugin in production mode

   npm run build

4. Run the tests (using Jest)

   # Runs the tests and watches for changes, requires git init first
   npm run test
   
   # Exits after running all the tests
   npm run test:ci

5. Spin up a Grafana instance and run the plugin inside it (using Docker)

   npm run server

6. Run the E2E tests (using Cypress)

   # Spins up a Grafana instance first that we tests against
   npm run server
   
   # Starts the tests
   npm run e2e

7. Run the linter

   npm run lint
   
   # or
   
   npm run lint:fix

Dev workflow

1. Run npm run dev in one terminal
   • This will watch your frontend code for changes
2. Build the backend: mage -v build:linuxARM64
   • Because this will run in a Docker container, you should always build it for Linux
   • You will have to manually rerun this when the backend code changes
3. Run docker compose up in another terminal
   • This will need to be restarted when the backend is rebuilt
4. Access Grafana at http://localhost:3000/