-
Couldn't load subscription status.
- 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
Conversation
|
|
||
| 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 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?
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.
Here's a Org 2 link you can use! https://app.datadoghq.com/notebook/12907421/annotations-demo
The data is "real", but the chart title and annotation text is fake, so it's ok to show on our public docs site
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.
It's currently in a notebook, but you can copy it to a dashboard too if you prefer a screenshot of a dashboard widget
Preview links (active after the
|
Co-authored-by: Esther Kim <[email protected]>
|
|
||
| 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). |
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.
@evazorro I feel like Step 1 is misleading, since people would create an annotation (Steps 1-4 in adding an annotation), then use the dropdown to select if they want to add it to more than one widget. Because of that, I feel like we can remove Step 1 "Select the widgets you want to..." altogether.
But maybe we can expand a bit more on Step 3 "Choose All widgets or selected 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.
Definitely happy to remove that step! I was trying to account for the "apply to selected widgets" case assuming that you'd need to select the widgets ahead of time. But now that I'm trying it again, I see that you can check/uncheck widgets in the list after choosing that option. I'll revise!
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.
LGTM
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)doneMerge readiness:
Additional notes