Skip to content

docs(pubsub): clarify NumGoroutines configures number of streams - #7874

Merged
hongalex merged 4 commits into
googleapis:mainfrom
hongalex:docs-pubsub-streams
May 3, 2023
Merged

hongalex merged 4 commits into
googleapis:mainfrom
hongalex:docs-pubsub-streams

Conversation

@hongalex

@hongalex hongalex commented May 2, 2023 •

Copy link
Copy Markdown
Member

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 setParallelPullCount

In 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).

@hongalex
hongalex requested review from a team May 2, 2023 22:32
@hongalex
hongalex requested a review from shollyman as a code owner May 2, 2023 22:32
@product-auto-label product-auto-label Bot added size: s Pull request size is small. api: pubsub Issues related to the Pub/Sub API. labels May 2, 2023
@hongalex
hongalex enabled auto-merge (squash) May 3, 2023 18:37
@hongalex
hongalex merged commit 8ac4432 into googleapis:main May 3, 2023
@hongalex
hongalex deleted the docs-pubsub-streams branch December 10, 2025 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: pubsub Issues related to the Pub/Sub API. size: s Pull request size is small.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

⌂ 换网址