You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2020/05/22 02:45:58 UTC

[james-project] 05/06: JAMES-3140 Documentation for blobStore cache

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

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit d08d3de1bd5604bf58690b388d8f4aa116f03fa5
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Wed Apr 22 16:29:19 2020 +0700

    JAMES-3140 Documentation for blobStore cache
---
 src/site/xdoc/server/config-blobstore.xml | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/src/site/xdoc/server/config-blobstore.xml b/src/site/xdoc/server/config-blobstore.xml
index 63b7177..8f7997f 100644
--- a/src/site/xdoc/server/config-blobstore.xml
+++ b/src/site/xdoc/server/config-blobstore.xml
@@ -49,6 +49,35 @@
                 <dd>hybrid: Using both objectstorage for unfrequently read or big blobs &amp; cassandra for small, often read blobs</dd>
             </dl>
 
+
+            <subsection name="Cassandra BlobStore Cache">
+                <p>A Cassandra cache can be enabled to reduce latency when reading small blobs frequently.
+                    A dedicated keyspace with a replication factor of one is then used.
+                    Cache eviction policy is TTL based.
+                    Only blobs below a given threshold will be stored.
+                    To be noted that blobs are stored within a single Cassandra row, hence a low threshold should be used.
+                </p>
+                <dl>
+                    <dt><strong>cache.enable</strong></dt>
+                    <dd>DEFAULT: false, optional, must be a boolean. Whether the cache should be enabled.</dd>
+                </dl>
+                <dl>
+                    <dt><strong>cache.cassandra.ttl</strong></dt>
+                    <dd>DEFAULT: 7 days, optional, must be a duration. Cache eviction policy is TTL based. </dd>
+                </dl>
+                <dl>
+                    <dt><strong>cache.cassandra.timeout</strong></dt>
+                    <dd>DEFAULT: 100ms, optional, must be a duration, cannot exceed 1 hour.
+                        Timeout after which this cache should be bypassed.</dd>
+                </dl>
+                <dl>
+                    <dt><strong>cache.sizeThresholdInBytes</strong></dt>
+                    <dd>DEFAULT: 8192, optional, must be a positive integer. Unit: bytes.
+                        Supported units: bytes, Kib, MiB, GiB, TiB
+                        Maximum size of stored objects expressed in bytes.</dd>
+                </dl>
+            </subsection>
+
             <subsection name="Hybrid BlobStore size threshold">
                 <dl>
                     <dt><strong>hybrid.size.threshold</strong></dt>
@@ -194,4 +223,3 @@
     </body>
 
 </document>
-


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org