diff --git a/content/influxdb/cloud/visualize-data/annotations.md b/content/influxdb/cloud/visualize-data/annotations.md new file mode 100644 index 000000000..97d4c7651 --- /dev/null +++ b/content/influxdb/cloud/visualize-data/annotations.md @@ -0,0 +1,71 @@ +--- +title: Use annotations in dashboards +description: > + Add annotations to your InfluxDB dashboards to provide useful, contextual information about single points in time. +influxdb/cloud/tags: [labels, annotations] +menu: + influxdb_cloud: + name: Use annotations + parent: Visualize data +weight: 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. + +- [Create an annotation](#create-an-annotation) +- [Edit an annotation](#edit-an-annotation) +- [View or hide annotations](#view-or-hide-annotations) +- [Delete an annotation](#delete-an-annotation) + +{{% note %}} +Annotations may be useful to highlight operations or anomalies for your team to reference. +{{% /note %}} + +{{< youtube 5NEplCesNAc >}} + +## 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](/influxdb/cloud/visualize-data/dashboards/create-dashboard/). +3. Click **Annotations**. The **Show Annotations** option is selected by default. +4. Select the **Enable 1-Click Annotations** option, and then in any dashboard cell, click the point in time to add the annotation. + {{% note %}} +**Tip:** To move the annotation outside of the selected graph time range, first create the annotation, and then [edit the annotation](#edit-an-annotation) to update the timestamp as needed. + {{% /note %}} +5. 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, click **Annotations**, and then do one of the following: + - To hide annotations, clear the **Show Annotations** option. + - To show annotations, select the **Show Annotations** option. + +## 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**. diff --git a/content/influxdb/cloud/visualize-data/dashboards/control-dashboard.md b/content/influxdb/cloud/visualize-data/dashboards/control-dashboard.md index 635bb6792..1c4762111 100644 --- a/content/influxdb/cloud/visualize-data/dashboards/control-dashboard.md +++ b/content/influxdb/cloud/visualize-data/dashboards/control-dashboard.md @@ -10,8 +10,6 @@ menu: weight: 203 --- -## Control at the dashboard level - Use dashboard controls in the upper left to update your dashboard. ### Add a cell diff --git a/content/influxdb/cloud/visualize-data/dashboards/create-dashboard.md b/content/influxdb/cloud/visualize-data/dashboards/create-dashboard.md index b3ddb0500..7acb2bdcf 100644 --- a/content/influxdb/cloud/visualize-data/dashboards/create-dashboard.md +++ b/content/influxdb/cloud/visualize-data/dashboards/create-dashboard.md @@ -12,7 +12,6 @@ menu: weight: 201 --- -## Create a new dashboard 1. In the navigation menu on the left, select **Boards** (**Dashboards**). @@ -21,7 +20,6 @@ weight: 201 2. Click the **{{< icon "plus" >}} Create Dashboard** menu in the upper right and select **New Dashboard**. 3. Enter a name for your dashboard in the **Name this dashboard** field in the upper left. - **To import an existing dashboard**: 1. In the navigation menu on the left, select **Boards** (**Dashboards**). @@ -30,8 +28,10 @@ weight: 201 2. Click the **Create Dashboard** menu in the upper right and select **Import Dashboard**. 3. In the window that appears: - * Select **Upload File** to drag-and-drop or select a file. - * Select **Paste JSON** to paste in JSON. + + - Select **Upload File** to drag-and-drop or select a file. + - Select **Paste JSON** to paste in JSON. + 4. Click **Import JSON as Dashboard**. ## Create dashboards with templates @@ -54,8 +54,8 @@ weight: 201 2. Select the **Templates** tab. - - In the **Static Templates** tab, a list of pre-created templates appears. - - In the **User Templates** tab, a list of custom user-created templates appears. + - In the **Static Templates** tab, a list of pre-created templates appears. + - In the **User Templates** tab, a list of custom user-created templates appears. 3. Hover over the name of the template you want to create a dashboard from, then click **Create**. diff --git a/content/influxdb/v2.0/query-data/flux/sql.md b/content/influxdb/v2.0/query-data/flux/sql.md index aee0eb8dc..740a0ca77 100644 --- a/content/influxdb/v2.0/query-data/flux/sql.md +++ b/content/influxdb/v2.0/query-data/flux/sql.md @@ -391,4 +391,4 @@ Download and import the Air Sensors dashboard to visualize the generated data: Download Air Sensors dashboard -_For information about importing a dashboard, see [Create a dashboard](/influxdb/v2.0/visualize-data/dashboards/create-dashboard/#create-a-new-dashboard)._ +_For information about importing a dashboard, see [Create a dashboard](/influxdb/v2.0/visualize-data/dashboards/create-dashboard)._