gresockj commented on code in PR #6658: URL: https://github.com/apache/nifi/pull/6658#discussion_r1103780177
########## nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-client-service/src/main/resources/docs/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/additionalDetails.html: ########## @@ -0,0 +1,54 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>ElasticSearchClientServiceImpl</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> + +<h2>Sniffing</h2> +<p> + The Elasticsearch Sniffer can be used to locate Elasticsearch Nodes within a Cluster to which you are connecting. + This can be beneficial if your cluster dynamically changes over time, e.g. new Nodes are added to maintain performance during heavy load. +</p> +<p> + Sniffing can also be used to update the list of Hosts within the Cluster if a connection Failure is encountered during operation. + In order to "Sniff on Failure", you <b>must</b> also enable "Sniff Cluster Nodes". +</p> +<p> + Not all situations make sense to use Sniffing, for example if: + <ul> + <li>Elasticsearch is situated behind a load balancer, which dynamically routes connections from NiFi</li> + <li>Elasticsearch is on a different network to NiFi</li> + </ul> +</p> +<p> + There may also be need to set some of the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html";> + Elasticsearch Networking Advanced Settings</a>, such as <code>network.publish_host</code> to ensure that + the HTTP Hosts found by the Sniffer are accessible by NiFi. For example, Elasticsearch may use a network internal + <code>publish_address</code> that is inaccessible to NiFi, but instead should use an address/IP that NiFi understands. + It may also be necessary to add this same address to Elasticsearch's <code>network.bind_address</code> list. Review Comment: `network.bind_host` ########## nifi-nar-bundles/nifi-elasticsearch-bundle/nifi-elasticsearch-client-service-api/src/main/java/org/apache/nifi/elasticsearch/ElasticSearchClientService.java: ########## @@ -161,6 +157,118 @@ public interface ElasticSearchClientService extends ControllerService, Verifiabl .required(true) .build(); + PropertyDescriptor COMPRESSION = new PropertyDescriptor.Builder() + .name("el-cs-enable-compression") + .displayName("Enable Compression") + .description("Whether the REST client should compress requests using gzip content encoding and add the " + + "\"Accept-Encoding: gzip\" header to receive compressed responses") + .allowableValues("true", "false") + .defaultValue("false") + .required(true) + .build(); + + PropertyDescriptor SEND_META_HEADER = new PropertyDescriptor.Builder() + .name("el-cs-send-meta-header") + .displayName("Send Meta Header") + .description("Whether to send a \"X-Elastic-Client-Meta\" header that describes the runtime environment. " + + "It contains information that is similar to what could be found in User-Agent. " + + "Using a separate header allows applications to use User-Agent for their own needs, " + + "e.g. to identify application version or other environment information") + .allowableValues("true", "false") + .defaultValue("true") + .required(true) + .build(); + + PropertyDescriptor STRICT_DEPRECATION = new PropertyDescriptor.Builder() + .name("el-cs-strict-deprecation") + .displayName("Strict Deprecation") + .description("Whether the REST client should return any response containing at least one warning header as a failure") + .allowableValues("true", "false") + .defaultValue("false") + .required(true) + .build(); + + AllowableValue NODE_SELECTOR_ANY = new AllowableValue("ANY", "Any", + "Select any Elasticsearch node to handle requests"); + AllowableValue NODE_SELECTOR_SKIP_DEDICATED_MASTERS = new AllowableValue("SKIP_DEDICATED_MASTERS", "Skip Dedicated Masters", + "Skip dedicated Elasticsearch master nodes for handling request"); + + PropertyDescriptor NODE_SELECTOR = new PropertyDescriptor.Builder() + .name("el-cs-node-selector") + .displayName("Node Selector") + .description("Selects Elasticsearch nodes that can receive requests. Used to keep requests away from dedicated Elasticsearch master nodes") + .allowableValues(NODE_SELECTOR_ANY, NODE_SELECTOR_SKIP_DEDICATED_MASTERS) + .defaultValue(NODE_SELECTOR_ANY.getValue()) + .required(true) + .build(); + + PropertyDescriptor PATH_PREFIX = new PropertyDescriptor.Builder() + .name("el-cs-path-prefix") + .displayName("Path Prefix") + .description("Sets the path's prefix for every request used by the http client. " + + "For example, if this is set to \"/my/path\", then any client request will become \"/my/path/\" + endpoint. " + + "In essence, every request's endpoint is prefixed by this pathPrefix. " + + "The path prefix is useful for when Elasticsearch is behind a proxy that provides a base path or a proxy that requires all paths to start with '/'; " + + "it is not intended for other purposes and it should not be supplied in other scenarios") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .build(); + + PropertyDescriptor SNIFF_CLUSTER_NODES = new PropertyDescriptor.Builder() + .name("el-cs-sniff-cluster-nodes") + .displayName("Sniff Cluster Nodes") + .description("Periodically sniff for nodes within the Elasticsearch cluster via the Elasticsearch Node Info API. " + + "If Elasticsearch security features are enabled (default to \"true\" for 8.x+), the Elasticsearch user must " + + "have the \"monitor\" or \"manage\" cluster privilege to use this API." + + "Note that all " + HTTP_HOSTS.getDisplayName() + " (and those that may be discovered within the cluster " + + "using the Sniffer) must use the same protocol, e.g. http or https, and be contactable using the same client settings. " + + "Finally the Elasticsearch \"network.publish_address\" must match one of the \"network.bind_address(es)\" " + Review Comment: I'm assuming you mean [network.publish_host](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html#advanced-network-settings) and `network.bind_host` here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
