[jira] [Commented] (KAFKA-3087) Fix documentation for retention.ms property and update documentation for LogConfig.scala class

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KAFKA-3087?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16376260#comment-16376260 ] 

ASF GitHub Bot commented on KAFKA-3087:
---------------------------------------

hachikuji closed pull request #772: KAFKA-3087: Fix retention.ms property documentation in config docs
URL: https://github.com/apache/kafka/pull/772
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/core/src/main/scala/kafka/log/LogConfig.scala b/core/src/main/scala/kafka/log/LogConfig.scala
index 7fc7e33bc77..8c4802738e2 100755
--- a/core/src/main/scala/kafka/log/LogConfig.scala
+++ b/core/src/main/scala/kafka/log/LogConfig.scala
@@ -109,7 +109,7 @@ object LogConfig {
   val FlushIntervalDoc = "The number of messages that can be written to the log before a flush is forced"
   val FlushMsDoc = "The amount of time the log can have dirty data before a flush is forced"
   val RetentionSizeDoc = "The approximate total number of bytes this log can use"
-  val RetentionMsDoc = "The approximate maximum age of the last segment that is retained"
+  val RetentionMsDoc = "The approximate maximum number of milliseconds of the last segment that is retained"
   val MaxIndexSizeDoc = "The maximum size of an index file"
   val MaxMessageSizeDoc = "The maximum size of a message"
   val IndexIntervalDoc = "The approximate number of bytes between index entries"
diff --git a/docs/configuration.html b/docs/configuration.html
index ff5bb6bbf9b..d1019d25074 100644
--- a/docs/configuration.html
+++ b/docs/configuration.html
@@ -118,8 +118,8 @@ <h3><a id="brokerconfigs" href="#brokerconfigs">3.1 Broker Configs</a></h3>
     <tr>
       <td>retention.ms</td>
       <td>7 days</td>
-      <td>log.retention.minutes</td>
-      <td>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.</td>
+      <td>log.retention.ms</td>
+      <td>This configuration controls the maximum number of milliseconds 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.</td>
     </tr>
     <tr>
       <td>segment.bytes</td>


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Fix documentation for retention.ms property and update documentation for LogConfig.scala class
> ----------------------------------------------------------------------------------------------
>
>                 Key: KAFKA-3087
>                 URL: https://issues.apache.org/jira/browse/KAFKA-3087
>             Project: Kafka
>          Issue Type: Bug
>          Components: log
>            Reporter: Raju Bairishetti
>            Assignee: Jay Kreps
>            Priority: Critical
>              Labels: documentation
>
> Log retention settings can be set it in broker and some properties can be overriden at topic level. 
> |Property |Default|Server Default property| Description|
> |retention.ms|7 days|log.retention.minutes|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.|
> But retention.ms is in milli seconds not in minutes. So corresponding *Server Default property* should be *log.retention.ms* instead of *log.retention.minutes*.
> It would be better if we mention the if the time age is in millis/minutes/hours in the documentation page and documenting in code as well (Right now, it is saying *age in the code*. We should specify the *age in time granularity).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)