Skip to content

Commit

Permalink
KAFKA-16385 Enhance documentation for retention.ms and retention.byte…
Browse files Browse the repository at this point in the history
…s configurations (apache#15588)

Reviewers: Igor Soarez <[email protected]>, Chia-Ping Tsai <[email protected]>
  • Loading branch information
brandboat authored Mar 27, 2024
1 parent 8d914b5 commit 3e64f8f
Showing 1 changed file with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,17 @@ public class TopicConfig {
"(which consists of log segments) can grow to before we will discard old log segments to free up space if we " +
"are using the \"delete\" retention policy. By default there is no size limit only a time limit. " +
"Since this limit is enforced at the partition level, multiply it by the number of partitions to compute " +
"the topic retention in bytes.";
"the topic retention in bytes. Additionally, retention.bytes configuration " +
"operates independently of \"segment.ms\" and \"segment.bytes\" configurations. " +
"Moreover, it triggers the rolling of new segment if the retention.bytes is configured to zero.";

public static final String RETENTION_MS_CONFIG = "retention.ms";
public static final String RETENTION_MS_DOC = "This configuration controls the maximum time we will retain a " +
"log before we will discard old log segments to free up space if we are using the " +
"\"delete\" retention policy. This represents an SLA on how soon consumers must read " +
"their data. If set to -1, no time limit is applied.";
"their data. If set to -1, no time limit is applied. Additionally, retention.ms configuration " +
"operates independently of \"segment.ms\" and \"segment.bytes\" configurations. " +
"Moreover, it triggers the rolling of new segment if the retention.ms condition is satisfied.";

public static final String REMOTE_LOG_STORAGE_ENABLE_CONFIG = "remote.storage.enable";
public static final String REMOTE_LOG_STORAGE_ENABLE_DOC = "To enable tiered storage for a topic, set this configuration as true. " +
Expand Down

0 comments on commit 3e64f8f

Please sign in to comment.