Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1619,6 +1619,11 @@ menu:
parent: dashboards
weight: 9
identifier: dashboards_overlays
- name: Annotations
url: dashboards/annotations/
parent: dashboards
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want this to be a child of Overlays, you just need to change the parent identifier. If you want this to be the same level as Overlays, then the weight needs to be 10 (and then the following menu items weights need to be adjusted). Hope that helps, let me know if you have any questions!

Suggested change
parent: dashboards
parent: dashboards_overlays

weight: 901
identifier: dashboards_annotations
- name: Sharing
identifier: dashboards_sharing
url: dashboards/sharing/
Expand Down
41 changes: 41 additions & 0 deletions content/en/dashboards/annotations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
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.

<!-- screenshot -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to add a screenshot -- @amymzhou, what would be a few good example metrics to show?


## 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Clicking the X axis on a timeseries
- Clicking the X-axis on a timeseries graph

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just my preference, optional suggestion

Suggested change
4. Optionally change the color of the annotation from the dropdown in the bottom left.
4. (Optional) 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Follow steps 1–4 [above](#adding-an-annotation) to start creating an annotation.
2. Follow steps 1-4 in [Adding an annotation](#adding-an-annotation) to create 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**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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**.
To edit an annotation, hover over the annotation line, click the three dots menu, and choose **Edit** or **Edit for all widgets**.


<div class="alert alert-info">You can't .</a></div>

## 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**.
Loading