Skip to content

Commit 1a494a2

Browse files
authored
docs: Document limits, incl. for Query History (#6690)
* docs: Document limits, incl. for Query History * Better wording
1 parent 054d97c commit 1a494a2

File tree

2 files changed

+84
-21
lines changed

2 files changed

+84
-21
lines changed

docs/content/Deployment/Cloud/Deployment-Types.mdx

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ query pre-aggregations on-demand.
3333
Development Instances do not provide high-availability nor do they guarantee
3434
fast response times. Development Instances also hibernate after 60 minutes of
3535
inactivity, which can cause the first request after hibernation to take
36-
additional time to process. They also have a 10,000 queries per day limit, and
37-
are limited to a maximum of 2 Cube Store Workers. We **strongly** advise not
38-
using a development instance in a production environment, it is for testing and
39-
learning about Cube only and will not deliver a production-level experience for
40-
your users.
36+
additional time to process. They also have [limits][ref-limits] on the maximum
37+
number of queries per day and the maximum number of Cube Store Workers. We
38+
**strongly** advise not using a development instance in a production environment,
39+
it is for testing and learning about Cube only and will not deliver a
40+
production-level experience for your users.
4141

4242
You can try a Cube Cloud development instance by
4343
[signing up for Cube Cloud](https://cubecloud.dev/auth/signup) to try it free
@@ -66,7 +66,7 @@ workloads. It consists of several key components, including starting with 2 Cube
6666
API instances, 1 Cube Refresh Worker and 2 Cube Store Routers - all of which run
6767
on dedicated infrastructure. The cluster can automatically scale to meet the
6868
needs of your workload by adding more components as necessary; check the
69-
[Limits section](#limits) below.
69+
[Scalability section](#scalability) below.
7070

7171
## Production multi-cluster
7272

@@ -97,24 +97,20 @@ Cube Cloud routes traffic between clusters based on
9797
Each cluster is billed separately, and all clusters can use auto-scaling to
9898
match demand.
9999

100-
## Limits
100+
## Scalability
101101

102102
Cube Cloud also allows adding additional infrastructure to your deployment to
103103
increase scalability and performance beyond what is available with each
104104
Production Deployment.
105105

106-
### <--{"id" : "Limits"}--> Cube Store Worker
107-
108-
| | Free Tier | Starter | Premium | Enterprise | Enterprise Premier |
109-
| ------------------------- | :-------: | :-----: | :-----: | :--------: | :------------------------------: |
110-
| Maximum number of workers | 2 | 16 | 16 | 16 | [Talk to Sales][cube-contact-us] |
106+
### <--{"id" : "Scalability"}--> Cube Store Worker
111107

112108
Cube Store Workers are used to build and persist pre-aggregations. Each Worker
113-
has a **maximum of 150GB** of storage; additional Cube Store workers can be
109+
has a **maximum of 150GB** of storage; [additional Cube Store workers][ref-limits] can be
114110
added to your deployment to both increase storage space and improve
115111
pre-aggregation performance. A **minimum of 2** Cube Store Workers is required
116112
for pre-aggregations; this can be adjusted. For a rough estimate, it will take
117-
approximately 2 Cube Store Workers per 4 gigs of pre-aggregated data per day.
113+
approximately 2 Cube Store Workers per 4 GB of pre-aggregated data per day.
118114

119115
<InfoBox>
120116

@@ -135,14 +131,10 @@ dropdown:
135131
src="https://ucarecdn.com/3b39c56f-d553-4612-b4f0-07084cc4b742/"
136132
/>
137133

138-
### <--{"id" : "Limits"}--> Cube API Instance
139-
140-
| | Free Tier | Starter | Premium | Enterprise | Enterprise Premier |
141-
| --------------- | :-------: | :-----: | :-------: | :--------: | :----------------: |
142-
| Queries per day | 1,000 | 50,000 | Unlimited | Unlimited | Unlimited |
134+
### <--{"id" : "Scalability"}--> Cube API Instance
143135

144136
With a Production Deployment, 2 Cube API Instances are included. That said, it
145-
is very common to use more, and additional Cube API instances can be added to
137+
is very common to use more, and [additional API instances][ref-limits] can be added to
146138
your deployment to increase the throughput of your queries. A rough estimate is
147139
that 1 Cube API Instance is needed for every 5-10 requests-per-second served.
148140
Cube API Instances can also auto-scale as needed.
@@ -167,5 +159,5 @@ and select from the available options:
167159
src="https://ucarecdn.com/fbde6a1e-734a-4091-8edd-922dc1ee7e1c/"
168160
/>
169161

170-
[cube-contact-us]: https://cube.dev/contact
171162
[ref-conf-ref-ctx-to-app-id]: /config#options-reference-context-to-app-id
163+
[ref-limits]: /cloud/limits#resources
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Limits
3+
permalink: /cloud/limits
4+
category: Deployment
5+
subCategory: Cube Cloud
6+
menuOrder: 7
7+
---
8+
9+
Cube Cloud implements limits on resource usage on account and deployment
10+
levels to ensure the best experience for all Cube Cloud users.
11+
12+
<SuccessBox>
13+
14+
Limits apply to Cube Cloud accounts on [all tiers](https://cube.dev/pricing).
15+
16+
</SuccessBox>
17+
18+
## Limit types
19+
20+
Each limit can be of one of the following types:
21+
22+
- *Hard limit* either has a threshold that can't be exceeded or prevents
23+
further use of a resource when a threshhold is hit until a cool-down period
24+
passes (e.g., until the next day starts) or the limit is increased (e.g.,
25+
when a Cube Cloud account upgrades to another tier).
26+
- *Soft limit* may allow further use of a resource after a threshold is hit.
27+
28+
## Resources
29+
30+
The following resources are subject to limits, depending on [deployment types][ref-deployment-types] and
31+
[pricing tiers][ref-pricing]:
32+
33+
| Resource | Free Tier | Starter | Premium | Enterprise | Enterprise Premier |
34+
| --------------------------------------------------------------- | :-------: | :-------: | :-------: | :--------: | :---------------------------: |
35+
| Number of deployments | 2 | Unlimited | Unlimited | Unlimited | Unlimited |
36+
| Number of API instances | 1 | 20 | 20 | 20 | [Contact us][cube-contact-us] |
37+
| Number of Cube Store workers | 2 | 16 | 16 | 16 | [Contact us][cube-contact-us] |
38+
| Queries per day ([development instance][ref-dev-instance]) | 1,000 | 10,000 | Unlimited | Unlimited | Unlimited |
39+
| Queries per day ([production cluster][ref-prod-cluster]) || 50,000 | Unlimited | Unlimited | Unlimited |
40+
| Queries processed by [Query History][ref-query-history] per day | 1,000 | 50,000 | 100,000 | 200,000 | 300,000 |
41+
42+
### <--{"id" : "Resources"}--> Number of deployments
43+
44+
This is a hard limit. Consider upgrading to [another tier][ref-pricing].
45+
46+
### <--{"id" : "Resources"}--> Number of API instances
47+
48+
This is a hard limit. Consider upgrading to [another tier][ref-pricing].
49+
50+
### <--{"id" : "Resources"}--> Number of Cube Store workers
51+
52+
This is a hard limit. Consider upgrading to [another tier][ref-pricing].
53+
54+
### <--{"id" : "Resources"}--> Queries per day
55+
56+
This is a hard limit. When a threshold is hit, further queries will not be
57+
processed. In that case, consider upgrading a development instance to a
58+
production cluster. Alternatively, consider upgrading to
59+
[another tier][ref-pricing].
60+
61+
### <--{"id" : "Resources"}--> Queries processed by Query History per day
62+
63+
This is a soft limit. When a threshold is hit, query processing will be
64+
stopped. Please [contact support][cube-contact-us] for further assistance.
65+
66+
[ref-deployment-types]: /cloud/configuration/deployment-types
67+
[ref-pricing]: /cloud/pricing
68+
[ref-query-history]: /cloud/inspecting-queries
69+
[ref-dev-instance]: /cloud/configuration/deployment-types#development-instance
70+
[ref-prod-cluster]: /cloud/configuration/deployment-types#production-cluster
71+
[cube-contact-us]: https://cube.dev/contact

0 commit comments

Comments
 (0)