Menu
Scroll for more
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Grafana Cloud
Enterprise
Open source
annotations
The configuration for the list of annotations that are associated with the dashboard.
JSON
"annotations": [
{
"kind": "AnnotationQuery",
"spec": {
"builtIn": false,
"datasource": {
"type": "",
"uid": ""
},
"enable": false,
"hide": false,
"iconColor": "",
"name": ""
}
}
],AnnotationsQueryKind consists of:
- kind: “AnnotationQuery”
- spec: AnnotationQuerySpec
AnnotationQuerySpec
| Name | Type/Definition |
|---|---|
| datasource | DataSourceRef |
| query | DataQueryKind |
| enable | bool |
| hide | bool |
| iconColor | string |
| name | string |
| builtIn | bool. Default is false. |
| filter | AnnotationPanelFilter |
| options | [string]: A catch-all field for datasource-specific properties. |
DataSourceRef
| Name | Usage |
|---|---|
| type? | string. The plugin type-id. |
| uid? | The specific data source instance. |
DataQueryKind
| Name | Type |
|---|---|
| kind | string |
| spec | string |
AnnotationPanelFilter
| Name | Type/Definition |
|---|---|
| exclude? | bool. Should the specified panels be included or excluded. Default is false. |
| ids | [...uint8]. Panel IDs that should be included or excluded. |
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:
Video

Getting started with managing your metrics, logs, and traces using Grafana
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Video

Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Video

Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.