Skip to content

Commit 348d812

Browse files
SungJin1212SungJin1212
authored
Rename user index update config (#7180)
* Rename user index update config Signed-off-by: SungJin1212 <tjdwls1201@gmail.com> * fix lint Signed-off-by: SungJin1212 <tjdwls1201@gmail.com> --------- Signed-off-by: SungJin1212 <tjdwls1201@gmail.com>
1 parent c763edc commit 348d812

13 files changed

Lines changed: 54 additions & 52 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Changelog
22

33
## master / unreleased
4-
4+
* [CHANGE] Users Scanner: Rename user index update configuration. #7180
5+
* Flag: Renamed `-*.users-scanner.user-index.cleanup-interval` to `-*.users-scanner.user-index.update-interval`.
6+
* Config: Renamed `clean_up_interval` to `update_interval` within the `users_scanner` configuration block..
57
* [CHANGE] Querier: Refactored parquet cache configuration naming. #7146
68
* Metrics: Renamed `cortex_parquet_queryable_cache_*` to `cortex_parquet_cache_*`.
79
* Flags: Renamed `-querier.parquet-queryable-shard-cache-size` to `-querier.parquet-shard-cache-size` and `-querier.parquet-queryable-shard-cache-ttl` to `-querier.parquet-shard-cache-ttl`.

‎docs/blocks-storage/querier.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1948,8 +1948,8 @@ blocks_storage:
19481948

19491949
# How frequently user index file is updated. It only takes effect when user
19501950
# scan strategy is user_index.
1951-
# CLI flag: -blocks-storage.users-scanner.user-index.cleanup-interval
1952-
[clean_up_interval: <duration> | default = 15m]
1951+
# CLI flag: -blocks-storage.users-scanner.user-index.update-interval
1952+
[update_interval: <duration> | default = 15m]
19531953

19541954
# TTL of the cached users. 0 disables caching and relies on caching at
19551955
# bucket client level.

‎docs/blocks-storage/store-gateway.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2019,8 +2019,8 @@ blocks_storage:
20192019

20202020
# How frequently user index file is updated. It only takes effect when user
20212021
# scan strategy is user_index.
2022-
# CLI flag: -blocks-storage.users-scanner.user-index.cleanup-interval
2023-
[clean_up_interval: <duration> | default = 15m]
2022+
# CLI flag: -blocks-storage.users-scanner.user-index.update-interval
2023+
[update_interval: <duration> | default = 15m]
20242024

20252025
# TTL of the cached users. 0 disables caching and relies on caching at
20262026
# bucket client level.

‎docs/configuration/config-file-reference.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -999,8 +999,8 @@ users_scanner:
999999

10001000
# How frequently user index file is updated. It only takes effect when user
10011001
# scan strategy is user_index.
1002-
# CLI flag: -alertmanager-storage.users-scanner.user-index.cleanup-interval
1003-
[clean_up_interval: <duration> | default = 15m]
1002+
# CLI flag: -alertmanager-storage.users-scanner.user-index.update-interval
1003+
[update_interval: <duration> | default = 15m]
10041004

10051005
# TTL of the cached users. 0 disables caching and relies on caching at bucket
10061006
# client level.
@@ -2624,8 +2624,8 @@ users_scanner:
26242624

26252625
# How frequently user index file is updated. It only takes effect when user
26262626
# scan strategy is user_index.
2627-
# CLI flag: -blocks-storage.users-scanner.user-index.cleanup-interval
2628-
[clean_up_interval: <duration> | default = 15m]
2627+
# CLI flag: -blocks-storage.users-scanner.user-index.update-interval
2628+
[update_interval: <duration> | default = 15m]
26292629

26302630
# TTL of the cached users. 0 disables caching and relies on caching at bucket
26312631
# client level.
@@ -5905,8 +5905,8 @@ users_scanner:
59055905

59065906
# How frequently user index file is updated. It only takes effect when user
59075907
# scan strategy is user_index.
5908-
# CLI flag: -ruler-storage.users-scanner.user-index.cleanup-interval
5909-
[clean_up_interval: <duration> | default = 15m]
5908+
# CLI flag: -ruler-storage.users-scanner.user-index.update-interval
5909+
[update_interval: <duration> | default = 15m]
59105910

59115911
# TTL of the cached users. 0 disables caching and relies on caching at bucket
59125912
# client level.

‎integration/alertmanager_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ func TestAlertmanagerWithUserIndexUpdater(t *testing.T) {
8282

8383
baseFlags := mergeFlags(AlertmanagerFlags(), AlertmanagerS3Flags())
8484
flags := mergeFlags(baseFlags, AlertmanagerShardingFlags(consul.NetworkHTTPEndpoint(), 1), map[string]string{
85-
"-alertmanager-storage.users-scanner.strategy": "user_index",
86-
"-alertmanager-storage.users-scanner.user-index.cleanup-interval": "15s",
87-
"-alertmanager.configs.poll-interval": "5s",
85+
"-alertmanager-storage.users-scanner.strategy": "user_index",
86+
"-alertmanager-storage.users-scanner.user-index.update-interval": "15s",
87+
"-alertmanager.configs.poll-interval": "5s",
8888
})
8989

9090
am := e2ecortex.NewAlertmanager(

‎integration/ruler_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,10 @@ func TestRulerWithUserIndexUpdater(t *testing.T) {
158158
RulerFlags(),
159159
RulerShardingFlags(consul.NetworkHTTPEndpoint()),
160160
map[string]string{
161-
"-ruler.sharding-strategy": "shuffle-sharding",
162-
"-ruler-storage.users-scanner.strategy": "user_index",
163-
"-ruler-storage.users-scanner.user-index.cleanup-interval": "15s",
164-
"-ruler.tenant-shard-size": "1",
161+
"-ruler.sharding-strategy": "shuffle-sharding",
162+
"-ruler-storage.users-scanner.strategy": "user_index",
163+
"-ruler-storage.users-scanner.user-index.update-interval": "15s",
164+
"-ruler.tenant-shard-size": "1",
165165
// Since we're not going to run any rule, we don't need the
166166
// store-gateway to be configured to a valid address.
167167
"-querier.store-gateway-addresses": "localhost:12345",

‎pkg/alertmanager/alertstore/bucketclient/bucket_client.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func NewBucketAlertStore(bkt objstore.InstrumentedBucket, userScannerCfg users.U
6767
baseScanner, _ := users.NewScanner(users.UsersScannerConfig{
6868
Strategy: users.UserScanStrategyList,
6969
}, alertBucket, logger, regWithComponent)
70-
userIndexUpdater = users.NewUserIndexUpdater(alertBucket, userScannerCfg.CleanUpInterval, baseScanner, regWithComponent)
70+
userIndexUpdater = users.NewUserIndexUpdater(alertBucket, userScannerCfg.UpdateInterval, baseScanner, regWithComponent)
7171
}
7272

7373
return &BucketAlertStore{

‎pkg/compactor/compactor.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ func (c *Compactor) starting(ctx context.Context) error {
762762
baseScanner, _ := users.NewScanner(users.UsersScannerConfig{
763763
Strategy: users.UserScanStrategyList,
764764
}, c.bucketClient, c.logger, c.registerer)
765-
c.userIndexUpdater = users.NewUserIndexUpdater(c.bucketClient, c.storageCfg.UsersScanner.CleanUpInterval, baseScanner, extprom.WrapRegistererWith(prometheus.Labels{"component": "compactor"}, c.registerer))
765+
c.userIndexUpdater = users.NewUserIndexUpdater(c.bucketClient, c.storageCfg.UsersScanner.UpdateInterval, baseScanner, extprom.WrapRegistererWith(prometheus.Labels{"component": "compactor"}, c.registerer))
766766
}
767767

768768
return nil
@@ -1212,7 +1212,7 @@ func (c *Compactor) userIndexUpdateLoop(ctx context.Context) {
12121212
// Hardcode ID to check which compactor owns updating user index.
12131213
userID := users.UserIndexCompressedFilename
12141214
// Align with clean up interval.
1215-
ticker := time.NewTicker(util.DurationWithJitter(c.storageCfg.UsersScanner.CleanUpInterval, 0.1))
1215+
ticker := time.NewTicker(util.DurationWithJitter(c.storageCfg.UsersScanner.UpdateInterval, 0.1))
12161216
defer ticker.Stop()
12171217

12181218
for {

‎pkg/compactor/compactor_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1580,7 +1580,7 @@ func prepare(t *testing.T, compactorCfg Config, bucketClient objstore.Instrument
15801580
flagext.DefaultValues(&storageCfg)
15811581
storageCfg.BucketStore.BlockDiscoveryStrategy = string(cortex_tsdb.RecursiveDiscovery)
15821582
storageCfg.UsersScanner.Strategy = users.UserScanStrategyUserIndex
1583-
storageCfg.UsersScanner.CleanUpInterval = 100 * time.Millisecond // Short interval for testing
1583+
storageCfg.UsersScanner.UpdateInterval = 100 * time.Millisecond // Short interval for testing
15841584

15851585
// Create a temporary directory for compactor data.
15861586
compactorCfg.DataDir = t.TempDir()

‎pkg/ruler/rulestore/bucketclient/bucket_client.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ func NewBucketRuleStore(bkt objstore.Bucket, userScannerCfg users.UsersScannerCo
6565
baseScanner, _ := users.NewScanner(users.UsersScannerConfig{
6666
Strategy: users.UserScanStrategyList,
6767
}, rulesBucket, logger, regWithComponent)
68-
userIndexUpdater = users.NewUserIndexUpdater(rulesBucket, userScannerCfg.CleanUpInterval, baseScanner, regWithComponent)
68+
userIndexUpdater = users.NewUserIndexUpdater(rulesBucket, userScannerCfg.UpdateInterval, baseScanner, regWithComponent)
6969
}
7070

7171
return &BucketRuleStore{

0 commit comments

Comments
 (0)