forked from delphix/virtualization-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for gRPC message and memory limits delphix#390
- Loading branch information
Showing
2 changed files
with
25 additions
and
3 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Metadata and Message Limits | ||
Operations that exceed their allowed metadata and/or message limits are terminated. | ||
|
||
### Maximum size for metadata | ||
The maximum size for metadata is 32 megabytes (`32MB`). | ||
|
||
The sum of bytes used for the `message`, `action`, and `output` fields within [User Visible Errors](/Best_Practices/User_Visible_Errors.md) count towards total size of metadata. | ||
|
||
### How to tell if the maximum metadata size was exceeded | ||
When an operation should fail with a `UserError`, but fails with a `RpcError` instead. | ||
|
||
### Maximum size for messages | ||
The maximum size for messages is 128 kibibytes (`128 KiB`). | ||
|
||
The following count towards the message size: | ||
1. [Platform library](/References/Platform_Libraries.md) arguments | ||
- Any arguments passed into a platform library will be included in the total message size. | ||
2. [Logging](/References/Logging.md) | ||
- The message provided to the logging function will be included in the total message size. | ||
|
||
### How to tell if the maximum message size was exceeded | ||
When a platform library or log callback fails with a `RpcError`. |
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