diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index 89ba8ea3face3..19737e052b7dd 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -1619,6 +1619,11 @@ menu: parent: dashboards weight: 9 identifier: dashboards_overlays + - name: Annotations + url: dashboards/annotations/ + parent: dashboards + weight: 901 + identifier: dashboards_annotations - name: Sharing identifier: dashboards_sharing url: dashboards/sharing/ diff --git a/content/en/dashboards/annotations/_index.md b/content/en/dashboards/annotations/_index.md new file mode 100644 index 0000000000000..00a1b7d13da63 --- /dev/null +++ b/content/en/dashboards/annotations/_index.md @@ -0,0 +1,39 @@ +--- +title: Annotations +description: Learn how to add, customize, and manage annotations on timeseries widgets in dashboards and notebooks to highlight important events. +disable_toc: false +--- + +## Overview + +Annotations let you manually place vertical markers with descriptions on timeseries widgets. Adding annotations can be useful to visually call out key events like deploys, incidents, or spikes. Click any point in time and add a note. + +Annotations are available in both dashboards and notebooks. If you export a widget from a dashboard to a notebook, any annotations you've added to the widget persist. + + + +## Adding an annotation + +1. Create an annotation by: + - Left-clicking anywhere on a timeseries widget and selecting **Add annotation** from the context menu that appears, or + - Clicking the X axis on a timeseries +3. Type your comment, and optionally click the timestamp field to manually adjust to the precise time you want to annotate. +4. Optionally change the color of the annotation from the dropdown in the bottom left. +5. Click **Save**. + +## Adding multiple annotations + +To apply an annotation to multiple timeseries at once: + +1. Select the widgets you want to apply the annotation to (or leave everything unselected to apply to all widgets). +2. Follow steps 1–4 [above](#adding-an-annotation) to start creating an annotation. +3. From the **Applying to** dropdown, choose **All widgets** or **Selected widgets**. +4. Click **Save**. + +## Editing an annotation + +To edit an annotation you've created, hover over the annotation line, click the three dots menu, and choose **Edit** or **Edit for all widgets**. + +## Deleting an annotation + +To delete an annotation you've created, hover over the annotation line, click the three dots menu, and choose **Delete** or **Delete from all widgets**. \ No newline at end of file