Skip to content

Commit 97a9a48

Browse files
committed
Copy edits
1 parent e03fa11 commit 97a9a48

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

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

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,25 @@ linkTitle: Configuration
1414
title: Configuration Parameters
1515
weight: 3
1616
---
17-
## Redis CE - Setting configuration parameters
17+
## Redis Community Edition - set configuration parameters
1818

19-
Previous to version 8.0, all time series configuration parameters were load-time parameters.
19+
Before version 8.0, all time series configuration parameters are load-time parameters.
20+
Use one of the following methods to set the values of load-time configuration parameters:
2021

21-
In order to set the values of load-time parameters, you have to use one of the following methods:
22-
23-
- Pass them as command-line arguments following the `loadmodule` argument when starting redis-server
22+
- Pass them as command-line arguments following the `loadmodule` argument when starting `redis-server`:
2423

2524
`redis-server --loadmodule ./{modulename}.so [OPT VAL]...`
2625

27-
- Add them as arguments to the `loadmodule` directive in your configuration file (e.g., `redis.conf`):
26+
- Add them as arguments to the `loadmodule` directive in your configuration file (for example, `redis.conf`):
2827

2928
`loadmodule ./{modulename}.so [OPT VAL]...`
3029

31-
- Using the `MODULE LOAD path [arg [arg ...]]` command.
30+
- Use the `MODULE LOAD path [arg [arg ...]]` command.
3231

33-
- Using the `MODULE LOADEX path [CONFIG name value [CONFIG name value ...]] [ARGS args [args ....]]` command.
32+
- Use the `MODULE LOADEX path [CONFIG name value [CONFIG name value ...]] [ARGS args [args ....]]` command.
3433

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.
34+
Starting with Redis 8.0, most time series configuration parameters are runtime parameters.
35+
While you can set runtime parameters at load time, using the Redis `CONFIG` command is easier and works the same way as with Redis runtime configuration parameters.
3736

3837
This means:
3938

@@ -47,16 +46,16 @@ This means:
4746

4847
- `CONFIG REWRITE`
4948

50-
Rewrite your Redis configuration file (e.g., the `redis.conf` file) to reflect the configuration changes.
49+
Rewrite your Redis configuration file (for example, the `redis.conf` file) to reflect the configuration changes.
5150

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.
51+
Starting with Redis 8.0, you can specify time series configuration parameters directly in your Redis configuration file the same way you would for Redis configuration parameters.
5352

5453
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`.
5554

56-
Note that on a cluster, `CONFIG SET` and `CONFIG REWRITE` have to be called on each node separately.
55+
In a cluster, you must run `CONFIG SET` and `CONFIG REWRITE` on each node separately.
5756

58-
In Redis 8.0, we also introduced new names for the time series configuration parameters, to align the naming with Redis configuration parameters.
59-
When using the `CONFIG` command, you must use the new names.
57+
In Redis 8.0, new names for the time series configuration parameters were introduced to align the naming with the Redis configuration parameters.
58+
You must use the new names when using the `CONFIG` command.
6059

6160
## Time series configuration parameters
6261

@@ -85,15 +84,15 @@ Valid range: `[48 .. 1048576]`; must be a multiple of 8
8584

8685
#### Precedence order
8786

88-
Since the chunk size can be provided at different levels, the actual precedence of the chunk size is:
87+
Because the chunk size can be provided at different levels, the actual precedence of the chunk size is:
8988

9089
1. Key-level policy, as set with [`TS.CREATE`]({{< relref "/commands/ts.create/" >}})'s and [`TS.ALTER`]({{< relref "/commands/ts.alter/" >}})'s `CHUNK_SIZE` optional argument.
9190
1. The `ts-chunk-size-bytes` configuration parameter.
9291
1. The hard-coded default: `4096`
9392

9493
#### Example
9594

96-
Setting the default chunk size to 1024 bytes
95+
Set the default chunk size to 1024 bytes:
9796

9897
Version < 8.0:
9998

@@ -113,7 +112,7 @@ Default compaction rules for newly created keys with [`TS.ADD`]({{< relref "/com
113112

114113
Type: string
115114

116-
Note that this configuration parameter has no effect on keys created with [`TS.CREATE`]({{< relref "commands/ts.create/" >}}). To understand the motivation for this behavior, consider the following scenario: Suppose a default compaction policy is defined, but then one wants to manually create an additional compaction rule (using [`TS.CREATERULE`]({{< relref "commands/ts.createrule/" >}})) which requires first creating an empty destination key (using [`TS.CREATE`]({{< relref "commands/ts.create/" >}})). But now there is a problem: due to the default compaction policy, automatic compactions would be undesirably created for that destination key.
115+
Note that this configuration parameter does not affect keys you create with [`TS.CREATE`]({{< relref "commands/ts.create/" >}}). To understand why, consider the following scenario: Suppose you define a default compaction policy but then want to manually create an additional compaction rule (using [`TS.CREATERULE`]({{< relref "commands/ts.createrule/" >}})), which requires you to first create an empty destination key (using `TS.CREATE`). This approach creates a problem: the default compaction policy would cause Redis to automatically create undesired compactions for the destination key.
117116

118117
Each rule is separated by a semicolon (`;`), the rule consists of multiple fields that are separated by a colon (`:`):
119118

@@ -163,7 +162,7 @@ Each rule is separated by a semicolon (`;`), the rule consists of multiple field
163162
* h - hour
164163
* d - day
165164

166-
Assure that there is a bucket that starts at exactly _alignTimestamp_ after the epoch and align all other buckets accordingly. Default value: 0 (aligned with the epoch). Example: if _bucketDuration_ is 24 hours, setting _alignTimestamp_ to `6h` (6 hours after the Epoch) will ensure that each bucket’s timeframe is [06:00 .. 06:00).
165+
Ensure that there is a bucket that starts at exactly _alignTimestamp_ after the Epoch and align all other buckets accordingly. Default value: 0 (aligned with the Epoch). Example: if _bucketDuration_ is 24 hours, setting _alignTimestamp_ to `6h` (6 hours after the Epoch) will ensure that each bucket’s timeframe is [06:00 .. 06:00).
167166

168167
{{% warning %}}
169168
In a clustered environment, if you set this configuration parameter, you must use [hash tags]({{< relref "/operate/oss_and_stack/reference/cluster-spec" >}}#hash-tags) for all time series key names. This ensures that Redis will create each compaction in the same hash slot as its source key. If you don't, the system may fail to compact the data without displaying any error messages.
@@ -191,7 +190,7 @@ When a compaction policy is defined, compaction rules are created automatically
191190

192191
#### Example
193192

194-
Setting a compaction policy composed of 5 compaction rules
193+
Set a compaction policy composed of 5 compaction rules:
195194

196195
Version < 8.0:
197196

@@ -224,7 +223,7 @@ Type: string
224223

225224
#### Precedence order
226225

227-
Since the duplication policy can be provided at different levels, the actual precedence of the duplication policy is:
226+
Because the duplication policy can be provided at different levels, the actual precedence of the duplication policy is:
228227

229228
1. [`TS.ADD`]({{< relref "/commands/ts.add/" >}})'s `ON_DUPLICATE_POLICY` optional argument.
230229
1. Key-level policy, as set with [`TS.CREATE`]({{< relref "/commands/ts.create/" >}})'s and [`TS.ALTER`]({{< relref "/commands/ts.alter/" >}})'s `DUPLICATE_POLICY` optional argument.
@@ -233,9 +232,9 @@ Since the duplication policy can be provided at different levels, the actual pre
233232

234233
### RETENTION_POLICY / ts-retention-policy
235234

236-
Default retention period, in milliseconds, for newly created keys.
235+
The default retention period, in milliseconds, for newly created keys.
237236

238-
Retention period is the maximum age of samples compared to highest reported timestamp, per key. Samples are expired based solely on the difference between their timestamp and the timestamps passed to subsequent [`TS.ADD`]({{< relref "commands/ts.add/" >}}), [`TS.MADD`]({{< relref "commands/ts.madd/" >}}), [`TS.INCRBY`]({{< relref "commands/ts.incrby/" >}}), and [`TS.DECRBY`]({{< relref "commands/ts.decrby/" >}}) calls.
237+
The retention period is the maximum age of samples compared to the highest reported timestamp, per key. Samples are expired based solely on the difference between their timestamps and the timestamps passed to subsequent [`TS.ADD`]({{< relref "commands/ts.add/" >}}), [`TS.MADD`]({{< relref "commands/ts.madd/" >}}), [`TS.INCRBY`]({{< relref "commands/ts.incrby/" >}}), and [`TS.DECRBY`]({{< relref "commands/ts.decrby/" >}}) calls.
239238

240239
Type: integer
241240

@@ -247,15 +246,15 @@ When both `COMPACTION_POLICY` / `ts-compaction-policy` and `RETENTION_POLICY` /
247246

248247
#### Precedence order
249248

250-
Since the retention can be provided at different levels, the actual precedence of the retention is:
249+
Because the retention can be provided at different levels, the actual precedence of the retention is:
251250

252251
1. Key-level retention, as set with [`TS.CREATE`]({{< relref "/commands/ts.create/" >}})'s and [`TS.ALTER`]({{< relref "/commands/ts.alter/" >}})'s `RETENTION` optional argument.
253252
1. The `ts-retention-policy` configuration parameter.
254253
1. No retention.
255254

256255
#### Example
257256

258-
Setting the default retention to 300 days
257+
Set the default retention to 300 days:
259258

260259
Version < 8.0:
261260

@@ -286,7 +285,7 @@ Valid values: `COMPRESSED`, `UNCOMPRESSED`
286285

287286
#### Example
288287

289-
Setting the default encoding to `UNCOMPRESSED`
288+
Set the default encoding to `UNCOMPRESSED`:
290289

291290
Version < 8.0:
292291

@@ -376,4 +375,4 @@ redis> redis-server --loadmodule ./redistimeseries.so ts-num-threads 3
376375

377376
### OSS_GLOBAL_PASSWORD
378377

379-
Previous to version 8.0, when using a cluster with time series, you had to set the `OSS_GLOBAL_PASSWORD` configuration parameter on all the cluster nodes. Starting with version 8.0, this parameter is obsolete, and ignored if present. Redis now utilizes a new shared secret mechanism to allow sending internal commands between cluster nodes.
378+
Prior to version 8.0, when using time series in a cluster, you had to set the `OSS_GLOBAL_PASSWORD` configuration parameter on all cluster nodes. As of version 8.0, Redis no longer uses this parameter and ignores it if present. Redis now uses a new shared secret mechanism to send internal commands between cluster nodes.

0 commit comments

Comments
 (0)