[karaf-decanter] branch main updated: Update user guide with max.request.size for the socket collector

[jb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/karaf-decanter.git


The following commit(s) were added to refs/heads/main by this push:
     new d775c95  Update user guide with max.request.size for the socket collector
d775c95 is described below

commit d775c956ce5cd79be4c56108998373bea94e4eb7
Author: Jean-Baptiste Onofré <jb...@apache.org>
AuthorDate: Mon Sep 6 14:25:10 2021 +0200

    Update user guide with max.request.size for the socket collector
---
 manual/src/main/asciidoc/user-guide/collectors.adoc | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/manual/src/main/asciidoc/user-guide/collectors.adoc b/manual/src/main/asciidoc/user-guide/collectors.adoc
index 8cd1c47..4f45f64 100644
--- a/manual/src/main/asciidoc/user-guide/collectors.adoc
+++ b/manual/src/main/asciidoc/user-guide/collectors.adoc
@@ -683,6 +683,9 @@ This feature installs a default `etc/org.apache.karaf.decanter.collector.socket.
 # Unmarshaller to use
 # Unmarshaller is identified by data format. The default is json, but you can use another unmarshaller
 unmarshaller.target=(dataFormat=json)
+
+# The maximum request size (in bytes). Set to -1 not to put any limit on the request size.
+max.request.size=100000
 ----
 
 * the `port` property contains the port number where the network socket collector is listening
@@ -691,6 +694,7 @@ unmarshaller.target=(dataFormat=json)
 * the `protocol` property contains the protocol used by the collector for transferring data with the client
 * the `unmarshaller.target` property contains the unmarshaller used by the collector to transform the data
 sent by the client.
+* the `max.request.size` is the size (in bytes) that the collector can accept. By default, it's bounded to prevent high memory consumption. You can use `-1` to disable any limit.
 
 ==== JMS