ElasticSearchClientServiceImpl

Description

Un service de contrôleur pour l’accès à un client Elasticsearch, en utilisant le client REST Elasticsearch (de bas niveau).

Balises

client, elasticsearch, elasticsearch6, elasticsearch7, elasticsearch8

Propriétés

Dans la liste ci-dessous, les propriétés requises sont signalées par un astérisque (*). Les autres propriétés sont considérées comme facultatives. La table indique également les valeurs par défaut et précise si une propriété prend en charge le langage d’expression NiFi.

Nom d’affichage

Nom d’API

Valeur par défaut

Valeurs autorisées

Description

API Key *

api-key

Clé d’API codée.

ID de clé d’API*

api-key-id

Identifiant unique de la clé d’API.

Régime d’autorisation *

authorization-scheme

BASIC

  • Aucun(e)

  • PKI

  • De base

  • API Key

  • JWT

Schéma d’autorisation utilisé pour l’authentification facultative auprès d’Elasticsearch.

Jeu de caractères *

el-cs-charset

UTF-8

Le jeu de caractères à utiliser pour interpréter la réponse d’Elasticsearch.

Délai d’expiration de la connexion *

el-cs-connect-timeout

5000

Contrôle la durée, en millisecondes, avant qu’un délai d’expiration ne se produise lors d’une tentative de connexion.

Activer la compression *

el-cs-enable-compression

false

  • true

  • false

Si le client REST doit compresser les requêtes en utilisant l’encodage de contenu gzip et ajouter l’en-tête Accept-Encoding : gzip pour recevoir des réponses compressées

Hôtes HTTP *

el-cs-http-hosts

Une liste d’hôtes HTTP séparés par des virgules qui hébergent des nœuds de requête Elasticsearch.Les hôtes HTTP doivent être des URIs valides, y compris le protocole, le domaine et le port pour chaque entrée.Par exemple https://elasticsearch1:9200, https://elasticsearch2:9200. Notez que l’hôte est inclus dans les requêtes en tant qu’en-tête (incluant généralement le domaine et le port, par exemple elasticsearch:9200).

Sélecteur de nœud *

el-cs-node-selector

ANY

  • N’importe quel

  • Ignorer les nœuds maîtres dédiés

Sélectionne les nœuds Elasticsearch qui peuvent recevoir des requêtes. Utilisé pour éloigner les requêtes des nœuds maîtres Elasticsearch dédiés

Fournisseur de jeton d’accès OAuth2 *

el-cs-oauth2-token-provider

Le fournisseur de jeton d’accès OAuth2 utilisé pour fournir JWTs pour l’autorisation par jeton porteur avec Elasticsearch.

Mot de passe *

el-cs-password

Le mot de passe à utiliser avec la sécurité XPack.

Préfixe du chemin

el-cs-path-prefix

Paramètre le préfixe du chemin pour chaque requête utilisée par le client http. Par exemple, si ce paramètre est fixé à /mon/chemin, toute requête du client deviendra /mon/chemin/ + point de terminaison. En fait, le point de terminaison de chaque requête est préfixé par ce pathPrefix. Le préfixe de chemin est utile lorsque Elasticsearch se trouve derrière un proxy qui fournit un chemin de base ou un proxy qui exige que tous les chemins commencent par / ; il n’est pas destiné à d’autres fins et ne doit pas être fourni dans d’autres scénarios

Exécuter en tant qu’utilisateur

el-cs-run-as-user

Le nom d’utilisateur à usurper dans Elasticsearch.

Envoyer l’en-tête méta *

el-cs-send-meta-header

true

  • true

  • false

Envoi ou non d’un en-tête X-Elastic-Client-Meta décrivant l’environnement d’exécution. Elle contient des informations similaires à celles que l’on peut trouver dans User-Agent. L’utilisation d’un en-tête distinct permet aux applications d’utiliser User-Agent pour leurs propres besoins, par exemple pour identifier la version de l’application ou d’autres informations relatives à l’environnement

Détecter automatiquement les nœuds du cluster *

el-cs-sniff-cluster-nodes

false

  • true

  • false

Recherchez périodiquement les nœuds du cluster Elasticsearch via l’API Elasticsearch Node Info. Si les fonctions de sécurité d’Elasticsearch sont activées (par défaut true pour 8.x+), l’utilisateur d’Elasticsearch doit avoir le privilège « monitor » ou « manage » cluster pour utiliser ce site API. Notez que tous les hôtes HTTP (et ceux qui peuvent être découverts dans le cluster à l’aide du Sniffer) doivent avoir le même protocole, par exemple http ou https, et être joignables à l’aide des mêmes paramètres client. Enfin, le network.publish_host d’Elasticsearch doit correspondre à l’une des entrées de la liste network.bind_host, voir https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html pour plus d’informations

Identifier l’échec *

el-cs-sniff-failure

false

  • true

  • false

Détecter le reniflage en cas d’échec, ce qui signifie qu’après chaque échec, la liste des nœuds Elasticsearch est mise à jour immédiatement plutôt que lors de la ronde de reniflage ordinaire suivante

Délai d’échec de la détection *

el-cs-sniffer-failure-delay

1 minute

Délai entre l’échec d’une requête Elasticsearch et la mise à jour des nœuds de clustering disponibles à l’aide du Sniffer

Intervalle de détection *

el-cs-sniffer-interval

5 minutes

Intervalle entre les opérations de reniflage du clustering

Délai d’expiration de la requête du Sniffer *

el-cs-sniffer-request-timeout

1 seconde

Délai d’expiration du renifleur de cluster pour les requêtes d’informations sur les nœuds

Délai d’expiration de la lecture *

el-cs-socket-timeout

60000

Contrôle la durée, en millisecondes, avant qu’un délai d’expiration ne se produise lors de l’attente d’une réponse.

Service contextuel SSL

el-cs-ssl-context-service

Le service de contexte SSL utilisé pour fournir des informations sur les certificats des clients pour les connexions TLS/SSL. Ce service ne s’applique que si le(s) point(s) de terminaison d’Elasticsearch ont été sécurisés avec TLS/SSL.

Dépréciation stricte *

el-cs-strict-deprecation

false

  • true

  • false

Le client REST doit-il renvoyer toute réponse contenant au moins un en-tête d’avertissement comme un échec ?

Supprimer les valeurs nulles/vides *

el-cs-suppress-nulls

always-suppress

  • Ne jamais supprimer

  • Toujours supprimer

Indique comment le rédacteur doit traiter les champs vides et nuls (y compris les objets et les tableaux)

NomUtilisateur *

el-cs-username

Le nom d’utilisateur à utiliser avec la sécurité XPack.

Secret partagé JWT *

jwt-shared-secret

Secret partagé du domaine d’authentification JWT.

Service de configuration du proxy

service proxy-configuration

Spécifie le Controller Service de configuration proxy pour les requêtes réseau proxy.

Gestion de l’État

Ce composant ne stocke pas d’état.

Restreint

Cette composante n’est pas limitée.

Considérations relatives aux ressources du système

Ce composant ne précise pas les ressources du système à prendre en compte.