chore: small doc fix, missing period end of help (#20681)

pull/20648/head^2
George Robinson 3 months ago committed by GitHub
parent 90dc2fcd9d
commit 4d1c4032cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 4
      docs/sources/shared/configuration.md
  2. 21
      pkg/dataobj/consumer/config.go

@ -1448,7 +1448,7 @@ dataobj:
[shaprefixsize: <int> | 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: <duration> | default = 1h]
@ -1457,7 +1457,7 @@ dataobj:
# CLI flag: -dataobj-consumer.max-builder-age
[max_builder_age: <duration> | default = 1h]
# The name of the Kafka topic
# The name of the Kafka topic.
# CLI flag: -dataobj-consumer.topic
[topic: <string> | default = ""]

@ -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.",
)
}

Loading…
Cancel
Save