Files
grafana/docs/sources/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-annotations.md
Jack Baldry 2004463405 [v10.0.x] Explicitly set all front matter labels in the source files (#71817)
Explicitly set all front matter labels in the source files (#71548)

* Set every page to have defaults of 'Enterprise' and 'Open source' labels



* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels



* Set administration/enterprise-licensing pages to have 'Enterprise' labels



* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels



* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels



* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise



* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud



* Fix introduction pages products



* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise



* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss



* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise



* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise



* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review




---------




(cherry picked from commit 7eb17bccca)

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 11:29:58 +01:00

1.3 KiB

aliases, description, keywords, labels, menuTitle, title, weight
aliases description keywords labels menuTitle title weight
../../../plugins/add-support-for-annotations/
Add support for annotations in your plugin.
grafana
plugins
plugin
annotations
products
enterprise
oss
Enable annotations Enable annotations 100

Enable annotations

You can add support to your plugin for annotations that will insert information into Grafana alerts. This guide explains how to add support for [annotations]({{< relref "../../../../dashboards/build-dashboards/annotate-visualizations#querying-other-data-sources" >}}) to a data source plugin.

Support annotations in your data source plugin

To enable annotations, simply add two lines of code to your plugin. 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.

    In plugin.json:

    {
      "annotations": true
    }
    
  2. In datasource.ts, override the annotations property from DataSourceApi (or DataSourceWithBackend for backend data sources). For the default behavior, set annotations to an empty object.

    In datasource.ts:

    annotations: {
    }