Commit 317462d4 authored by Gregory's avatar Gregory

add documentation

parent 80855542
......@@ -31,6 +31,11 @@ A savoir que les contenus opale de plusieurs machines/utilisateurs peuvent être
##Utilisation
-------------
L'utilisation complète d'opale_to_elasticSearch nécessite l'utilisation de la stack ELK (ElasticSearch, Logstash, Kibana).
Notez qu'il vous faut java8 pour lancer la stack ELK:
- lancez java --version
- Si ce n'est pas le cas : sudo apt-get install default-jdk
Installation :
- Télécharger ElasticSearch : https://www.elastic.co/fr/downloads/elasticsearch et extraire l'archive
- Télécharger Logstash : https://www.elastic.co/fr/downloads/logstash et extraire l'archive
- Télécharger Kibana : https://www.elastic.co/fr/downloads/kibana et extraire l'archive
......@@ -41,19 +46,28 @@ L'utilisation complète d'opale_to_elasticSearch nécessite l'utilisation de la
Etapes :
- aller dans votre dossier d'installation d'elasticsearch et lancer bin/elasticsearch
- aller dans votre dossier d'installation de kibana et lancer bin/kibana
- aller dans votre dossier d'installation de logstash et lancer bin/logstash - f esconf.conf
- aller dans votre dossier d'installation de logstash et lancer bin/logstash -f esconf.conf
- Attendre les messages de logstash qui indiquent le lancement sans problème.
- lancer la transformation opale_to_elasticsearch en mettant d'abord les *.scar dans opale_to_elasticsearch/input
- lancer la transformation opale_to_elasticsearch en mettant d'abord les .scar dans opale_to_elasticsearch/input
- Le dossier de sortie n'est pas le classique opale_to_elasticsearch/output mais opale_to_elasticsearch/logstash/input afin de faire directement le lien avec Logstash
- Normalement les log de logstash indique l'insertion des sorties de la transformation, il arrive pour le moment qu'il ne le fasse qu'au moment où logstash s'arrête, l'arrêter alors.
- aller sur localhost:5601
- Normalement il vous demande de créer un index, par défaut logstash-* . Si oui, laissez par défaut.
- Vous allez arriver sur la page de création d'index. Par défaut vous n'en avez pas et il vous propose de créer logstash-*. Créez-le en appuyant sur "Créer".
- Allez dans Management => Saved object.
- Cliquez sur "import" et importer le fichier JSON opale_to_elasticSearch/conf/kibana/dashboard.json
- Vous devriez voir un dashboard et des objets dans "vizualisation" s'ajouter à votre liste de saved objects
- Allez dans Dashboard, cliquez sur "Open" et sélectionnez le dashboard ajouté (Normalement "NF29_DATA_DASHBOARD")
- Allez dans Dashboard, cliquez sur "Open" tout en haut à droite et sélectionnez le dashboard ajouté (Normalement "NF29_DATA_DASHBOARD")
- Vous pouvez cliquez sur les différents éléments des graphiques pour filtrer les informations, les graphiques s'actualiseront en fonction.
Pour vérifier que vos données sont bien insérées dans kibana, vous pouvez aller sur l'onglet "Dev tools" et lancer la requête suivante :
```
GET logstash-*/_search/
{
"query": {
"match_all": {}
}
}
```
##Bugs connus
-------------
- Logstash ne prend pas toujours en compte tout de suite le fichier une fois ajouté au dossier, il faut parfois l'éteindre/le relancer
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment