docs(pubsub): clarify NumGoroutines configures number of streams #7874
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
product-auto-label
bot
added
size: s
feywind
approved these changes
May 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Users of the client library are not aware how to change the number of streaming pull streams. Previously, NumGoroutines are more complex and ambiguous in behavior, but for the users, it mostly matters in the context of how many streams are opened. Made the documentation in line with Java's
setParallelPullCountIn addition, users of the client library are setting too high of a value for
ReceiveSettings.NumGoroutine, and end up opening too many StreamingPull streams. We should actively call out that setting this too high can cause poor pulling behavior and note that a few streams will suffice for most use cases (since each stream can handle 10MB/s).