-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add annotations documentation #32392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 --> | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is just my preference, optional suggestion
Suggested change
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| 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**. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| <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**. | ||||||
There was a problem hiding this comment.
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!