Skip to content

COMPACTION_POLICY - added warning #1195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2025
Merged

COMPACTION_POLICY - added warning #1195

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb91644
COMPACTION_POLICY - added warning
LiorKogan Feb 21, 2025
9e2f2e3
Active voice edit.
dwdougherty Feb 21, 2025
88294a7
Apply review comments.
dwdougherty Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/develop/data-types/timeseries/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ Each rule is separated by a semicolon (`;`), the rule consists of multiple field

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).

{{% warning %}}
In a clustered environment, if you set `COMPACTION_POLICY`, 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.
Copy link
Member Author

@LiorKogan LiorKogan Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is one additional "the system" ;-)

Copy link
Collaborator

@dwdougherty dwdougherty Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's already been merged; I'll address in a later PR.

{{% /warning %}}

When a compaction policy is defined, compaction rules will be created automatically for newly created time series, and their key would be set to:

* If the time bucket alignment is 0:
Expand Down