Skip to content

Commit 5fd846c

Browse files
authored
(DOCSP-30949): Document Atlas Billing Dashboards in Charts (#606)
* Document Charts Billing Dashboards * Apply feedback from demo * Updates Data Ingestion -> Ingestions * copy review feedback * Avinash's feedback
1 parent 4dbe981 commit 5fd846c

File tree

5 files changed

+153
-1
lines changed

5 files changed

+153
-1
lines changed

source/billing-dashboards.txt

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
.. _billing-dashboards:
2+
3+
====================================
4+
Create and Manage Billing Dashboards
5+
====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can visualize your |service| billing data in |charts| by
16+
creating a billing dashboard. Billing dashboards are
17+
:ref:`dashboards <dashboards>` with prebuilt charts that
18+
help you monitor your |service| usage. After you ingest your
19+
billing data, you can add a billing dashboard and customize
20+
it to suit your specific billing needs.
21+
22+
To learn more about how |service| bills your deployments,
23+
see :atlas:`Manage Billing </billing>`.
24+
25+
Billing Dashboards
26+
------------------
27+
28+
Billing dashboards provide metrics and detailed charts about the
29+
usage in your organization across different categories
30+
and periods of time. The insights from your dashboard
31+
can help you optimize your |service| spending.
32+
33+
.. figure:: /images/charts/atlas-billing-dashboard.png
34+
:figwidth: 750px
35+
:alt: Atlas Billing Dashboard example.
36+
37+
By default, billing dashboards include the following metrics
38+
and charts:
39+
40+
- Total spending across your organization
41+
- Biggest spenders in your organization
42+
- Total spending by instance size, project, cluster, product category, or SKU
43+
- Total cost by product category
44+
45+
Required Access
46+
---------------
47+
48+
To create a billing dashboard, you must have at least
49+
:authrole:`Project Data Access Read/Write` permissions.
50+
51+
Limitations
52+
-----------
53+
54+
At any given time, billing dashboards use
55+
the last twelve months of your organization's billing data.
56+
57+
If you change an existing invoice, |service| updates the
58+
billing data in your ingestion only if you've incurred
59+
the invoice within the last three months. Any invoice changes
60+
reflect in your dashboard after the next scheduled ingestion.
61+
62+
Create a Billing Dashboard
63+
--------------------------
64+
65+
To ingest your billing data and add a billing dashboard:
66+
67+
.. procedure::
68+
:style: normal
69+
70+
.. step:: In the left navigation menu, click :guilabel:`Ingestions`.
71+
72+
.. step:: In the :guilabel:`Atlas Billing` card, click :guilabel:`Add configuration`.
73+
74+
The :guilabel:`New Configuration` dialog box displays.
75+
76+
.. figure:: /images/charts/atlas-billing-ingestion-configuration.png
77+
:figwidth: 500px
78+
:alt: Configuration box for the Atlas Billing Ingestion.
79+
80+
.. step:: Configure the |service| Billing Ingestion.
81+
82+
a. Enter your :guilabel:`Organization public API key` and :guilabel:`Organization private API key`.
83+
84+
Your key pair must have at least :authrole:`Organization Billing Admin`
85+
and :authrole:`Organization Billing Viewer` access.
86+
87+
To learn how to create and view an API key for your organization,
88+
see :atlas:`Grant Programmatic Access to Atlas
89+
</configure-api-access/#grant-programmatic-access-to-service>`.
90+
91+
#. From the dropdown, select the :guilabel:`Target deployment` to
92+
store your billing data.
93+
#. (Optional) Change the :guilabel:`Database name`.
94+
95+
.. step:: Click :guilabel:`Save`.
96+
97+
|charts-short| uses the :oas-atlas-tag:`Invoices API </Invoices>`
98+
to ingest the last twelve months of your organization's billing
99+
data into the specified deployment and database. After you create
100+
the initial ingestion, |service| ingests billing data daily.
101+
102+
.. step:: In the :guilabel:`Atlas Billing` card, click :guilabel:`Add and Open`.
103+
104+
|charts-short| generates the billing dashboard and saves it to
105+
the :guilabel:`Dashboards` page. All dashboard and chart
106+
features, such as :ref:`dashboard filters <filter-dashboards>`
107+
and :ref:`interactive filtering <interact-with-charts>`, apply to
108+
billing dashboards and its prebuilt charts.
109+
110+
Manage |service| Billing Ingestions
111+
-----------------------------------
112+
113+
Edit an Ingestion
114+
~~~~~~~~~~~~~~~~~
115+
116+
To edit an existing billing ingestion:
117+
118+
.. procedure::
119+
:style: normal
120+
121+
.. step:: In the left navigation menu, click :guilabel:`Ingestions`.
122+
123+
.. step:: In the :guilabel:`Atlas Billing` card, click the :guilabel:`Ellipses (...)`, and then click :guilabel:`Edit Configuration`.
124+
125+
.. step:: Reconfigure your data ingestion information.
126+
127+
.. step:: Click :guilabel:`Save`.
128+
129+
Delete an Ingestion
130+
~~~~~~~~~~~~~~~~~~~
131+
132+
To delete an existing billing ingestion:
133+
134+
.. procedure::
135+
:style: normal
136+
137+
.. step:: In the left navigation menu, click :guilabel:`Ingestions`.
138+
139+
.. step:: In the :guilabel:`Atlas Billing` card, click the :guilabel:`Ellipses (...)`, and then click :guilabel:`Delete Configuration`.
140+
141+
.. step:: Click :guilabel:`Delete` to confirm your selection.

source/dashboards.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,14 @@ adjust these filters to modify the data that appears on your dashboard.
129129
To learn more about filtering dashboard data, see
130130
:ref:`dashboard-filtering`.
131131

132+
Add a Billing Dashboard
133+
-----------------------
134+
135+
You can add a billing dashboard in |charts-short|
136+
to visualize your |service| billing data. Billing dashboards
137+
contain prebuilt charts with insights into your |service|
138+
usage. To learn more, see :ref:`billing-dashboards`.
139+
132140
.. _refresh-dashboard-overview:
133141

134142
Refresh Dashboard Data
@@ -356,6 +364,7 @@ tasks:
356364
/manage-dashboards
357365
/dashboard-permissions
358366
/scheduled-reports
367+
/billing-dashboards
359368
/dashboard-refresh
360369
/dashboard-filtering
361370
/interact-with-charts
Loading
Loading

source/pricing.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ Charts on Atlas Pricing
1515
Overview
1616
--------
1717

18-
|charts-short| on |service| is metered based on the volume of data
18+
|charts| is metered based on the volume of data
1919
transferred from the |charts-short| web server to web browser clients.
2020
MongoDB provides each |charts-short| instance with a free ``1 GB`` of
2121
data transfers per month. You can view your |charts-short| instance's
2222
monthly data usage in the :ref:`Data Transfer <admin-usage>` page.
23+
To visualize your |charts-short| usage, you can create a
24+
:ref:`Billing Dashboard <billing-dashboards>`.
2325

2426
The free usage tier provides approximately 500,000 chart
2527
renders over a month. However, this number may vary based on the types

0 commit comments

Comments
 (0)