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.

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

Update documentation to reflect protobuf limitation of 2GB #6623

Open
easwars opened this issue Sep 12, 2023 · 4 comments
Open

Update documentation to reflect protobuf limitation of 2GB #6623

easwars opened this issue Sep 12, 2023 · 4 comments
Labels
fixit P2 Type: Documentation Documentation or examples

Comments

@easwars
Copy link
Contributor

easwars commented Sep 12, 2023

Based on the internal post https://yaqs.corp.google.com/eng/q/4724221033530261504#a1n3, the protobuf team is adding documentation about the 2GiB limit of protobuf message size. We should probably link to that, from our call options: MaxCallRecvMsgSize and MaxCallSendMsgSize

See internal update to the doc: https://critique.corp.google.com/cl/564773603

@easwars easwars added Type: Documentation Documentation or examples fixit P2 labels Sep 12, 2023
@dfawley
Copy link
Member

dfawley commented Sep 19, 2023

We should probably link to that, from our call options: MaxCallRecvMsgSize and MaxCallSendMsgSize

It's fine to mention it, but of course protobuf isn't the only codec we support, so things should be written with that in mind.

@arvindbr8
Copy link
Member

@easwars -- does that mean our default here is slightly more than supported?

// `math.MaxInt32`.

MaxInt32 = 2.147483647 GB

@arvindbr8
Copy link
Member

@easwars -- I have a feeling we might confuse users by mentioning the limit thats limited to protobuf encoding. Do you still strongly feel that we should include it?

@easwars
Copy link
Contributor Author

easwars commented Sep 29, 2023

I understand that users who deal with messages which are anywhere close to this size are a very very small fraction, and putting this detail in the docstring might confuse others. So, I'm ok closing this or mentioning this is one of our examples/guides dealing with encoding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fixit P2 Type: Documentation Documentation or examples
Projects
None yet
Development

No branches or pull requests

3 participants