sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve documentation

Browse Source 
Co-authored-by: Martin <github@diemattels.at>
This commit is contained in:
kobergj
2023-07-25 11:08:04 +02:00
committed by jkoberg
co-authored by Martin
parent 89785d0976
commit 31226e2134
3 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changelog/unreleased/configurable_max_message_size.md
+1 -1
View File
@@ -1,4 +1,4 @@
Enhancement: configure max message size
Enhancement: configure max grpc message size
Add a configuration option for the grpc max message size
docs/services/general-info/additional-information.md
+4 -5
View File
@@ -10,11 +10,10 @@ geekdocCollapseSection: true
This section contains information on general topics
## GRPC Maximum message size
## GRPC Maximum Message Size
Ocis is using grpc for inter service communication. When having a folder with a lot of files (25000+, size doesn't matter) and doing a `PROPFIND` on the folder, the server will run into errors because the
grpc message body gets to big. We introduced the envvar `OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE` to raise the max size for the grpc body.
ocis is using grpc for inter-service communication. When having a folder with a lot of files (25.000+, the size does not matter) and doing a `PROPFIND` on that folder, the server will run into errors. This is because the grpc message body becomes to big. With introduction of the envvar `OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE`, the max size for the grpc body can be raised.
NOTE: With a certain amount of files even raising the grpc message size will not suffice as the requests will run into network timeouts. Also generally the more files are in a folder, the longer it will take to load.
NOTE: With a certain amount of files even raising the grpc message size will not suffice as the requests will run into network timeouts. Also generally the more files are in a folder, the longer it will take time to load.
It is recommended to use `OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE` only temporary to copy files out of the folder (e.g. via web ui) and use the default value in general.
It is recommended to use `OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE` only *temporary* to copy files out of the folder (like via the web ui) and use the default value in general.
ocis-pkg/shared/shared_types.go
+1 -1
View File
@@ -84,5 +84,5 @@ type Commons struct {
// NOTE: you will not fing GRPCMaxReceivedMessageSize size being used in the code. The envvar is actually extracted in revas `pool` package: https://github.com/cs3org/reva/blob/edge/pkg/rgrpc/todo/pool/connection.go
// It is mentioned here again so it is documented
GRPCMaxReceivedMessageSize int `env:"OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE" desc:"The maximum body size for grpc requests. Defaults to '10240000'. Note that large values can potentially hide errors and can cause network timeouts. Can be used temporarily to repair unaccessable large folders (25000+ files)"`
GRPCMaxReceivedMessageSize int `env:"OCIS_GRPC_MAX_RECEIVED_MESSAGE_SIZE" desc:"The maximum body size for grpc requests. Defaults to '10240000' bytes (10MB). Note that large values can potentially hide errors but may lead to network timeouts. Should only be changed temporarily to regain access for large folders with 25.000+ files to copy out data."`
}