Skip to content

Latest commit

 

History

History
 
 

datasource-http-backend

README.md

Grafana Data Source Plugin Template

This example queries data from an HTTP API, which returns data in JSON format and then it's converted to data frames.

This differs from the datasource-http example, because the data fetching happens in the plugin backend rather than going through Grafana's datasource HTTP proxy.

This allows to use the data source for alerting as well, as the query are executed on the backend.

This plugin example also showcases other features and best-practices of backend plugins:

  • Using the httpclient provided by the Grafana Plugins SDK
  • Tracing, for better instrumentation of your plugin

This plugin example also includes an example server returning data in the format expected by this plugin (cmd/server). Refer to the section below on how to build and run it.

External service

The plugin expects the following JSON from a remote HTTP API:

{
  "datapoints": [
    {"time": "2009-11-10T23:00:00Z", "value": x},
    ...
  ]
}

An example HTTP server that returns dummy data in this format is included in cmd/server.

Building

Frontend

$ yarn install
$ yarn build

Backend

$ mage -v

Example server

$ mage server
$ ./cmd/server/server :10000
2022/10/28 15:43:16 listening on :10000

Then, add a new data source in Grafana and use the following url:

http://127.0.0.1:10000/metrics