Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Configure the client's inbound max_message_size #12122

Closed
korthout opened this issue Mar 23, 2023 · 0 comments · Fixed by #11902
Closed

Configure the client's inbound max_message_size #12122

korthout opened this issue Mar 23, 2023 · 0 comments · Fixed by #11902
Assignees
@korthout
Labels
area/ux Marks an issue as related to improving the user experience component/clients kind/feature Categorizes an issue or PR as a feature, i.e. new behavior scope/clients-java Marks an issue or PR to appear in the Java client section of the changelog version:8.3.0-alpha1 Marks an issue as being completely or in parts released in 8.3.0-alpha1 version:8.3.0 Marks an issue as being completely or in parts released in 8.3.0

Comments

@korthout
Copy link
Member

Is your feature request related to a problem? Please describe.
Sometimes, I may want to specify a larger than the default (4 MB) inbound MAX_MESSAGE_SIZE for the client. For example, when I create a process instance with a result where the resulting variables are larger than the default 4 MB.

Describe the solution you'd like
Add a configuration option to the client to specify an inbound max message size applied to the gRPC responses. The default should be the current hardcoded 4 MB.

Describe alternatives you've considered

  • specify it for each command: this is hard to implement at this time as the channel is set up on client construction
  • don't allow specifying it: the current behavior throws errors in the client when the gateway responds with larger than 4MB messages (which is possible already).

Additional context
@korthout korthout added kind/feature Categorizes an issue or PR as a feature, i.e. new behavior scope/clients-java Marks an issue or PR to appear in the Java client section of the changelog area/ux Marks an issue as related to improving the user experience component/clients labels Mar 23, 2023
@korthout korthout mentioned this issue Mar 23, 2023
Merged
14 tasks
@korthout korthout linked a pull request Mar 29, 2023 that will close this issue
feat: add a configuration option for maximum message size in zeebe client java #11902
Merged
14 tasks
@korthout korthout self-assigned this Mar 29, 2023
ghost pushed a commit that referenced this issue Apr 14, 2023
@gakkiyomi
merge: #11902
3d39ccf 
11902: feat: add a configuration option for maximum message size in zeebe client java r=korthout a=gakkiyomi

## Description

<!-- Please explain the changes you made here. -->

Allows configuring the Java client's inbound max message size, which specifies the maximum size of incoming responses the client can receive. Specifically, it sets the `maxInboundMessageSize` of the gRPC channel. 

The default is 4194304 = 4MB.

It can be configured:
- as an environment variables `zeebe.client.maxMessageSize` (as data size string)
- using a configuration property: `zeebe.client.maxMessageSize` (as data size string)
- or using the Java API: `ZeebeClientBuilder.maxMessageSize(int maxMessageSize)`

A data size string is a number optionally followed by a data size unit `kb|KB|mb|MB`. For example: `4MB`, `4194304`, `4000 kb`, etc.

## Related issues

<!-- Which issues are closed by this PR or are related -->

closes #12122 



Co-authored-by: fangcong <[email protected]>
@ghost ghost closed this as completed in f763d74 Apr 14, 2023
@remcowesterhoud remcowesterhoud added version:8.3.0-alpha1 Marks an issue as being completely or in parts released in 8.3.0-alpha1 and removed version:8.3.0-alpha1 Marks an issue as being completely or in parts released in 8.3.0-alpha1 labels May 3, 2023
@romansmirnov romansmirnov mentioned this issue May 16, 2023
Closed
@korthout korthout mentioned this issue May 24, 2023
Closed
@megglos megglos added the version:8.3.0 Marks an issue as being completely or in parts released in 8.3.0 label Oct 5, 2023
@inghak inghak mentioned this issue Jan 22, 2024
Open
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@korthout korthout

Labels
area/ux Marks an issue as related to improving the user experience component/clients kind/feature Categorizes an issue or PR as a feature, i.e. new behavior scope/clients-java Marks an issue or PR to appear in the Java client section of the changelog version:8.3.0-alpha1 Marks an issue as being completely or in parts released in 8.3.0-alpha1 version:8.3.0 Marks an issue as being completely or in parts released in 8.3.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add a configuration option for maximum message size in zeebe client java
3 participants
@megglos @korthout @remcowesterhoud