Skip to content

Commit ecc3bba

Browse files
ashleyyiprtrieuvjfridge
authored
[CCA-1071] ccm report schedules docs (#31148)
All required checks have passed and has docs approval. * introduce ccm report schedules docs * fix vale warnings * fix links * add screenshot * replace images * Apply suggestions from code review Co-authored-by: Rosa Trieu <[email protected]> * commit cdocs gitignore * address pr comments * readd images * add link to dashboards reports * Update content/en/cloud_cost_management/reports/_index.md * link fix and image tweaks * Apply suggestions from code review Co-authored-by: Vickie Boettcher <[email protected]> * image updates * delete unused image * shorten image * update share button screenshot --------- Co-authored-by: Rosa Trieu <[email protected]> Co-authored-by: Rosa Trieu <[email protected]> Co-authored-by: Vickie Boettcher <[email protected]>
1 parent 38d91f6 commit ecc3bba

File tree

10 files changed

+108
-0
lines changed

10 files changed

+108
-0
lines changed

config/_default/menus/main.en.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3678,6 +3678,11 @@ menu:
36783678
parent: cloud_cost
36793679
identifier: cloud_cost_reports
36803680
weight: 9
3681+
- name: Scheduled Cost Reports
3682+
url: /cloud_cost_management/reports/scheduled_reports
3683+
parent: cloud_cost_reports
3684+
identifier: cloud_cost_scheduled_reports
3685+
weight: 901
36813686
- name: Recommendations
36823687
url: cloud_cost_management/recommendations
36833688
parent: cloud_cost

content/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
11

2+
# This file lists compiled Cdocs files to keep them out of version control. For more information, see the internal Cdocs documentation: https://datadoghq.atlassian.net/wiki/spaces/docs4docs/pages/4898063037/Cdocs+Build
3+
4+
# For the list of files to ignore in the documentation repo, see the version in the root of the documentation repository: https://github.com/DataDog/documentation/blob/master/.gitignore
5+
6+
7+
# This file lists compiled Cdocs files to keep them out of version control. For more information, see the internal Cdocs documentation: https://datadoghq.atlassian.net/wiki/spaces/docs4docs/pages/4898063037/Cdocs+Build
8+
9+
# For the list of files to ignore in the documentation repo, see the version in the root of the documentation repository: https://github.com/DataDog/documentation/blob/master/.gitignore
10+
11+
12+
# This file lists compiled Cdocs files to keep them out of version control. For more information, see the internal Cdocs documentation: https://datadoghq.atlassian.net/wiki/spaces/docs4docs/pages/4898063037/Cdocs+Build
13+
14+
# For the list of files to ignore in the documentation repo, see the version in the root of the documentation repository: https://github.com/DataDog/documentation/blob/master/.gitignore
15+
16+
17+
# This file lists compiled Cdocs files to keep them out of version control. For more information, see the internal Cdocs documentation: https://datadoghq.atlassian.net/wiki/spaces/docs4docs/pages/4898063037/Cdocs+Build
18+
19+
# For the list of files to ignore in the documentation repo, see the version in the root of the documentation repository: https://github.com/DataDog/documentation/blob/master/.gitignore
20+
21+
222
/en/product_analytics/session_replay/mobile/setup_and_configuration.md
323
/en/real_user_monitoring/guide/proxy-mobile-rum-data.md
424
/en/real_user_monitoring/guide/proxy-rum-data.md

content/en/cloud_cost_management/reports.md renamed to content/en/cloud_cost_management/reports/_index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: Reports
33
private: true
44
description: Track your organization spending with Cloud Cost Management Reports.
55
further_reading:
6+
- link: "/cloud_cost_management/reports/scheduled_reports"
7+
tag: "Documentation"
8+
text: "Scheduled cost reports"
69
- link: "/cloud_cost_management/"
710
tag: "Documentation"
811
text: "Learn about Cloud Cost Management"
@@ -84,6 +87,10 @@ Use filters to include only the specific costs you want to allocate, such as by
8487
1. Share the report by copying the URL or exporting the view to CSV or PNG.
8588
1. Search for saved reports as needed.
8689

90+
## Further reading
91+
92+
{{< partial name="whats-next/whats-next.html" >}}
93+
8794
[1]: /cloud_cost_management/aws/
8895
[2]: /cloud_cost_management/azure/?tab=billingaccounts
8996
[3]: /cloud_cost_management/google_cloud/
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Scheduled Cost Reports
3+
further_reading:
4+
- link: "/cloud_cost_management/"
5+
tag: "Documentation"
6+
text: "Learn about Cloud Cost Management"
7+
- link: "/dashboards/sharing/scheduled_reports"
8+
tag: "Documentation"
9+
text: "Learn about scheduled dashboard reports"
10+
---
11+
12+
## Overview
13+
Scheduled Cloud Cost (CCM) Reports let you automatically receive recurring cost reports through email or Slack. This feature supports finance, engineering, and executive stakeholders by delivering periodic snapshots of cost metrics, without needing to log into the Datadog platform. Reports are sent as PDFs to your chosen Slack channels or email addresses.
14+
15+
{{< img src="cloud_cost/cost_reports/cloud-cost-scheduled-report-1.png" alt="Schedule Cost Report." style="width:80%;" >}}
16+
17+
Below is an example of a report sent to a Slack channel.
18+
19+
{{< img src="cloud_cost/cost_reports/cost-report-slack-1.png" alt="A report that has been sent to a Slack channel based on a schedule" style="width:70%;" >}}
20+
21+
For emails, the report PDF is included as an email attachment and/or as a link, depending on its size.
22+
23+
{{< img src="cloud_cost/cost_reports/cost-report-email.png" alt="A report that has been sent as an email based on a schedule" style="width:70%;" >}}
24+
25+
## Schedule a cost report
26+
1. Go to [**Cloud Cost > Analyze > Reports**][1] in Datadog.
27+
2. [Create a report][2] or select an existing report.
28+
3. Click **Share**, then **Schedule Report**.
29+
{{< img src="cloud_cost/cost_reports/share_scheduled_report-1.png" alt="Click the Share button and Schedule Report on an individual report page." style="width:90%;" >}}
30+
31+
4. In the configuration modal that opens:
32+
- Set your schedule (when and how often the report should be sent)
33+
- Enter a title for your schedule
34+
5. Add recipients:
35+
- **Email recipients**: Enter email addresses. Your Datadog account is automatically added, but you can remove it by hovering over it and clicking the trash icon.
36+
37+
**Note:** Enterprise and Pro accounts can send reports to recipients outside of their organizations. You can control which email domains are able to receive reports by configuring your [domain allowlist][4].
38+
39+
- **Slack recipients**: Select your Slack workspace and channel from the dropdowns. If no workspaces appear, make sure you have the Datadog [Slack Integration][2] installed. All public channels within the Slack workspace are listed automatically. For private channels, invite the Datadog Slack bot first. You can test the connection by clicking the **Send Test Message** button.
40+
41+
## Managing schedules
42+
A single Cloud Cost (CCM) Report can have multiple schedules with different settings, allowing you to inform different stakeholder groups interested in the same cost data. To view existing schedules, click **Share** and select **Manage Schedules**.
43+
44+
From the configuration modal that opens, you can:
45+
- Pause existing schedules
46+
- Create new schedules
47+
- Edit schedule details
48+
- Delete schedules
49+
50+
{{< img src="cloud_cost/cost_reports/manage-cost-report-schedules-2.png" alt="Manage a Cost Report's Schedule." style="width:70%;" >}}
51+
52+
## Viewing schedules
53+
54+
To see all Cloud Cost (CCM) Report schedules across your organization:
55+
1. Navigate to [**Cloud Cost > Analyze > Reports**][1] and click the **Report Schedules** tab.
56+
2. Use the "My schedules" toggle to switch between your personal schedules and all organization schedules.
57+
58+
{{< img src="cloud_cost/cost_reports/cost-report-schedules-view-4.png" alt="View all Cost Report Schedules." style="width:100%;" >}}
59+
60+
## Permissions
61+
| Action | Required Permission |
62+
|--------|----------|
63+
| View schedules | Cloud Cost Report Schedules Write OR Cloud Cost Report Schedules Manage |
64+
| Create/modify your schedules | Cloud Cost Report Schedules Write OR Cloud Cost Report Schedules Manage |
65+
| Modify others' schedules | Cloud Cost Report Schedules Manage |
66+
67+
After a report is created, you can subscribe, unsubscribe, edit schedules, and delete reports (assuming you have the appropriate permissions). **Note:** Only Datadog users can unsubscribe directly from the email. External recipients (including group email addresses) must contact the report schedule owner to unsubscribe, as Datadog cannot distinguish between group emails and individual external emails.
68+
69+
## Further reading
70+
71+
{{< partial name="whats-next/whats-next.html" >}}
72+
73+
[1]: https://app.datadoghq.com/cost/analyze/reports
74+
[2]: /cloud_cost_management/reports
75+
[3]: /integrations/slack/?tab=datadogforslack
76+
[4]: /account_management/org_settings/domain_allowlist/
218 KB
Loading
126 KB
Loading
274 KB
Loading
132 KB
Loading
114 KB
Loading
103 KB
Loading

0 commit comments

Comments
 (0)