Skip to content

Commit e2c4880

Browse files
authored
docs: Clarify the effects of auto-suspension
1 parent 87b83be commit e2c4880

File tree

2 files changed

+41
-12
lines changed

2 files changed

+41
-12
lines changed

docs/docs-new/pages/product/deployment/cloud/auto-suspension.mdx

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,18 @@ Auto-suspension is available in Cube Cloud on
1212

1313
</SuccessBox>
1414

15-
Cube Cloud can automatically suspend deployments when not in use to prevent
16-
[resource consumption][ref-deployment-pricing] when infrastructure is not being
17-
actively used, which helps manage spend and preventing unnecessary quota use.
15+
Cube Cloud can automatically suspend deployments when not in use to reduce
16+
[resource consumption][ref-deployment-pricing], which helps manage your spend.
1817

19-
This is useful for deployments that are not used 24/7, such as staging
20-
deployments. Auto-suspension will hibernate the deployment when **no** API
18+
<WarningBox>
19+
20+
Auto-suspension is useful for deployments that are not used 24/7, such as
21+
staging deployments. However, **auto-suspension shall not be used for production
22+
deployments**. See [effects on experience][self-effects] for details.
23+
24+
</WarningBox>
25+
26+
Auto-suspension will hibernate the deployment when **no** API
2127
requests are received after a period of time, and automatically resume the
2228
deployment when API requests start coming in again:
2329

@@ -38,6 +44,25 @@ During auto-suspension, resources are monitored in 5 minute intervals. This
3844
means that if a deployment was suspended 4 minutes ago, and a request comes in,
3945
the deployment will resume immediately and 5 minute of CCU usage will be billed.
4046

47+
## Effects on experience
48+
49+
If auto-suspension is enabled, the behavior of your Cube Cloud deployment will
50+
experience some notable changes.
51+
52+
When a deployment is auto-suspended:
53+
54+
- [Data model][ref-data-model] compilation artifacts are discarded since the
55+
API instances are de-provisioned.
56+
- [Monitoring integrations][ref-monitoring] are also suspended, which prevents
57+
the export of metrics and logs.
58+
59+
When a deployment is resumed from auto-suspension:
60+
61+
- [Data model][ref-data-model] compilation would need to be done from scratch.
62+
It applies to all tenants in case [multitenancy][ref-multitenancy] is set up.
63+
Consequently, one or more queries served after a deployment is resumed from
64+
auto-suspension are likely to have suboptimal performance.
65+
4166
## Configuration
4267

4368
To configure auto-suspension settings, navigate to the <Btn>Settings</Btn>
@@ -94,3 +119,7 @@ response times to be significantly longer than usual.
94119
/product/deployment/cloud/deployment-types#production-multi-cluster
95120
[ref-deployment-pricing]: /product/deployment/cloud/pricing
96121
[ref-workspace-dev-api]: /product/workspace/dev-mode
122+
[ref-monitoring]: /product/monitoring/integrations
123+
[ref-data-model]: /product/data-modeling/overview
124+
[ref-multitenancy]: /product/configuration/advanced/multitenancy
125+
[self-effects]: #effects-on-experience

docs/docs-new/pages/product/monitoring/integrations.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ deployments.
2525

2626
</InfoBox>
2727

28+
<WarningBox>
29+
30+
Monitoring integrations suspend their work when a deployment goes to [auto-suspension][ref-autosuspend].
31+
32+
</WarningBox>
33+
2834
Under the hood, Cube Cloud uses [Vector][vector], an open-source tool for
2935
collecting and delivering monitoring data. It supports a [wide range of
3036
destinations][vector-docs-sinks], also known as _sinks_.
@@ -243,13 +249,7 @@ You can also customize the user name and password for `prometheus_exporter` by
243249
setting `CUBE_CLOUD_MONITORING_METRICS_USER` and
244250
`CUBE_CLOUD_MONITORING_METRICS_PASSWORD` environment variables, respectively.
245251

246-
## Auto-suspend behavior
247-
248-
If [auto-suspension][ref-deploy-autosuspend] is enabled for a deployment with
249-
configured monitoring integrations, then the integrations will also be
250-
suspended, which prevents the export of metrics and logs.
251-
252-
[ref-deploy-autosuspend]: /product/deployment/cloud/auto-suspension
252+
[ref-autosuspend]: /product/deployment/cloud/auto-suspension#effects-on-experience
253253
[self-sinks-for-metrics]: #configuration-sinks-for-metrics
254254
[ref-vpc]: /product/configuration/vpc
255255
[vector]: https://vector.dev/

0 commit comments

Comments
 (0)