From b24249c8508949c9945de03c52dea84f3f1da2f4 Mon Sep 17 00:00:00 2001
From: Pierre Villard
Date: Mon, 6 Nov 2023 18:22:50 +0100
Subject: [PATCH] NIFI-12322 Added resource usage note in ES Client CS
documentation
This closes #7986
Signed-off-by: David Handermann
---
.../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 for more details of the best practices.
+Resources Usage Consideration
+
+
+ This Elasticsearch client relies on a RestClient
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.
+
+