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 6eabc527ea2399f662db28c46780905a7be9050a
Author: Rene Cordier <rcord...@linagora.com>
AuthorDate: Thu Oct 3 15:36:17 2019 +0700
JAMES-2760 Update of RabbitMQ properties and documentation for the new
metrics parameter on the mail queue size
---
.../destination/conf/rabbitmq.properties | 10 +++++++++-
.../destination/conf/rabbitmq.properties | 10 +++++++++-
src/site/xdoc/server/config-rabbitmq.xml | 16 +++++++++++++---
3 files changed, 31 insertions(+), 5 deletions(-)
diff --git
a/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/rabbitmq.properties
b/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/rabbitmq.properties
index 1f8b774..ff1f2a4 100644
---
a/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/rabbitmq.properties
+++
b/dockerfiles/run/guice/cassandra-rabbitmq-ldap/destination/conf/rabbitmq.properties
@@ -27,4 +27,12 @@ mailqueue.view.bucketCount=1
# Too little value will lead to unnecessary reads. Too big value will lead to
more expensive browse.
# Choose this parameter so that it get's update one time every one-two
sliceWindow
# Optional, default 1000
-mailqueue.view.updateBrowseStartPace=1000
\ No newline at end of file
+mailqueue.view.updateBrowseStartPace=1000
+
+# Enables or disables the gauge metric on the mail queue size
+# Computing the size of the mail queue is currently implemented on top of
browse operation and thus have a linear complexity
+# Metrics get exported periodically as configured in elasticsearch.properties,
thus getSize is also called periodically
+# Choose to disable it when the mail queue size is getting too big
+# Note that this is as well a temporary workaround until we get 'getSize'
method better optimized
+# Optional, default true
+mailqueue.size.metricsEnabled=true
\ No newline at end of file
diff --git
a/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties
b/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties
index 1f8b774..ff1f2a4 100644
---
a/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties
+++
b/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties
@@ -27,4 +27,12 @@ mailqueue.view.bucketCount=1
# Too little value will lead to unnecessary reads. Too big value will lead to
more expensive browse.
# Choose this parameter so that it get's update one time every one-two
sliceWindow
# Optional, default 1000
-mailqueue.view.updateBrowseStartPace=1000
\ No newline at end of file
+mailqueue.view.updateBrowseStartPace=1000
+
+# Enables or disables the gauge metric on the mail queue size
+# Computing the size of the mail queue is currently implemented on top of
browse operation and thus have a linear complexity
+# Metrics get exported periodically as configured in elasticsearch.properties,
thus getSize is also called periodically
+# Choose to disable it when the mail queue size is getting too big
+# Note that this is as well a temporary workaround until we get 'getSize'
method better optimized
+# Optional, default true
+mailqueue.size.metricsEnabled=true
\ No newline at end of file
diff --git a/src/site/xdoc/server/config-rabbitmq.xml
b/src/site/xdoc/server/config-rabbitmq.xml
index 9d395ea..9a375da 100644
--- a/src/site/xdoc/server/config-rabbitmq.xml
+++ b/src/site/xdoc/server/config-rabbitmq.xml
@@ -75,7 +75,7 @@
<dt><strong>mailqueue.view.sliceWindow</strong></dt>
<dd>
James divide the view into slices, each slice contains data for
a given period, sliceWindow parameter controls this period.
- This dividing of periods allows faster browsing of the mail
queue. Tips for choosing sliceWindow is explained in
+ This dividing of periods allows faster browsing of the mail
queue. Tips for choosing sliceWindow are explained in
<a
href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties";>rabbitmq.properties</a>
</dd>
@@ -83,7 +83,7 @@
<dd>
Mails in a mail queue are distributed across the underlying
storage service.
BucketCount describes how to be distributing mails to fit with
your James setup
- Tips for choosing bucketCount is explained in
+ Tips for choosing bucketCount are explained in
<a
href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties";>rabbitmq.properties</a>
</dd>
@@ -91,7 +91,17 @@
<dd>
To browse, James needs a starting point and to continuously
update that point in runtime.
UpdateBrowseStartPace describes the probability to update the
starting point.
- Tips for choosing updateBrowseStartPace is explained in
+ Tips for choosing updateBrowseStartPace are explained in
+ <a
href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties";>rabbitmq.properties</a>
+ </dd>
+
+ <dt><strong>mailqueue.size.metricsEnabled</strong></dt>
+ <dd>
+ By default, the metrics are enabled for the mail queue size.
+ As computing the size of the mail queue is currently implemented
on top of browse operation and thus have a linear complexity,
+ sometimes it can get too big, making it impossible for the ES
reporter to handle it correctly without crashing.
+ It can be useful then to disable it.
+ Tips for choosing metricsEnabled are explained in
<a
href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra-rabbitmq/destination/conf/rabbitmq.properties";>rabbitmq.properties</a>
</dd>
</dl>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
