2022-05-26 23:06:25 +08:00
---
aliases:
2023-08-03 21:53:13 +08:00
- ../../features/panels/annotations/
2022-12-10 00:36:04 +08:00
- ../../panels/visualizations/annotations/
- ../../visualizations/annotations/
2023-12-13 04:27:29 +08:00
description: Configure options for Grafana's annotations list visualization
2022-05-26 23:06:25 +08:00
keywords:
- grafana
- Annotations
- panel
- documentation
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* 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
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* 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
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* 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
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
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 16:10:12 +08:00
labels:
products:
- cloud
- enterprise
- oss
2023-09-22 22:27:16 +08:00
title: Annotations list
2023-09-01 02:31:37 +08:00
weight: 100
2022-05-26 23:06:25 +08:00
---
2021-07-22 04:25:32 +08:00
2023-09-22 22:27:16 +08:00
# Annotations list
2021-07-22 04:25:32 +08:00
2023-09-22 22:27:16 +08:00
The annotations list shows a list of available annotations you can use to view annotated data. Various options are available to filter the list based on tags and on the current dashboard.
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
{{< figure src = "/media/docs/grafana/panels-visualizations/screenshot-annotations-list-viz-v12.0.png" max-width = "750px" alt = "The annotations list visualization" > }}
2024-05-03 02:17:23 +08:00
2025-04-11 23:29:49 +08:00
## Configuration options
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
{{< docs / shared lookup = "visualizations/config-options-intro.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
### Panel options
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
{{< docs / shared lookup = "visualizations/panel-options.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
### Annotation query options
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
The following options control the source query for the list of annotations:
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
<!-- prettier - ignore - start -->
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
| Option | Description |
| ---------- | --------------------------------------------------------------------------------------------------------- |
| [Query filter ](#query-filter ) | Specify which annotations are included in the list. |
| [Time Range ](#time-range ) | Specify whether the list should be limited to the current time range. |
| Tags | Filter the annotations by tags. You can add multiple tags to refine the list. Optionally, leave the tag list empty and filter in view mode by selecting tags that are listed as part of the results on the panel itself. |
| Limit | Limit the number of results returned. |
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
<!-- prettier - ignore - end -->
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
#### Query filter
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
Use the **Query filter** option to create a list of annotations from all dashboards in your organization or the current dashboard in which this panel is located.
Choose from:
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
- **All dashboards** - List annotations from all dashboards in the current organization.
- **This dashboard** - Limit the list to the annotations on the current dashboard.
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
#### Time Range
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
Specify whether the list should be limited to the current time range.
Choose from:
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
- **None** - No time range limit for the annotations query.
- **This dashboard** - Limit the list to the time range of the dashboard where the annotations list is available.
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
### Display options
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
These options control additional metadata included in the annotations list display:
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
<!-- prettier - ignore - start -->
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
| Option | Description |
| ---------- | --------------------------------------------------------------------------------------------------------- |
| Show user | Show or hide which user created the annotation. |
| Show time | Show or hide the time the annotation creation time. |
| Show tags | Show or hide the tags associated with an annotation. Note that you can use the tags to filter the annotations list. |
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
<!-- prettier - ignore - end -->
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
### Link behavior options
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
Use the following options to control the behavior of annotation links in the list:
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
<!-- prettier - ignore - start -->
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
| Option | Description |
| ---------- | --------------------------------------------------------------------------------------------------------- |
| Link target | Set how to view the annotated data. Choose from:< ul > < li > **Panel** - The link takes you directly to a full-screen view of the panel with the corresponding annotation.< / li > < li > **Dashboard** - Focuses the annotation in the context of a complete dashboard.< / li > < / ul > |
| Time before | Set the time range before the annotation. Use duration string values like `1h` for one hour and `10m` for 10 minutes. |
| Time after | Set the time range after the annotation. |
2021-07-29 08:06:42 +08:00
2025-04-11 23:29:49 +08:00
<!-- prettier - ignore - end -->