(nifi) branch support/nifi-1.x updated: NIFI-12322 Added resource usage note in ES Client CS documentation

[ex...@apache.org]

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

exceptionfactory pushed a commit to branch support/nifi-1.x
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/support/nifi-1.x by this push:
     new 50fd8c432e NIFI-12322 Added resource usage note in ES Client CS documentation
50fd8c432e is described below

commit 50fd8c432eaf8cdcd0a6d908ff7800c1bb043261
Author: Pierre Villard <pi...@gmail.com>
AuthorDate: Mon Nov 6 18:22:50 2023 +0100

    NIFI-12322 Added resource usage note in ES Client CS documentation
    
    This closes #7986
    
    Signed-off-by: David Handermann <ex...@apache.org>
    (cherry picked from commit b24249c8508949c9945de03c52dea84f3f1da2f4)
---
 .../additionalDetails.html                                     | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-client-service/src/main/resources/docs/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/additionalDetails.html b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-client-service/src/main/resources/docs/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/additionalDetails.html
index f0934cafe6..5a563e7554 100644
--- a/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-client-service/src/main/resources/docs/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/additionalDetails.html
+++ b/nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-client-service/src/main/resources/docs/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/additionalDetails.html
@@ -50,5 +50,15 @@
     Elasticsearch sniffing best practices: What, when, why, how</a> for more details of the best practices.
 </p>
 
+<h2>Resources Usage Consideration</h2>
+
+<p>
+    This Elasticsearch client relies on a <code>RestClient</code> using the Apache HTTP Async Client. By default, it will start one
+    dispatcher thread, and a number of worker threads used by the connection manager. There will be as many worker thread as the number
+    of locally detected processors/cores on the NiFi host. Consequently, it is highly recommended to have only one instance of this
+    controller service per remote Elasticsearch destination and have this controller service shared across all of the Elasticsearch
+    processors of the NiFi flows. Having a very high number of instances could lead to resource starvation and result in OOM errors.
+</p>
+
 </body>
 </html>
\ No newline at end of file