Skip to content

MINOR: clarify node grouping of input topics using pattern subscription#7793

Merged
vvcephei merged 4 commits into
apache:trunkfrom
ableegoldman:DOCS-pattern0subscription-node-grouping
Dec 6, 2019
Merged

MINOR: clarify node grouping of input topics using pattern subscription#7793
vvcephei merged 4 commits into
apache:trunkfrom
ableegoldman:DOCS-pattern0subscription-node-grouping

Conversation

@ableegoldman

Copy link
Copy Markdown
Member

A user recently pointed out that we don't document how tasks are generated when using pattern subscription for input topics.

We should document this so users can better understand how their application will scale

@ableegoldman

Copy link
Copy Markdown
Member Author

@guozhangwang

@vvcephei vvcephei left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvement! Just one small piece of feedback on the wording.

topics do not match the configured default SerDes. For information about configuring default SerDes, available
SerDes, and implementing your own custom SerDes see <a class="reference internal" href="datatypes.html#streams-developer-guide-serdes"><span class="std std-ref">Data Types and Serialization</span></a>.</p>
<p class="last">Several variants of <code class="docutils literal"><span class="pre">stream</span></code> exist, for example to specify a regex pattern for input topics to read from).</p>
<p class="last">Several variants of <code class="docutils literal"><span class="pre">stream</span></code> exist. For example, you can specify a regex pattern for input topics to read from (note that a single nodegroup will be created for all matching topics, and therefore the number of tasks will scale with the maximum partition count rather than the total number of partitions).</p>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is nodegroup already a defined term by this point? Looking at this and the other changes, this might be kind of a confusing usage of the word "node". Maybe just make up something more intuitive, like "input topic group"?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's fair. I didn't know what that was when I first saw it in the code. What do you think about using "subtopology" here?

Alternatively, how about: note that all matching topics will be part of the same input topic group, and the work will not be parallelized for different topics if subscribed to in this way

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think your "alternative" is the best phrasing yet.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Rephrased the javadocs as well -- thanks!

@vvcephei vvcephei left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@vvcephei

vvcephei commented Dec 6, 2019

Copy link
Copy Markdown
Contributor

Since this is a docs change only, I'm just going to go ahead and merge it. Just to be sure, I built and tested it locally.

@vvcephei vvcephei merged commit cd5618f into apache:trunk Dec 6, 2019
vvcephei pushed a commit to apache/kafka-site that referenced this pull request Dec 6, 2019
See also Apache Kafka apache/kafka#7793

Reviewers: John Roesler <vvcephei@apache.org>
vvcephei pushed a commit that referenced this pull request Dec 7, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
vvcephei pushed a commit that referenced this pull request Dec 7, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
vvcephei pushed a commit that referenced this pull request Dec 7, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
vvcephei pushed a commit that referenced this pull request Dec 7, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
vvcephei pushed a commit that referenced this pull request Dec 7, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
vvcephei pushed a commit that referenced this pull request Dec 7, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
@vvcephei

vvcephei commented Dec 7, 2019

Copy link
Copy Markdown
Contributor

Cherry-picked to 1.0, 1.1, 2.0, 2.1, 2.2, and 2.3 . I'm not doing 2.4 right now because the release is pending.

@ableegoldman ableegoldman deleted the DOCS-pattern0subscription-node-grouping branch December 9, 2019 21:23
omkreddy pushed a commit that referenced this pull request Dec 14, 2019
…on (#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
@omkreddy

Copy link
Copy Markdown
Contributor

cherry-picked the PR to 2.4 branch.

qq619618919 pushed a commit to qq619618919/kafka that referenced this pull request May 12, 2020
…on (apache#7793)

Updates the HTML docs and the javadoc.

Reviewers: John Roesler <vvcephei@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants