Elasticvue
Elasticvue : client ElasticSearch dans un navigateur
Sébastien Moysan, Responsable Technique @DeliaTechnologies
April 12, 2023
10 min
Elasticvue est un client Elasticsearch libre et open-source disponible en tant qu’extension sur les principaux navigateurs (Chrome, Firefox et Edge). Très simple à installer et à paramétrer, il offre les fonctionnalités essentielles attendues d’un client Elasticsearch.
Elasticvue offre les fonctionnalités suivantes:
Elasticvue est une extension disponible sur plusieurs navigateurs (Chrome, Firefox, Edge), elle est par conséquent très simple à installer par l’intermédiaire du store d’extensions du navigateur concerné :
L’interface est accessible en cliquant sur le raccourci de l’extension dans la barre chrome.
Après installation, il suffit de configurer les éléments de connexion au cluster Elasticsearch.
L’accès au cluster elasticsearch est possible dès lors que celui-ci accepte les CORS. Il est par conséquent nécessaire d’ajouter ceci au fichier elasticsearch.yml du cluster :
Tant qu’aucun cluster n’est configuré, il est demandé de renseigner les informations suivantes :
Par défaut, la configuration correspond à un cluster déployé en local sans élément d’authentification.
Après configuration d’un cluster, celui-ci apparait dans une liste, il est ainsi possible d’ajouter et d’éditer d’autres configurations :
La configuration Elasticvue peut être sauvegardée et restaurée dans les paramètres de l’extension :
Il est par conséquent possible de partager la configuration elasticvue en transmettant le fichier de sauvegarde.
La page par défaut permet de visualiser les informations principales du cluster et des nœuds :
La vue nodes permet d’obtenir des informations complémentaires sur les nœuds du cluster, notamment la consommation en ressource :
La vue indices est le point d’entrée pour la gestion des index. Elle liste l’ensemble des index existants, leur nom, leur statut, le nombre de documents ainsi que la taille de l’index.
La roue crantée affiche un menu complémentaire :
Un clique sur le nom d’un index permet de visualiser les documents de façon paginée :
Cette vue offre la possibilité de filtrer la liste des documents retournés, aussi bien par des requêtes simples que plus avancées :
Le bouton Show d’un document permet de visualiser celui-ci au format json :
Le bouton New Index permet de créer un nouvel index en paramétrant les éléments suivants :
Le nom de l’index doit être en minuscule. Le nombre de shards et de réplicas peuvent être laisser à vide, ils prendront la valeur 1 lors de la création de l’index.
La vue indices permet d’effectuer diverses opérations sur les index, après avoir sélectionné un ou plusieurs index dans la liste :
Les différentes opérations correspondent aux APIs Elasticsearch :
A l’instar de la vue indices, la vue search offre la possibilité de rechercher des documents au sein des index existants. Les requêtes peuvent être simples ou plus avancées.
Les requêtes peuvent être saisies ainsi :
La vue Rest permet de faire appel aux APIs Elasticsearch, que soit les APIs de recherche, d’indexation, de suppression de documents ou des APIs liées l’administration du cluster.
Exemple d’appel API de recherche de document par son _id
Exemple d’appel API lié à l’administration, ici l’obtention de la santé du cluster
Le bouton History liste l’ensemble des requêtes exécutées et permet de les rejouer simplement en cliquant sur Use :
La documentation des APIs Elasticsearch est accessible via ce lien : https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html
Les snapshots permettent de sauvegarder et restaurer des index. Le prérequis est d’avoir paramétré path.repo dans la configuration Elasticsearch.
La première étape est de créer un repository qui sera l’espace de stockage des snapshots.
La seconde étape est de créer les snapshots en cliquant sur Manage Snapshots :
La liste des snapshots permet de savoir si une sauvegarde s’est correctement terminée dès lors que end_time est renseignée et que failed_shards reste à 0.
La restauration des index sauvegardés est possible par l’intermédiaire de la liste des snapshots :
Le formulaire ci-dessous permet de sélectionner les index à restaurer. La restauration d’un index avec conservation de son nom n’est pas permise dès lors que son nom existe déjà. Il est par conséquent possible de modifier le nom de l’index cible de la restauration.
Dans le cas ci-dessous, seul l’index company sera restauré en étant renommé company.restaure :
Le nouvel index restaure company.restaure est alors accessible via la vue indices :
Réservez un moment avec notre équipe RH en quelques clics, pour voir ensemble le meilleur moyen de nous rejoindre. Vous avez des questions sur Delia Technologies ? C'est le moment de les poser !
Rencontrer notre équipe