gnodet-bot commented on code in PR #30393:
URL: https://github.com/apache/camel/pull/30393#discussion_r4627888461


##########
components/camel-redis/src/main/docs/redis.adoc:
##########
@@ -10,3 +10,41 @@
 *Since Camel {since}*
 
 The Redis component provides an `AggregationStrategy` to use Redis as the 
backend datastore.
+
+== Storage format
+
+The `RedisAggregationRepository` stores each exchange in a Redis hash: the 
field is the correlation key as a string,
+and the value is the exchange (its body, headers, exchange properties and 
variables) in Java serialization.
+The codec configured on a `RedissonClient` given with the `redisson` option is 
not used for these hashes, unless it is
+also given with the `codec` option.
+
+When it reads an exchange back, the repository only accepts what the 
`deserializationFilter` option allows, a pattern
+in the syntax of the `jdk.serialFilter` system property. When the option is 
not set, the JVM-wide `jdk.serialFilter`
+applies if it is set, otherwise the default filter:
+
+----
+!java.net.**;java.**;javax.**;org.apache.camel.**;maxdepth=20;maxrefs=10000;maxbytes=10485760;!*
+----
+
+It allows the classes of the `java`, `javax` and `org.apache.camel` packages 
(except `java.net`) and rejects the other
+classes. It also limits the size of a stored exchange: `maxdepth=20` (the 
depth of the object graph), `maxrefs=10000`
+(the number of objects in it) and `maxbytes=10485760` (10 MB). An exchange 
over a limit cannot be read back, so its
+aggregation does not complete. This happens, for example, with a `List` body 
that collects more than 10000 strings, or
+with a body of more than 10 MB.

Review Comment:
   📖 **Doc nit:** `maxbytes=10485760` is 10 MiB (IEC), not 10 MB (SI)
   
   10,485,760 = 10 × 1,024² = 10 × 1,048,576 = 10 MiB. 10 MB (SI) would be 
10,000,000 bytes. Both occurrences in this paragraph should use `MiB`.
   
   ```suggestion
   (the number of objects in it) and `maxbytes=10485760` (10 MiB). An exchange 
over a limit cannot be read back, so its
   aggregation does not complete. This happens, for example, with a `List` body 
that collects more than 10000 strings, or
   with a body of more than 10 MiB.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to