Add annotations documentation #32392
Open
+44
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evazorro
commented
Oct 24, 2025
|
|
||
| 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.
I'd like to add a screenshot -- @amymzhou, what would be a few good example metrics to show?
Preview links (active after the
|
estherk15
approved these changes
Oct 24, 2025
| identifier: dashboards_overlays | ||
| - name: Annotations | ||
| url: dashboards/annotations/ | ||
| parent: dashboards |
There was a problem hiding this comment.
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 |
|
|
||
| 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.
Suggested change
| - Clicking the X axis on a timeseries | |
| - Clicking the X-axis on a timeseries graph |
| - 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 | ||
| 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.
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. |
| 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.
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. |
|
|
||
| ## 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.
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**. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Adds a guide to the new annotations feature for timeseries widgets, including creation, bulk creation, editing, and deletion.
Merge instructions
I'd like to add a screenshot before merge (see comment inline)
Merge readiness:
Additional notes