This is an automated email from the ASF dual-hosted git repository.
scottyaslan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/master by this push:
new 3ce5d93 NIFI-6176 Improve description for
nifi.cluster.load.balance.max.thread.count property in Admin Guide
3ce5d93 is described below
commit 3ce5d935a5274e13b76e573cafeb799416303feb
Author: Andrew Lim <[email protected]>
AuthorDate: Thu Apr 11 14:59:23 2019 -0400
NIFI-6176 Improve description for
nifi.cluster.load.balance.max.thread.count property in Admin Guide
---
nifi-docs/src/main/asciidoc/administration-guide.adoc | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/nifi-docs/src/main/asciidoc/administration-guide.adoc
b/nifi-docs/src/main/asciidoc/administration-guide.adoc
index 1effe14..16d79f7 100644
--- a/nifi-docs/src/main/asciidoc/administration-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/administration-guide.adoc
@@ -2593,7 +2593,9 @@ the `WriteAheadProvenanceRepository`, it cannot be
changed back to the `Persiste
become before the Repository starts writing to a new Index. Large
values for the shard size will result in more Java heap usage when searching
the Provenance Repository but should
provide better performance. The default value is `500 MB`. However,
this is due to the fact that defaults are tuned for very small environments
where most users begin to use NiFi.
For production environments, it is advisable to change this value to
`4` to `8 GB`. Once all Provenance Events in the index have been aged off from
the "event files," the index
- will be destroyed as well. *Note:* this value should be smaller than
(no more than half of) the `nifi.provenance.repository.max.storage.size`
property.
+ will be destroyed as well.
+
+ *NOTE:* This value should be smaller than (no more than half of) the
`nifi.provenance.repository.max.storage.size` property.
|`nifi.provenance.repository.max.attribute.length`|Indicates the maximum
length that a FlowFile attribute can be when retrieving a Provenance Event from
the repository.
If the length of any attribute exceeds this value, it will be truncated
when the event is retrieved. The default value is `65536`.
|`nifi.provenance.repository.concurrent.merge.threads`|Apache Lucene creates
several "segments" in an Index. These segments are periodically merged together
in order to provide faster
@@ -3113,7 +3115,9 @@ long time before starting processing if we reach at least
this number of nodes i
|`nifi.cluster.load.balance.port`|Specifies the port to listen on for incoming
connections for load balancing data across the cluster. The default value is
`6342`.
|`nifi.cluster.load.balance.host`|Specifies the hostname to listen on for
incoming connections for load balancing data across the cluster. If not
specified, will default to the value used by the `nifi.cluster.node.address`
property.
|`nifi.cluster.load.balance.connections.per.node`|The maximum number of
connections to create between this node and each other node in the cluster. For
example, if there are 5 nodes in the cluster and this value is set to 4, there
will be up to 20 socket connections established for load-balancing purposes (5
x 4 = 20). The default value is `4`.
-|`nifi.cluster.load.balance.max.thread.count`|The maximum number of threads to
use for transferring data from this node to other nodes in the cluster. If this
value is set to 8, for example, there will be up to 8 threads responsible for
transferring data to other nodes, regardless of how many nodes are in the
cluster. While a given thread can only write to a single socket at a time, a
single thread is capable of servicing multiple connections simultaneously
because a given connection may [...]
+|`nifi.cluster.load.balance.max.thread.count`|The maximum number of threads to
use for transferring data from this node to other nodes in the cluster. While a
given thread can only write to a single socket at a time, a single thread is
capable of servicing multiple connections simultaneously because a given
connection may not be available for reading/writing at any given time. The
default value is `8`—i.e., up to 8 threads will be responsible for transferring
data to other nodes, regardl [...]
+
+*NOTE:* Increasing this value will allow additional threads to be used for
communicating with other nodes in the cluster and writing the data to the
Content and FlowFile Repositories. However, if this property is set to a value
greater than the number of nodes in the cluster multiplied by the number of
connections per node (`nifi.cluster.load.balance.connections.per.node`), then
no further benefit will be gained and resources will be wasted.
|`nifi.cluster.load.balance.comms.timeout`|When communicating with another
node, if this amount of time elapses without making any progress when reading
from or writing to a socket, then a TimeoutException will be thrown. This will
then result in the data either being retried or sent to another node in the
cluster, depending on the configured Load Balancing Strategy. The default value
is `30 sec`.
|====
