From 4d1c4032ccb740d5b0f5f5154950cf12724facb7 Mon Sep 17 00:00:00 2001 From: George Robinson Date: Thu, 5 Feb 2026 09:32:54 +0000 Subject: [PATCH] chore: small doc fix, missing period end of help (#20681) --- docs/sources/shared/configuration.md | 4 ++-- pkg/dataobj/consumer/config.go | 21 +++++++++++++++++---- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/sources/shared/configuration.md b/docs/sources/shared/configuration.md index 2a0c11fcdc..4b628cfff4 100644 --- a/docs/sources/shared/configuration.md +++ b/docs/sources/shared/configuration.md @@ -1448,7 +1448,7 @@ dataobj: [shaprefixsize: | default = 2] # The maximum amount of time to wait in seconds before flushing an object - # that is no longer receiving new writes + # that is no longer receiving new writes. # CLI flag: -dataobj-consumer.idle-flush-timeout [idle_flush_timeout: | default = 1h] @@ -1457,7 +1457,7 @@ dataobj: # CLI flag: -dataobj-consumer.max-builder-age [max_builder_age: | default = 1h] - # The name of the Kafka topic + # The name of the Kafka topic. # CLI flag: -dataobj-consumer.topic [topic: | default = ""] diff --git a/pkg/dataobj/consumer/config.go b/pkg/dataobj/consumer/config.go index 194c67f918..34d78a251a 100644 --- a/pkg/dataobj/consumer/config.go +++ b/pkg/dataobj/consumer/config.go @@ -50,8 +50,21 @@ func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) { cfg.LifecyclerConfig.RegisterFlagsWithPrefix(prefix, f, util_log.Logger) cfg.PartitionRingConfig.RegisterFlagsWithPrefix(prefix, f) cfg.UploaderConfig.RegisterFlagsWithPrefix(prefix, f) - - f.StringVar(&cfg.Topic, prefix+"topic", "", "The name of the Kafka topic") - f.DurationVar(&cfg.IdleFlushTimeout, prefix+"idle-flush-timeout", 60*60*time.Second, "The maximum amount of time to wait in seconds before flushing an object that is no longer receiving new writes") - f.DurationVar(&cfg.MaxBuilderAge, prefix+"max-builder-age", time.Hour, "The maximum amount of time to accumulate data in a builder before flushing it. Defaults to 1 hour.") + f.StringVar( + &cfg.Topic, + prefix+"topic", + "", + "The name of the Kafka topic.", + ) + f.DurationVar( + &cfg.IdleFlushTimeout, + prefix+"idle-flush-timeout", + time.Hour, + "The maximum amount of time to wait in seconds before flushing an object that is no longer receiving new writes.", + ) + f.DurationVar(&cfg.MaxBuilderAge, + prefix+"max-builder-age", + time.Hour, + "The maximum amount of time to accumulate data in a builder before flushing it. Defaults to 1 hour.", + ) }