apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
28908 Commits
5979 Branches
596 Tags
1.7 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 9ef7770631
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9ef7770631'
${ noResults }
grafana/docs/sources/developers/plugins/add-support-for-annotations.md

1.2 KiB
Raw Blame History

+++ title = "Add support for annotations" +++

Add support for annotations

This guide explains how to add support for [annotations]({{< relref "../../dashboards/annotations.md" >}}) to an existing data source plugin.

This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "/tutorials/build-a-data-source-plugin.md" >}}).

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]({{< relref "metadata.md" >}}) 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: {};