Skip to content

Commit 7161f43

Browse files
authored
Update configuration.md
1 parent 6f08360 commit 7161f43

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

content/develop/data-types/timeseries/configuration.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ weight: 3
1818

1919
Previous to version 8.0, all time series configuration parameters were load-time parameters.
2020

21-
In order to change the values of a load-time parameter, you have to use one of the following methods:
21+
In order to set the values of load-time parameters, you have to use one of the following methods:
2222

2323
- Pass them as command-line arguments following the `loadmodule` argument when starting redis-server
2424

@@ -32,8 +32,8 @@ In order to change the values of a load-time parameter, you have to use one of t
3232

3333
- Using the `MODULE LOADEX path [CONFIG name value [CONFIG name value ...]] [ARGS args [args ....]]` command.
3434

35-
With the introduction of Redis 8.0, most of the time series configuration parameters are now runtime parameters. This means that their values can be changed at runtime.
36-
You can set runtime configuration parameters at load-time, but instead, it is recommended to use the Redis `CONFIG` command with time series runtime configuration parameters, the same way you would do for Redis runtime configuration parameters.
35+
With the introduction of Redis 8.0, most of the time series configuration parameters are now runtime parameters. This means that you can change their values at runtime.
36+
You can also set runtime configuration parameters at load-time, but it is simpler to use the Redis `CONFIG` command with time series runtime configuration parameters, the same way you would do for Redis runtime configuration parameters.
3737

3838
This means:
3939

@@ -49,13 +49,13 @@ This means:
4949

5050
Rewrite your Redis configuration file (e.g., the `redis.conf` file) to reflect the configuration changes.
5151

52-
Starting with Redis 8.0, you can also specify time series configuration parameters directly in your Redis configuration file (e.g., the `redis.conf` file) the same way you would do for Redis configuration parameters.
52+
Starting with Redis 8.0, you can also specify time series configuration parameters directly in your Redis configuration file (e.g., your `redis.conf` file) the same way you would do for Redis configuration parameters.
5353

54-
Once a value is set with `CONFIG SET`, or added manually to your configuration file, it will overwrite values set with `--loadmodule`, `loadmodule`, `MODULE LOAD`, or `MODULE LOADEX`.
54+
Once a value is set with `CONFIG SET` or added manually to your configuration file, it will overwrite values set with `--loadmodule`, `loadmodule`, `MODULE LOAD`, or `MODULE LOADEX`.
5555

5656
Note that on a cluster, `CONFIG SET` and `CONFIG REWRITE` have to be called on each node separately.
5757

58-
In Redis 8.0, we also introduced new names for the time series configuration parameters, to align the naming scheme of the time series configuration parameters with Redis configuration parameters.
58+
In Redis 8.0, we also introduced new names for the time series configuration parameters, to align the naming with Redis configuration parameters.
5959
When using the `CONFIG` command, you must use the new names.
6060

6161
## Time series configuration parameters
@@ -85,6 +85,21 @@ Type: integer
8585
Valid range: `[48 .. 1048576]`; must be a multiple of 8
8686

8787
Default: `4096`
88+
#### Example
89+
90+
Setting the default chunk size to 1024 bytes
91+
92+
Version < 8.0:
93+
94+
```
95+
$ redis-server --loadmodule ./redistimeseries.so CHUNK_SIZE_BYTES 1024
96+
```
97+
98+
Version >= 8.0:
99+
100+
```
101+
redis> CONFIG SET ts-chunk-size-bytes 1024
102+
```
88103

89104
### COMPACTION_POLICY / ts-compaction-policy
90105

@@ -197,6 +212,8 @@ Since the duplication policy can be provided at different levels, the actual pre
197212

198213
#### Example
199214

215+
Setting a compaction policy composed of 5 compaction rules
216+
200217
Version < 8.0:
201218

202219
```
@@ -206,7 +223,7 @@ $ redis-server --loadmodule ./redistimeseries.so COMPACTION_POLICY max:1m:1h;min
206223
Version >= 8.0:
207224

208225
```
209-
$ CONFIG SET ts-compaction-policy max:1m:1h;min:10s:5d:10d;last:5M:10m;avg:2h:10d;avg:3d:100d
226+
redis> CONFIG SET ts-compaction-policy max:1m:1h;min:10s:5d:10d;last:5M:10m;avg:2h:10d;avg:3d:100d
210227
```
211228

212229
### RETENTION_POLICY / ts-retention-policy
@@ -238,7 +255,7 @@ $ redis-server --loadmodule ./redistimeseries.so RETENTION_POLICY 25920000000
238255
Version >= 8.0:
239256

240257
```
241-
$ CONFIG SET ts-retention-policy 25920000000
258+
redis> CONFIG SET ts-retention-policy 25920000000
242259
```
243260

244261
### ENCODING / ts-encoding
@@ -310,7 +327,7 @@ $ redis-server --loadmodule ./redistimeseries.so NUM_THREADS 3
310327
Version >= 8.0:
311328

312329
```
313-
$ redis-server --loadmodule ./redistimeseries.so ts-num-threads 3
330+
redis> redis-server --loadmodule ./redistimeseries.so ts-num-threads 3
314331
```
315332

316333

0 commit comments

Comments
 (0)