Skip to content

Commit a7466d1

Browse files
committed
updated doc
Signed-off-by: Alex Le <leqiyue@amazon.com>
1 parent 117373a commit a7466d1

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/guides/partitioning-compactor.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,26 @@ Compactor is bounded by maximum 64GB of index file size. If compaction failed du
1414
In order to enable partition compaction, the following flag needs to be set:
1515

1616
```
17-
-compactor.sharding-enabled=true
18-
-compactor.sharding-strategy=shuffle-sharding
19-
-compactor.compaction-strategy=partitioning
17+
-compactor.sharding-enabled=true # Enable sharding tenants across multiple compactor instances. This is required to enable partition compaction
18+
-compactor.sharding-strategy=shuffle-sharding # Use Shuffle Sharding as sharding strategy. This is required to enable partition compaction
19+
-compactor.compaction-strategy=partitioning # Use Partition Compaction as compaction strategy. To turn if off, set it to `default`
2020
```
2121

22+
### Migration
23+
24+
There is no special migration process needed to enable partition compaction. End user could enable it by setting the above configurations all at once.
25+
26+
Enabling partition compaction would group previously compacted blocks (only those have time range smaller than the largest configured compaction time ranges) with uncompacted blocks and generate new compaction plans. This would group blocks having duplicated series together and those series would be deduped after compaction.
27+
28+
Disabling partition compaction after enabled it does not need migration either. After disabling partition compaction, compactor would group partitioned result blocks together and compact them into one block.
29+
2230
## Configure Partition Compaction
2331

2432
By default, partition compaction utilizes the following configurations and their values:
2533

2634
```
27-
-compactor.partition-index-size-bytes=68719476736 // 64GB
28-
-compactor.partition-series-count=0 // no limit
35+
-compactor.partition-index-size-bytes=68719476736 # 64GB
36+
-compactor.partition-series-count=0 # no limit
2937
```
3038

3139
The default value should start partitioning result blocks when sum of index files size of parent blocks exceeds 64GB. End user could also change those two configurations. Partition compaction would always calculate partition count based on both configuration and pick the one with higher partition count.
@@ -38,5 +46,5 @@ Note: `compactor.partition-series-count` is using sum of series count of all par
3846

3947
- `cortex_compactor_group_partition_count`: can be used to keep track of how many partitions being compacted for each time range.
4048
- `cortex_compactor_group_compactions_not_planned_total`: can be used to alarm any compaction was failed to be planned due to error.
41-
- `cortex_compact_group_compaction_duration_seconds`: can be used to monitor compaction duration or each time range compactions.
49+
- `cortex_compact_group_compaction_duration_seconds`: can be used to monitor compaction duration of each time range compactions.
4250
- `cortex_compactor_oldest_partition_offset`: can be used to monitor when was the oldest compaction that is still not completed.

0 commit comments

Comments
 (0)