Skip to content

Commit 23ba30a

Browse files
CRP-1752: Document notebook dataset scheduled reports (#32908)
* Add docs for scheduled reports * Remove extra line item * Add more details, images * Lint * Remove PII from example screenshot * CR: Rephrase Co-authored-by: domalessi <[email protected]> * CR: Rephrase Co-authored-by: domalessi <[email protected]> * CR: Rephrase Co-authored-by: domalessi <[email protected]> * Apply suggestions from code review Co-authored-by: domalessi <[email protected]> * Apply suggestions from code review Co-authored-by: domalessi <[email protected]> * Apply suggestions from code review Co-authored-by: domalessi <[email protected]> * Fix numbering * Remove duplicate image * copy tweaking and image update --------- Co-authored-by: domalessi <[email protected]> Co-authored-by: Dominique Alessi <[email protected]>
1 parent 671ff80 commit 23ba30a

File tree

11 files changed

+44
-0
lines changed

11 files changed

+44
-0
lines changed

content/en/notebooks/advanced_analysis/_index.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,49 @@ To download your dataset as a CSV file:
151151
3. Select the number of rows you want to export (up to the maximum available).
152152
4. The CSV file automatically downloads to your computer.
153153

154+
### Schedule a CSV report
155+
156+
With scheduled reports, you can automatically receive query results from notebook analysis cells by email or Slack.
157+
158+
To schedule a report on an analysis cell:
159+
160+
1. Open the dropdown next to **Save to Dashboard** and select **Schedule report**.
161+
162+
{{< img src="/notebooks/analysis_features/schedule_report_from_cell_v2.png" alt="Dropdown menu showing the Schedule report option highlighted" style="width:50%;" >}}
163+
164+
2. In the modal, select a schedule to configure when and how often the report is sent.
165+
166+
{{< img src="/notebooks/analysis_features/select_schedule.png" alt="Schedule selection step in the report configuration modal" style="width:80%;" >}}
167+
168+
3. Enter a report name and select a time frame to define the data included in the report.
169+
170+
**Note**: If the analysis cell has not yet been published as a dataset, you can specify the name of the dataset created when the report is scheduled.
171+
172+
4. Add email recipients.
173+
- The email associated with your Datadog account is included automatically. To remove it, hover over your email and click the trash icon.
174+
- To preview the report before saving the schedule, click **Send Test Email**.
175+
176+
**Note**: Only Enterprise and Pro accounts can send reports to email addresses that aren't associated with registered Datadog users.
177+
178+
Example report email:
179+
{{< img src="/notebooks/analysis_features/report_email.png" alt="Example report email" style="width:90%;" >}}
180+
181+
5. Add Slack recipients.
182+
- Click on the **Slack** tab, then choose a workspace and channel.
183+
- If no workspaces appear, verify that the Datadog [Slack Integration][6] is installed.
184+
- Public channels are listed automatically. To send to a private channel, invite the Datadog Slack bot to your channel.
185+
- To preview the message, add a channel and click **Send Test Message.**
186+
187+
{{< img src="/notebooks/analysis_features/add_slack_recipients.png" alt="Slack recipient selection in the report scheduling modal" style="width:100%;" >}}
188+
189+
6. Save your schedule.
190+
191+
You can view, search, edit, and delete existing report schedules from the **Reports** tab:
192+
193+
{{< img src="/notebooks/analysis_features/reports_page.png" alt="Filtered view of the Reports tab" style="width:90%;" >}}
194+
195+
**Note**: To schedule reports and view other users' schedules, users need the **CSV Report Schedules Write** permission. To edit other users' schedules, users need the **CSV Report Schedules Manage** permission. These permissions can be granted by a user with the **Org Management** permission.
196+
154197
## Further reading
155198

156199
{{< partial name="whats-next/whats-next.html" >}}
@@ -160,3 +203,4 @@ To download your dataset as a CSV file:
160203
[3]: /logs/explorer/calculated_fields/formulas/
161204
[4]: /ddsql_reference/
162205
[5]: https://www.datadoghq.com/product-preview/additional-advanced-querying-data-sources/
206+
[6]: /integrations/slack/?tab=datadogforslack
176 KB
Loading
229 KB
Loading
197 KB
Loading
100 KB
Loading
180 KB
Loading
354 KB
Loading
485 KB
Loading
123 KB
Loading
221 KB
Loading

0 commit comments

Comments
 (0)