Add support for annotations
This guide explains how to add support for annotations to an existing data source plugin.
This guide assumes that you’re already familiar with how to Build a data source plugin.
Note: Annotation support for React plugins was released in Grafana 7.2. To support earlier versions, refer to the Add support for annotation for Grafana 7.1.
Add annotations support to your data source
To enable annotation support for your data source, add the following two lines of code. Grafana uses your default query editor for editing annotation queries.
-
Add
"annotations": true
to the plugin.json file to let Grafana know that your plugin supports annotations.plugin.json
{ "annotations": true }
-
In
datasource.ts
, override theannotations
property fromDataSourceApi
(orDataSourceWithBackend
for backend data sources). For the default behavior, you can setannotations
to an empty object.datasource.ts
annotations: { }
Related Grafana resources
Opening keynote: What's new in Grafana 9?
Raj Dutt, Myrle Krantz, and Torkel Ödegaard unveil what's new in Grafana 9. Watch the opening keynote presentation from GrafanaCONline 2022. On-demand.
Unify your data with Grafana plugins: Splunk, MongoDB, Datadog, and more
Show how Grafana can be used to take data from multiple different sources and unify it, without disrupting the investments that are working today.
Getting started with Grafana Enterprise and observability
Join the Grafana Labs team for a 30-minute demo of how to get started with the Grafana Stack, so you can go from zero to observability in just a few minutes.