From a6aab7d0c9c99f8869772404eab2c5432cb3ba32 Mon Sep 17 00:00:00 2001 From: Dominik Prokop Date: Fri, 16 Jul 2021 12:33:00 +0200 Subject: [PATCH] Docs: Add time series annotations docs (#36657) * Docs: Add time series annotations docs * Review --- .../time-series/annotate-time-series.md | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/sources/panels/visualizations/time-series/annotate-time-series.md diff --git a/docs/sources/panels/visualizations/time-series/annotate-time-series.md b/docs/sources/panels/visualizations/time-series/annotate-time-series.md new file mode 100644 index 00000000000..11d7abbb77c --- /dev/null +++ b/docs/sources/panels/visualizations/time-series/annotate-time-series.md @@ -0,0 +1,48 @@ ++++ +title = "Annotate time series" +keywords = ["grafana", "time series panel", "documentation", "guide", "graph", "annotations"] +weight = 200 ++++ + +# Annotate time series + +This section explains how to create annotations in the Time series panel. To read more about annotations support in Grafana please refer to [Annotations]({{< relref "../../../dashboards/annotations.md" >}}). + +## Add annotation + +1. In the dashboard click on the Time series panel. A context menu will appear. +1. In the context menu click on **Add annotation**. + ![Add annotation context menu](/static/img/docs/time-series-panel/time-series-annotations-context-menu.png) +1. Add an annotation description and tags(optional). + ![Add annotation popover](/static/img/docs/time-series-panel/time-series-annotations-add-annotation.png) +1. Click save. + +Alternatively, to add an annotation, Ctrl/Cmd+Click on the Time series panel and the Add annotation popover will appear + +## Add region annotation + +1. In the dashboard Ctrl/Cmd+click and drag on the Time series panel. + ![Add annotation popover](/static/img/docs/time-series-panel/time-series-annotations-add-region-annotation.gif) +1. Add an annotation description and tags(optional). +1. Click save. + +## Edit annotation + +1. In the dashboard hover over an annotation indicator on the Time series panel. + ![Add annotation popover](/static/img/docs/time-series-panel/time-series-annotations-edit-annotation.gif) +1. Click on the pencil icon in the annotation tooltip. +1. Modify the description and/or tags. +1. Click save. + +## Delete annotation + +1. In the dashboard hover over an annotation indicator on the Time series panel. + ![Add annotation popover](/static/img/docs/time-series-panel/time-series-annotations-edit-annotation.gif) +1. Click on the trash icon in the annotation tooltip. + + + + + + +