[
https://issues.apache.org/jira/browse/KAFKA-5554?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16073686#comment-16073686
]
ASF GitHub Bot commented on KAFKA-5554:
---------------------------------------
GitHub user tombentley opened a pull request:
https://github.com/apache/kafka/pull/3486
KAFKA-5554 doc config common
This is more a request for review than it is a request to merge, as I don't
think this is complete yet. However, this illustrates the idea of drawing
attention to those settings which pertain to common use cases.
It would work even better with the merge of
https://github.com/apache/kafka/pull/3436, since then I could link directly to
the doc for each setting.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/tombentley/kafka kafka-5554-doc-config-common
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/kafka/pull/3486.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #3486
----
commit 6ec588b73665f4aa3b84b27074c9561f10439df3
Author: Tom Bentley <tbent...@redhat.com>
Date: 2017-07-04T13:21:43Z
KAFKA-5554 [WIP] Call out config setting pertaining to common requirements
Add a section to the configuration documentation highlighting the particular
settings required to ensure messages aren't lost.
commit 8b45f79abf595f32948382970b2ab7ba6c46f4cf
Author: Tom Bentley <tbent...@redhat.com>
Date: 2017-07-04T13:23:15Z
KAFKA-5554 [WIP] Call out config setting pertaining to common requirements
Add a section to the configuration documentation highlighting the particular
settings required to minimise latency.
----
> Hilight config settings for particular common use cases
> -------------------------------------------------------
>
> Key: KAFKA-5554
> URL: https://issues.apache.org/jira/browse/KAFKA-5554
> Project: Kafka
> Issue Type: Improvement
> Components: documentation
> Reporter: Tom Bentley
> Assignee: Tom Bentley
> Priority: Minor
>
> Judging by the sorts of questions seen on the mailling list, stack overflow
> etc it seems common for users to assume that Kafka will default to settings
> which won't lose messages. They start using Kafka and at some later time find
> messages have been lost.
> While it's not our fault if users don't read the documentation, there's a lot
> of configuration documentation to digest and it's easy for people to miss an
> important setting.
> Therefore, I'd like to suggest that in addition to the current configuration
> docs we add a short section highlighting those settings which pertain to
> common use cases, such as:
> * configs to avoid lost messages
> * configs for low latency
> I'm sure some users will continue to not read the documentation, but when
> they inevitably start asking questions it means people can respond with "have
> you configured everything as described here?"
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
