Skip to content

Commit ece0e41

Browse files
committed
update docs
Signed-off-by: Ben Ye <[email protected]>
1 parent e97896b commit ece0e41

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

docs/blocks-storage/querier.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,6 +1314,17 @@ blocks_storage:
13141314
# CLI flag: -blocks-storage.bucket-store.bucket-index.max-stale-period
13151315
[max_stale_period: <duration> | default = 1h]
13161316

1317+
# One of concurrent, recursive, bucket_index. When set to concurrent, stores
1318+
# will concurrently issue one call per directory to discover active blocks
1319+
# in the bucket. The recursive strategy iterates through all objects in the
1320+
# bucket, recursively traversing into each directory. This avoids N+1 calls
1321+
# at the expense of having slower bucket iterations. bucket_index strategy
1322+
# can be used in Compactor only and utilizes the existing bucket index to
1323+
# fetch block IDs to sync. This avoids iterating the bucket but can be
1324+
# impacted by delays of cleaner creating bucket index.
1325+
# CLI flag: -blocks-storage.bucket-store.block-discovery-strategy
1326+
[block_discovery_strategy: <string> | default = "concurrent"]
1327+
13171328
# Max size - in bytes - of a chunks pool, used to reduce memory allocations.
13181329
# The pool is shared across all tenants. 0 to disable the limit.
13191330
# CLI flag: -blocks-storage.bucket-store.max-chunk-pool-bytes

docs/blocks-storage/store-gateway.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,6 +1423,17 @@ blocks_storage:
14231423
# CLI flag: -blocks-storage.bucket-store.bucket-index.max-stale-period
14241424
[max_stale_period: <duration> | default = 1h]
14251425

1426+
# One of concurrent, recursive, bucket_index. When set to concurrent, stores
1427+
# will concurrently issue one call per directory to discover active blocks
1428+
# in the bucket. The recursive strategy iterates through all objects in the
1429+
# bucket, recursively traversing into each directory. This avoids N+1 calls
1430+
# at the expense of having slower bucket iterations. bucket_index strategy
1431+
# can be used in Compactor only and utilizes the existing bucket index to
1432+
# fetch block IDs to sync. This avoids iterating the bucket but can be
1433+
# impacted by delays of cleaner creating bucket index.
1434+
# CLI flag: -blocks-storage.bucket-store.block-discovery-strategy
1435+
[block_discovery_strategy: <string> | default = "concurrent"]
1436+
14261437
# Max size - in bytes - of a chunks pool, used to reduce memory allocations.
14271438
# The pool is shared across all tenants. 0 to disable the limit.
14281439
# CLI flag: -blocks-storage.bucket-store.max-chunk-pool-bytes

docs/configuration/config-file-reference.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1850,6 +1850,17 @@ bucket_store:
18501850
# CLI flag: -blocks-storage.bucket-store.bucket-index.max-stale-period
18511851
[max_stale_period: <duration> | default = 1h]
18521852

1853+
# One of concurrent, recursive, bucket_index. When set to concurrent, stores
1854+
# will concurrently issue one call per directory to discover active blocks in
1855+
# the bucket. The recursive strategy iterates through all objects in the
1856+
# bucket, recursively traversing into each directory. This avoids N+1 calls at
1857+
# the expense of having slower bucket iterations. bucket_index strategy can be
1858+
# used in Compactor only and utilizes the existing bucket index to fetch block
1859+
# IDs to sync. This avoids iterating the bucket but can be impacted by delays
1860+
# of cleaner creating bucket index.
1861+
# CLI flag: -blocks-storage.bucket-store.block-discovery-strategy
1862+
[block_discovery_strategy: <string> | default = "concurrent"]
1863+
18531864
# Max size - in bytes - of a chunks pool, used to reduce memory allocations.
18541865
# The pool is shared across all tenants. 0 to disable the limit.
18551866
# CLI flag: -blocks-storage.bucket-store.max-chunk-pool-bytes

0 commit comments

Comments
 (0)