docs-v2/content/influxdb/cloud/visualize-data/annotations.md

2.7 KiB

title description influxdb/cloud/tags menu weight
Use annotations in dashboards Add annotations to your InfluxDB dashboards to provide useful, contextual information about single points in time.
labels
annotations
influxdb_cloud
name parent
Use annotations Visualize data
104

Add annotations to your dashboards to provide useful, contextual information about single points in time. After an annotation is created, edit the annotation by updating the text or timestamp, or delete the annotation.

{{% note %}} Annotations may be useful to highlight operations or anomalies for your team to reference. {{% /note %}}

Create an annotation

  1. In the navigation menu on the left, select Boards (Dashboards).

    {{< nav-icon "dashboards" >}}

  2. Select an existing dashboard to add the annotation to, or create a new dashboard. The Annotations option is selected by default.

  3. In a dashboard cell, add an annotation by pressing Shift, and then click on a single point in time.

  4. On the Add Annotation page:

    1. Verify the start time, and update if needed.
    2. Enter a message (maximum of 255 characters) to associate with the selected start time.
    3. Click Save Annotation. The annotation appears as a dotted line at the specified start time and includes details associated with the selected point.

Edit an annotation

  1. In the navigation menu on the left, select Boards (Dashboards).

    {{< nav-icon "dashboards" >}}

  2. Open the dashboard with the annotation to edit, and then click the annotation to open it.

  3. Update the text (maximum of 255 characters) or timestamp, and then click Save Annotation.

View or hide annotations

By default, annotations are visible. Select or clear the Show Annotations option to hide or show annotations.

  1. In the navigation menu on the left, select Boards (Dashboards).

    {{< nav-icon "dashboards" >}}

  2. Open a dashboard with annotations:

    • To hide annotations, click the Annotations button. The button is gray when annotations are hidden.
    • To show annotations, click the Annotations button. The button is purple when annotations are visible.

Delete an annotation

  1. In the navigation menu on the left, select Boards (Dashboards).

    {{< nav-icon "dashboards" >}}

  2. Open a dashboard with the annotation to delete, click the dotted annotation line, and then click Delete Annotation.