Skip to content

Commit 95f01ee

Browse files
authored
First draft (#7539)
1 parent cf6d124 commit 95f01ee

File tree

2 files changed

+86
-1
lines changed

2 files changed

+86
-1
lines changed
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
module.exports = {
22
"playground": "Playground",
33
"data-model": "Data Model",
4+
"dev-mode": "Development mode",
45
"semantic-layer-sync": "Semantic Layer Sync",
56
"sql-runner": "SQL Runner",
67
"query-history": "Query History",
78
"pre-aggregations": "Pre-Aggregations",
9+
"performance": "Performance Insights",
810
"access-control": "Access Control",
911
"budgets": "Budgets",
1012
"sso": "Single Sign-On",
11-
"dev-mode": "Development mode",
1213
"preferences": "Preferences",
1314
"cli": "CLI"
1415
}
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Performance Insights
2+
3+
<WarningBox>
4+
5+
This page is work-in-progress.
6+
7+
</WarningBox>
8+
9+
The&nbsp;<Btn>Performance</Btn> page in Cube Cloud displays charts that help
10+
analyze the performance of your deployment and fine-tune its configuration.
11+
It's recommended to review Performance Insights when the workload changes
12+
or if you face any performance-related issues with your deployment.
13+
14+
<SuccessBox>
15+
16+
Performance Insights are available in Cube Cloud on
17+
[all tiers](https://cube.dev/pricing).
18+
19+
</SuccessBox>
20+
21+
## Charts
22+
23+
Charts provide insights into different aspects of your deployment.
24+
25+
### API instances
26+
27+
The&nbsp;<Btn>API instances</Btn> chart shows the number of API instances
28+
that served queries to the deployment over time.
29+
30+
{/* TODO: Add screenshot */}
31+
32+
You can use this chart to fine-tune the auto-scaling configuration of API
33+
instances, e.g., increase the minimum and maximum number of API instances.
34+
35+
Also, you can use this chart to fine-tune the auto-suspension configuration,
36+
e.g., by turning auto-suspension off or increasing the auto-suspension
37+
threshold.
38+
39+
### Data sources
40+
41+
The&nbsp;<Btn>Requests by data source</Btn> chart shows the number of API
42+
requests that were fulfilled by using cache or querying the upstream data
43+
source over time. The&nbsp;<Btn>Avg. response time by data source</Btn>
44+
shows the difference in the response time for
45+
requests that hit the cache or go to the upstream data source.
46+
47+
{/* TODO: Add screenshot (x2) */}
48+
49+
You can use these charts to see if you'd like to have more queries that hit
50+
the cache and have lower response time. In that case, consider adding more
51+
pre-aggregations in Cube Store or fine-tune the existing ones.
52+
53+
### Data model compilation
54+
55+
The&nbsp;<Btn>Requests by data model compilation</Btn> chart shows the
56+
number of API requests that had or had not to wait for the data model
57+
compilation. The&nbsp;<Btn>Wait time for data model compilation</Btn> chart
58+
shows the total time requests had to wait for the data model compilation.
59+
60+
{/* TODO: Add screenshot */}
61+
62+
You can use these charts to identify multitenancy misconfiguration,
63+
fine-tune the auto-suspension configuration, or consider using a
64+
multi-cluster deployment.
65+
66+
### Cube Store
67+
68+
The&nbsp;<Btn>Saturation for queries by Cube Store workers</Btn> chart
69+
shows if Cube Store workers are overloaded with serving **queries**. High
70+
saturation for queries prevents Cube Store workers from fulfilling requests
71+
and results in wait time displayed at the&nbsp;<Btn>Wait time for queries
72+
by Cube Store workers</Btn> chart.
73+
74+
{/* TODO: Add screenshot */}
75+
76+
Similarly, the&nbsp;<Btn>Saturation for jobs by Cube Store workers</Btn>
77+
and <Btn>Wait time for jobs by Cube Store workers</Btn> charts show if
78+
Cube Store Workers are overloaded with serving **jobs**, i.e., building
79+
pre-aggregations or performing internal tasks such as data compaction.
80+
81+
{/* TODO: Add screenshot */}
82+
83+
You can use these charts to consider fine-tuning the number of Cube Store
84+
workers used by your deployment.

0 commit comments

Comments
 (0)