Skip to content

Commit bb7c4c6

Browse files
committed
[docs] Add how to guide for cloud costs per user dashboard
1 parent d103820 commit bb7c4c6

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Explore the *Cloud costs per user* Dashboard
2+
3+
![Grafana dashboard with multiple panels showing stacked bar charts of user cloud costs over time.](https://raw.githubusercontent.com/2i2c-org/jupyterhub-cost-monitoring/refs/heads/main/images/dashboard.png)
4+
5+
## Navigate to the *Cloud costs per user* dashboard
6+
7+
From the Grafana homepage, navigate to *Home > Dashboards > Cloud cost dashboards* and then click on *Cloud costs per user*.
8+
9+
This will load the dashboard, which may take a few moments to populate with data.
10+
11+
## Understand the dashboard layout
12+
13+
The dashboard is organized into several panels, each providing insights into different aspects of user cloud costs:
14+
15+
- **Top 5 Users**: a quick at a glance view of the top 5 users by total cost over the selected time range.
16+
- **Total by Hub**: a breakdown of total costs by hub, allowing you to see which hubs are incurring the most expenses.
17+
- **Total by Component**: a breakdown of total costs by component (such as compute, home storage, etc.), helping you identify which resources are driving costs.
18+
- **Hub**: individual panels for each hub, showing daily costs by users within that hub. User costs summed over all hubs is shown by default. Try toggling the variable `hub` at the top of the dashboard to see splits by individual hubs.
19+
- **Component**: individual panels showing daily costs by users for compute and home storage. You can also toggle the variable `component` at the top of the dashboard to show or hide panels.
20+
21+
## Interact with the dashboard
22+
23+
You can interact with the dashboard in several ways:
24+
25+
- **Time Range**: use the time range selector in the top right corner to adjust the period for which data is displayed. The last 30 days are shown by default. The timezone is always UTC, since daily cost data prepared by cloud providers is typically settled at 00:00 UTC.
26+
- **Variables**: use the dropdowns at the top of the dashboard to filter data by hub or component.
27+
- **Legend**: click on user names in the legend to isolate or hide specific users in the graphs. You can select multiple users by holding down the `Shift` key while clicking, and double-click to reset the selection.
28+
- **Tooltips**: hover over data points in the graphs to see detailed information, including exact cost values and timestamps of each user.
29+
30+
:::{tip}
31+
Some interactions may re-trigger additional queries to fetch data, so there may be a slight delay while the graph is updated.
32+
:::
33+
34+
## Export data
35+
36+
You can export the data from any panel by clicking on the panel menu in the top right corner, then selecting *Inspect > Data*. From there, you can view the raw data and export it in various formats, such as CSV or JSON.
37+
38+
## Resources
39+
40+
Grafana is a powerful open source data visualization tool with many features. For more information on how to use Grafana, refer to the [Grafana documentation](https://grafana.com/docs/grafana/latest/).
41+
42+
## Feedback and support
43+
44+
If you have any feedback or suggestions on what works well or how you would like to improve the dashboard design, [let us know](https://github.com/2i2c-org/jupyterhub-cost-monitoring/issues/new)!

admin/howto/monitoring/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ This section describes how to monitor the usage of your hub. Note that not all f
77
grafana-dashboards
88
prometheus-access
99
cost-attribution
10+
cost-users
1011
```

0 commit comments

Comments
 (0)