Grafana Cloud Enterprise Open source

Annotations list

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.

The annotations list visualization

Configuration options

The following section describes the configuration options available in the panel editor pane for this visualization. These options are, as much as possible, ordered as they appear in Grafana.

Panel options

In the Panel options section of the panel editor pane, set options like the panel title, description, and show/hide rules. To learn more, refer to Configure panel options.

OptionDescription
TitleText entered in this field appears at the top of your panel in the panel editor and in the dashboard. You can use variables you have defined or global variables.
DescriptionAdd a description to a panel to share with users any important information about it, such as its purpose. Text entered in this field appears in a tooltip in the upper-left corner of the panel. Conversely, toggle on the Use as subtitle switch to display the description just below the panel title instead. You can use variables you have defined or dashboard-scoped global variables (such as $__from, $__to, $__dashboard, $__org, and $__user). Query-scoped global variables (such as $__interval and $__interval_ms) are not available in this field.
Transparent backgroundToggle this switch on and off to control whether or not the panel has the same background color as the dashboard.
Panel linksAdd links to the panel to create shortcuts to other dashboards, panels, and external websites. Access panel links by clicking the icon next to the panel title.
Repeat optionsSet whether to repeat the panel for each value in the selected variable.
Show/hide rulesSet whether to show or hide panels based on various rules.

Annotation query options

The following options control the source query for the list of annotations:

OptionDescription
Query filterSpecify which annotations are included in the list.
Time rangeSpecify whether the list should be limited to the current time range.
TagsFilter 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.
LimitLimit the number of results returned. The default is 10.

Query filter

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:

  • All dashboards - List annotations from all dashboards in the current organization.
  • This dashboard - Limit the list to the annotations on the current dashboard.

Time range

Specify whether the list should be limited to the current time range. Choose from:

  • 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.

Display options

These options control additional metadata included in the annotations list display:

OptionDescription
Show userShow or hide which user created the annotation.
Show timeShow or hide the time the annotation creation time.
Show tagsShow or hide the tags associated with an annotation. Note that you can use the tags to filter the annotations list.

Use the following options to control the behavior of annotation links in the list:

OptionDescription
Link targetSet how to view the annotated data. The default is Panel. Choose from:
  • Panel - The link takes you directly to a full-screen view of the panel with the corresponding annotation.
  • Dashboard - Focuses the annotation in the context of a complete dashboard.
Time beforeSet the time range before the annotation. Use duration string values like 1h for one hour and 10m for 10 minutes. The default is 10m.
Time afterSet the time range after the annotation. The default is 10m.