search

scalyr / scalyr-grafana-datasource-plugin

Apache License 2.0
14 stars 5 forks source link

Grafana annotation support #52

Closed yanscalyr closed 4 years ago

yanscalyr commented 4 years ago

https://scalyr.myjetbrains.com/youtrack/issue/CT-149 https://grafana.com/docs/grafana/latest/dashboards/annotations/

Support the ability to generate annotations from queries to Scalyr in Grafana using our datasource.

We query Scalyr for any logs matching the user provided query, transform them into the format Grafana expects for annotations, and then pass them along to Grafana which will show them as vertical lines on the user's graphs. Horizontal position determined by timestamp and message given when hovered over given by the message field, though both of these are configurable. Optionally the user can configure a field to act as an "end time" for the annotation to show up as an area on the graph.

We have no specific requirements for what features to support, so far we include the ability to chose which fields in the logs will map to the annotation text and timestamps (in milliseconds). Future things to consider supporting is picking a field to grab tags, as well as the ability to chose a unit for the timestamps.

yanscalyr commented 4 years ago

Still need some unit tests but wouldn't mind reviews while I work on that.

Kami commented 4 years ago

There is a more of a long term wish and not something we can do at this point - but eventually some automated end to end tests would be nice (aka spin up Grafana instance, connect it to some testing Scalyr account and do some basic checks using Selenium or whatever is popular these days).

That would come handy even just from the testing perspective - e.g. docker compose setup which spins up Grafana + related things.