diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md index 4dcc15cd14a..756ac0bd3ae 100644 --- a/docs/configuration/config-file-reference.md +++ b/docs/configuration/config-file-reference.md @@ -2181,6 +2181,11 @@ bucket_store: # CLI flag: -experimental.tsdb.head-compaction-concurrency [head_compaction_concurrency: | default = 5] +# The number of shards of series to use in TSDB (must be a power of 2). Reducing +# this will decrease memory footprint, but can negatively impact performance. +# CLI flag: -experimental.tsdb.stripe-size +[stripe_size: | default = 16384] + # limit the number of concurrently opening TSDB's on startup # CLI flag: -experimental.tsdb.max-tsdb-opening-concurrency-on-startup [max_tsdb_opening_concurrency_on_startup: | default = 10] diff --git a/docs/operations/blocks-storage.md b/docs/operations/blocks-storage.md index 2ac5d6479b0..464126eb579 100644 --- a/docs/operations/blocks-storage.md +++ b/docs/operations/blocks-storage.md @@ -176,6 +176,12 @@ tsdb: # CLI flag: -experimental.tsdb.head-compaction-concurrency [head_compaction_concurrency: | default = 5] + # The number of shards of series to use in TSDB (must be a power of 2). + # Reducing this will decrease memory footprint, but can negatively impact + # performance. + # CLI flag: -experimental.tsdb.stripe-size + [stripe_size: | default = 16384] + # limit the number of concurrently opening TSDB's on startup # CLI flag: -experimental.tsdb.max-tsdb-opening-concurrency-on-startup [max_tsdb_opening_concurrency_on_startup: | default = 10] diff --git a/pkg/storage/tsdb/config.go b/pkg/storage/tsdb/config.go index 19b3fd8f1cf..20822a2f8fe 100644 --- a/pkg/storage/tsdb/config.go +++ b/pkg/storage/tsdb/config.go @@ -116,7 +116,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) { f.IntVar(&cfg.MaxTSDBOpeningConcurrencyOnStartup, "experimental.tsdb.max-tsdb-opening-concurrency-on-startup", 10, "limit the number of concurrently opening TSDB's on startup") f.DurationVar(&cfg.HeadCompactionInterval, "experimental.tsdb.head-compaction-interval", 1*time.Minute, "How frequently does Cortex try to compact TSDB head. Block is only created if data covers smallest block range. Must be greater than 0 and max 5 minutes.") f.IntVar(&cfg.HeadCompactionConcurrency, "experimental.tsdb.head-compaction-concurrency", 5, "Maximum number of tenants concurrently compacting TSDB head into a new block") - f.IntVar(&cfg.StripeSize, "experimental.tsdb.stripe-size", 16384, "Power of 2 to use for the number of shards of series to use in TSDB. Reducing this will decrease memory footprint, but can negatively impact performance.") + f.IntVar(&cfg.StripeSize, "experimental.tsdb.stripe-size", 16384, "The number of shards of series to use in TSDB (must be a power of 2). Reducing this will decrease memory footprint, but can negatively impact performance.") } // Validate the config