Skip to content

Commit 98b24ee

Browse files
committed
add cache docs
1 parent 8afbbd9 commit 98b24ee

File tree

3 files changed

+55
-1
lines changed

3 files changed

+55
-1
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Configuring caches
3+
description: Configure your query caches to optimize performance and reduce costs.
4+
icon: hard-drive
5+
---
6+
7+
If you're hitting cache expiration issues or want to optimize your query performance, you can configure the cache settings for your workspace. This allows you to set how long queries are cached and how many queries are stored in the cache.
8+
9+
<Note>
10+
This feature is only available on Briefer's enterprise plan.
11+
</Note>
12+
13+
## Cache Mechanism Configuration Variables
14+
15+
These variables allow you to configure the cache mechanism for your workspace.
16+
17+
### `QUERIES_CACHE_EXPIRATION_TIME`
18+
19+
- **Default Value**: `7d` (7 days)
20+
- Defines the expiration time for cached files.
21+
- Accepts human-readable values such as `1d`, `1h`, `1m`, and `1s`.
22+
- If an integer is provided, it is interpreted as milliseconds.
23+
24+
### `QUERIES_CACHE_MIN_FREE_SPACE_GB`
25+
26+
- **Default Value**: `1` (1 GB)
27+
- Specifies the minimum free disk space (in GB) required.
28+
- The cache eviction mechanism is triggered only when free space falls below this threshold.
29+
30+
## Prometheus Metrics
31+
32+
If you have Prometheus monitoring enabled, you can track the cache performance and disk usage metrics for your workspace.
33+
34+
The following metrics are exported to Prometheus:
35+
36+
- `jupyter_disk_usage_percentage`
37+
- `jupyter_free_space_gib`
38+
- `jupyter_volume_resize_operations`
39+
- `jupyter_cleanup_duration_seconds`
40+
- `jupyter_space_freed_bytes`
41+
- `jupyter_files_evicted_total`
42+
43+
The `jupyter_files_evicted_total` metric includes a label called `evictionType`, which can have the following values:
44+
45+
- `normal`: files removed due to natural cache expiration
46+
- `forced`: files removed forcibly due to insufficient disk space

docs/introduction.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,11 @@ We recommend that you either sign-up for the cloud or deploy it yourself. That w
198198
>
199199
Customize the appearance of your workspace to match your brand.
200200
</Card>
201+
<Card
202+
title="Configuring caches"
203+
icon="hard-drive"
204+
href="./enterprise/configuring-caches"
205+
>
206+
Configure your query caches to optimize performance and reduce costs.
207+
</Card>
201208
</CardGroup>

docs/mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@
100100
"enterprise/datasource-identities",
101101
"enterprise/granular-permissions",
102102
"enterprise/private-ai",
103-
"enterprise/customize-appearance"
103+
"enterprise/customize-appearance",
104+
"enterprise/configuring-caches"
104105
]
105106
}
106107
],

0 commit comments

Comments
 (0)