grafana-scalyr-datasource-plugin

A plugin for using scalyr's data in grafana. Requires a proxy server (implementation example linked below)

Work has been started on a backend plugin that would remove the need for a proxy server. Check the branch test_quick_convert for a roadmap.

Variable Templating

This plugin makes use of Grafana's variables feature. However, due to the fact that Scalyr uses "$" as a special character, this plugin uses "~" as a variable identifier

Example:

We have a grafana variable called grafana_var_name

It has a type of Custom with the values as missing required,unauthorized access,cache miss

The selected value of grafana_var_name for our dashboard is cache miss

If we set the query as: $someScalyrField contains "~grafana_var_name

Then the query passed to scalyr will be: $someScalyrField contains "cache miss"

You can still use Grafana's [[varname]] syntax. More info on templating can be found here.

Escaping

Say, for example, you want to send a Scalyr query like this:

$someScalryField contains "my special ~error~"

If there are no Grafana variables with the name "error" then this will be sent literally

Now, say we have a Grafana variable with the name "error", that has the value "cool" you would escape the first tilde like so:

$someScalryField contains "my special ~~error~"

and it would interpolate to

$someScalryField contains "my special ~cool~"

If you have a Grafana variable with the name "error" and you want it to literally say "~~error~~", simply escape it with a backslash

$someScalryField contains "my special \~error"

which will interpolate to

$someScalryField contains "my special ~error"

TODO:

Add screenshots to the README
Add Annotation support for possible values to search scalyr for

Example Proxy Server

https://github.com/AdknownInc/grafana-scalyr-proxy-server

Note: Updated the required version of Grafana to 5.3.x because JsonData interpolation of the routes section of plugin.json was only added for the url parameter in 5.3.0 of Grafana

Development

Dependencies:

npm
go1.12+
go dep

To build backend alerting plugin, this repo will need to be in your $GOPATH.

To setup this directory for development/compilation, in the root directory run the following: make first_pull