Documentation
Table of Contents
6 Configuration d'Elasticsearch
La prise en charge d'Elasticsearch est expérimentale !
Zabbix prend en charge le stockage des données historiques au moyen d'Elasticsearch au lieu d'une base de données. Les utilisateurs peuvent choisir le lieu de stockage des données historiques entre une base de données compatible et Elasticsearch. La procédure de configuration décrite dans cette section s'applique à Elasticsearch version 7.X. Si une version antérieure ou ultérieure d'Elasticsearch est utilisée, certaines fonctionnalités peuvent ne pas fonctionner comme prévu.
Si toutes les données d'historique sont stockées dans Elasticsearch, les tendances ne sont pas calculées ni stockées dans la base de données. En l'absence de tendances calculées et stockées, la période de stockage de l'historique peut devoir être prolongée.
Configuration
Pour assurer une bonne communication entre tous les éléments impliqués, assurez-vous que les paramètres du fichier de configuration du serveur et du fichier de configuration frontal sont correctement configurés.
Serveur et interface Zabbix
Projet de fichier de configuration du serveur Zabbix avec les paramètres à mettre à jour :
### Option: HistoryStorageURL
# History storage HTTP[S] URL.
#
# Mandatory: no
# Default:
# HistoryStorageURL=
### Option: HistoryStorageTypes
# Comma separated list of value types to be sent to the history storage.
#
# Mandatory: no
# Default:
# HistoryStorageTypes=uint,dbl,str,log,textExemples de valeurs de paramètres pour remplir le fichier de configuration du serveur Zabbix :
Cette configuration force le serveur Zabbix à stocker les valeurs d'historique de types numériques dans la base de données correspondante et les données d'historique textuelles dans Elasticsearch.
Elasticsearch prend en charge les types d'éléments suivants :
Explication du type d'élément pris en charge :
| Type de valeur de l'élément | Table de base de données | Type Elasticsearch |
| Numérique (non signé) | history_uint | uint |
| Numérique (flottant) | history | dbl |
| Caractère | history_str | str |
| Journal | history_log | log |
| Texte | history_text | text |
Projet de fichier de configuration de l'interface Zabbix (conf/zabbix.conf.php) avec les paramètres à mettre à jour :
// Elasticsearch url (can be string if same url is used for all types).
$HISTORY['url'] = [
'uint' => 'http://localhost:9200',
'text' => 'http://localhost:9200'
];
// Value types stored in Elasticsearch.
$HISTORY['types'] = ['uint', 'text'];Exemples de valeurs de paramètres pour remplir le fichier de configuration de l'interface Zabbix :
Cette configuration oblige à stocker les valeurs d'historique Texte, Caractère et Journal dans Elasticsearch.
Il est également nécessaire de rendre $HISTORY global dans conf/zabbix.conf.php pour s'assurer que tout fonctionne correctement (voir conf/zabbix.conf.php.example pour savoir comment procéder) :
Installation d'Elasticsearch et création de mappage
Les deux dernières étapes pour faire fonctionner les choses consistent à installer Elasticsearch lui-même et à créer un processus de mappage.
Pour installer Elasticsearch, veuillez vous référer au guide d'installation d'Elasticsearch.
Le mappage est une structure de données dans Elasticsearch (similaire à une table dans une base de données). Le mappage de tous les types de données d'historique est disponible ici : database/elasticsearch/elasticsearch.map.
La création du mappage est obligatoire. Certaines fonctionnalités seront interrompues si le mappage n'est pas créé conformément aux instructions.
Pour créer un mappage pour le type text, envoyez la requête suivante à Elasticsearch :
curl -X PUT \
http://your-elasticsearch.here:9200/text \
-H 'content-type:application/json' \
-d '{
"settings": {
"index": {
"number_of_replicas": 1,
"number_of_shards": 5
}
},
"mappings": {
"properties": {
"itemid": {
"type": "long"
},
"clock": {
"format": "epoch_second",
"type": "date"
},
"value": {
"fields": {
"analyzed": {
"index": true,
"type": "text",
"analyzer": "standard"
}
},
"index": false,
"type": "text"
}
}
}
}'Une requête similaire doit être exécutée pour la création du mappage des valeurs d'historique Character et Log avec la correction de type correspondante.
Pour travailler avec Elasticsearch, veuillez consulter la page des exigences pour plus d'informations.
Le nettoyage ne supprime aucune donnée d'Elasticsearch.
Stockage des données d'historique dans plusieurs index basés sur la date
Cette section décrit les étapes supplémentaires requises pour travailler avec des pipelines et ingérer des nœuds.
Pour commencer, vous devez créer des modèles pour les index.
L'exemple suivant montre une demande de création de modèle uint :
curl -X PUT \
http://your-elasticsearch.here:9200/_template/uint_template \
-H 'content-type:application/json' \
-d '{
"index_patterns": [
"uint*"
],
"settings": {
"index": {
"number_of_replicas": 1,
"number_of_shards": 5
}
},
"mappings": {
"properties": {
"itemid": {
"type": "long"
},
"clock": {
"format": "epoch_second",
"type": "date"
},
"value": {
"type": "long"
}
}
}
}'Pour créer d'autres modèles, l'utilisateur doit modifier l'URL (la dernière partie est le nom du modèle), modifiez le champ "index_patterns" pour qu'il corresponde au nom de l'index et pour définir un mappage valide, qui peut être extrait de database/elasticsearch/elasticsearch.map.
Par exemple, la commande suivante peut être utilisée pour créer un modèle pour l'index de texte :
curl -X PUT \
http://your-elasticsearch.here:9200/_template/text_template \
-H 'content-type:application/json' \
-d '{
"index_patterns": [
"text*"
],
"settings": {
"index": {
"number_of_replicas": 1,
"number_of_shards": 5
}
},
"mappings": {
"properties": {
"itemid": {
"type": "long"
},
"clock": {
"format": "epoch_second",
"type": "date"
},
"value": {
"fields": {
"analyzed": {
"index": true,
"type": "text",
"analyzer": "standard"
}
},
"index": false,
"type": "text"
}
}
}
}'Ceci est nécessaire pour permettre à Elasticsearch de définir un mappage valide pour les index créés automatiquement. Ensuite, il est nécessaire de créer la définition du pipeline. Le pipeline est une sorte de prétraitement des données avant de pousserles données dans des index. La commande suivante peut être utilisée pour créer un pipeline pour l'index uint :
curl -X PUT \
http://your-elasticsearch.here:9200/_ingest/pipeline/uint-pipeline \
-H 'content-type:application/json' \
-d '{
"description": "daily uint index naming",
"processors": [
{
"date_index_name": {
"field": "clock",
"date_formats": [
"UNIX"
],
"index_name_prefix": "uint-",
"date_rounding": "d"
}
}
]
}'L'utilisateur peut modifier le paramètre d'arrondi ("date_arrondi") pour définir une période de rotation spécifique de l'index Pour créer d'autres pipelines, l'utilisateur doit changer l'URL (la dernière partie est le nom du pipeline) et changer le champ "index_name_prefix" pour correspondre au nom de l'index.
Voir également la documentation Elasticsearch.
De plus, le stockage des données d'historique dans plusieurs index basés sur la date devrait également être activé dans le nouveau paramètre de la configuration du serveur Zabbix :
### Option: HistoryStorageDateIndex
# Enable preprocessing of history values in history storage to store values in different indices based on date.
# 0 - disable
# 1 - enable
#
# Mandatory: no
# Default:
# HistoryStorageDateIndex=0Dépannage
Les étapes suivantes peuvent vous aider à résoudre les problèmes liés à la configuration d'Elasticsearch :
- Vérifiez si le mappage est correct (demande GET à l'URL d'index requise comme
http://localhost:9200/uint). - Vérifiez si les fragments ne sont pas en état d'échec (le redémarrage d'Elasticsearch devrait aider).
- Vérifiez la configuration d'Elasticsearch. La configuration doit autoriser l'accès depuis l'hôte frontal Zabbix et l'hôte du serveur Zabbix.
- Vérifiez les journaux Elasticsearch.
Si vous rencontrez toujours des problèmes avec votre installation, veuillez créer un rapport de bogue avec toutes les informations de cette liste (mappage, journaux d'erreurs, configuration, version, etc.)