Aller au contenu principal

Elasticsearch

Elasticsearch est un moteur de recherche et d'analyse distribué et open source pour tout type de données, y compris les données textuelles, numériques, géospatiales, structurées et non structurées.

Contenu du pack​

Modèles​

Le connecteur de supervision Elasticsearch apporte un modèle d'hôte :

  • App-DB-Elasticsearch-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescriptionDécouverte
Cluster-StatisticsApp-DB-Elasticsearch-Cluster-Statistics-customContrôle de l'état d'un cluster Elasticsearch
Indice-StatisticsApp-DB-Elasticsearch-Indice-Statistics-customContrôle les statistiques des index d'un cluster ElasticsearchX
LicenseApp-DB-Elasticsearch-License-customContrôle le statut de la licence
Node-StatisticsApp-DB-Elasticsearch-Node-Statistics-customContrôle les statistiques des noeuds dans un cluster ElasticsearchX

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-DB-Elasticsearch-custom est utilisé.

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte​

Découverte de services​

Nom de la règleDescription
App-DB-Elasticsearch-Indice-StatisticsContrôle les statistiques des indices d'un cluster Elasticsearch.
App-DB-Elasticsearch-Node-StatisticsContrôle les statistiques des noeuds dans un cluster Elasticsearch.

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

MétriqueUnité
statusN/A
nodes.total.countcount
nodes.data.countcount
nodes.coordinating.countcount
nodes.master.countcount
nodes.ingest.countcount
indices.total.countcount
shards.total.countcount
shards.active.countcount
shards.active.percentage%
shards.unassigned.countcount
shards.relocating.countcount
shards.initializing.countcount
tasks.pending.countcount
documents.total.countcount
data.size.bytesB

Prérequis​

Afin de superviser un cluster Elasticsearch, celui-ci doit être configuré comme indiqué dans la documentation officielle Elasticsearch.

Pour pouvoir communiquer avec le collecteur Centreon, l'API du noeud Elasticsearch doit utiliser le protocole HTTP et le port 9200.

Installer le connecteur de supervision​

Pack​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-applications-databases-elasticsearch
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Elasticsearch depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Applications-Databases-Elasticsearch

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte App-DB-Elasticsearch-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
ELASTICSEARCHUSERNAMEElasticsearch username
ELASTICSEARCHPASSWORDElasticsearch password
ELASTICSEARCHPROTOSpecify https if needed (default: 'http')http
ELASTICSEARCHPORTPort used (default: 9200)9200
ELASTICSEARCHEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
WARNINGDATASIZEWarning threshold
CRITICALDATASIZECritical threshold
WARNINGDOCUMENTSTOTALWarning threshold
CRITICALDOCUMENTSTOTALCritical threshold
WARNINGINDICESTOTALWarning threshold
CRITICALINDICESTOTALCritical threshold
WARNINGNODESCOORDINATINGWarning threshold
CRITICALNODESCOORDINATINGCritical threshold
WARNINGNODESDATAWarning threshold
CRITICALNODESDATACritical threshold
WARNINGNODESINGESTWarning threshold
CRITICALNODESINGESTCritical threshold
WARNINGNODESMASTERWarning threshold
CRITICALNODESMASTERCritical threshold
WARNINGNODESTOTALWarning threshold
CRITICALNODESTOTALCritical threshold
WARNINGSHARDSACTIVEWarning threshold
CRITICALSHARDSACTIVECritical threshold
WARNINGSHARDSINITIALIZINGWarning threshold
CRITICALSHARDSINITIALIZINGCritical threshold
WARNINGSHARDSRELOCATINGWarning threshold
CRITICALSHARDSRELOCATINGCritical threshold
WARNINGSHARDSTOTALWarning threshold
CRITICALSHARDSTOTALCritical threshold
WARNINGSHARDSUNASSIGNEDWarning threshold
CRITICALSHARDSUNASSIGNEDCritical threshold
WARNINGSTATUSDefine the conditions to match for the status to be WARNING (default: '%{status} =~ /yellow/i') You can use the following variables: %{status}%{status} =~ /yellow/i
CRITICALSTATUSDefine the conditions to match for the status to be CRITICAL (default: '%{status} =~ /red/i'). You can use the following variables: %{status}%{status} =~ /red/i
WARNINGTASKSPENDINGWarning threshold
CRITICALTASKSPENDINGCritical threshold
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_elasticsearch.pl \
    --plugin=database::elasticsearch::restapi::plugin \
    --mode=node-statistics \
    --hostname=10.0.0.1 \
    --port='9200' \
    --proto='http' \
    --username='' \
    --password=''  \
    --filter-name='' \
    --warning-jvm-heap-usage='' \
    --critical-jvm-heap-usage='' \
    --warning-disk-free='' \
    --critical-disk-free='' \
    --warning-documents-total='' \
    --critical-documents-total='' \
    --warning-data-size='' \
    --critical-data-size=''

La commande devrait retourner un message de sortie similaire à :

OK: All nodes are ok | '*nodes*#node.jvm.heap.usage.percentage'=20%;;;0;100'*nodes*#node.jvm.heap.usage.bytes'=36380302240B;;;0;137151119360;heap_max_in_bytes'*nodes*#node.disk.free.bytes'=1710072680448B;;;0;total_in_bytes'*nodes*#node.documents.total.count'=4362761044;;;0;'*nodes*#node.data.size.bytes'=1386278479651B;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_elasticsearch.pl \
    --plugin=database::elasticsearch::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
cluster-statistics [code]App-DB-Elasticsearch-Cluster-Statistics-custom
indice-statistics [code]App-DB-Elasticsearch-Indice-Statistics-custom
license [code]App-DB-Elasticsearch-License-custom
list-indices [code]Used for service discovery
list-nodes [code]Used for service discovery
node-statistics [code]App-DB-Elasticsearch-Node-Statistics-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--hostnameElasticsearch hostname.
--portPort used (default: 9200)
--protoSpecify https if needed (default: 'http')
--usernameElasticsearch username.
--passwordElasticsearch password.
--timeoutSet HTTP timeout
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy pac file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-optSet SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--filter-countersOnly display some counters (regexp can be used). Example: --filter-counters='^status$'
--warning-*Warning threshold. Can be: 'nodes-total', 'nodes-data', 'nodes-coordinating', 'nodes-master', 'nodes-ingest', 'indices-total', 'shards-total', 'shards-active-count', 'shards-active-percentage', 'shards-unassigned', 'shards-relocating', 'shards-initializing', 'tasks-pending', 'documents-total', 'data-size'.
--critical-*Critical threshold. Can be: 'nodes-total', 'nodes-data', 'nodes-coordinating', 'nodes-master', 'nodes-ingest', 'indices-total', 'shards-total', 'shards-active-count', 'shards-active-percentage', 'shards-unassigned', 'shards-relocating', 'shards-initializing', 'tasks-pending', 'documents-total', 'data-size'.
--warning-statusDefine the conditions to match for the status to be WARNING (default: '%{status} =~ /yellow/i') You can use the following variables: %{status}.
--critical-statusDefine the conditions to match for the status to be CRITICAL (default: '%{status} =~ /red/i'). You can use the following variables: %{status}.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_elasticsearch.pl \
    --plugin=database::elasticsearch::restapi::plugin \
    --mode=node-statistics \
    --help