hstefan / spotify-heroic-datasource

Heroic datasource for Grafana

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

spotify-heroic-datasource

Build Status

heroic-datasource-screenshot

The Spotify Heroic datasource is the "official" plugin for Heroic!

It includes:

  • Query builder with suggestions for metrics.
  • Table support.
  • Annotation support.

This plugin is supersedes the previous Heroic datasource.

Inspiration was taken from the Grafana InfluxDB plugin.

Installation

The recommened way to install the plugin is via the official cli:

grafana-cli plugins install spotify-heroic-datasource

The plugin can also be installed by directly pointing at a release. Useful if you want to test a feature that hasn't been released yet.

grafana-cli --pluginUrl https://github.com/spotify/spotify-heroic-datasource/archive/master.zip plugins install spotify-heroic-datasource

Local Development

To develop locally:

  • yarn install
  • yarn watch

Add the following to your grafana.ini to deploy to your local Grafana instance:

[plugin.spotify-heroic-datasource]
path = /{path-to-spotify-heroic-datasource}

If using Docker, you can mount this repo into the Grafana plugin directory:

docker run -it -p 3000:3000 --name=grafana -v `pwd`/dist:/var/lib/grafana/plugins/spotify-heroic-datasource grafana/grafana

Releasing

Travis will automatically bump the patch version of the plugin, tag the commit and make a GitHub Release.

The commit hash then needs to be appended to repo.json in for it to be installable via the grafana-cli.

Code of Conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

About

Heroic datasource for Grafana

License:Apache License 2.0


Languages

Language:TypeScript 86.4%Language:HTML 10.6%Language:JavaScript 2.4%Language:CSS 0.7%