› Developers › Build a plugin › Add support for annotations

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.

  1. Add "annotations": true to the plugin.json file to let Grafana know that your plugin supports annotations.

    plugin.json

    {
  "annotations": true
}

  2. In datasource.ts, override the annotations property from DataSourceApi. For the default behavior, you can set annotations to an empty object.

    datasource.ts

    annotations: {};
Related Grafana resources
Getting started with Grafana 8

Grafana 8.0 is here! Join us for a live walkthrough on how to get started using Grafana 8 and the Grafana 8 user interface while showing how to set up monitoring for a web service that uses Prometheus and Loki to store metrics and logs.

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.

Demo: 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.