README.md 3.36 KB
Newer Older
Gregory's avatar
Gregory committed
1
# Opale to ElasticSearch
Gregory's avatar
Gregory committed
2
3
4
5
6
7
8

## License
-------------
License GPL3.0 http://www.gnu.org/licenses/gpl-3.0.txt

## Credits
-------------
Delaunay Gregory's avatar
Delaunay Gregory committed
9
DELAUNAY Grégory
Gregory's avatar
Gregory committed
10
11
12
13
14
15
16
17
18
19
20
21
KELLER Vincent

## Presentation
-------------
Opale to ElasticSearch module extract data from an Opale file to use it with ElasticSearch


## Dependence
-------------

-   Opale To Hdoc Converter
-   Hdoc to ElasticSearch Converter
22
23
24

## User Story
-------------
Delaunay Gregory's avatar
Delaunay Gregory committed
25
26
27
"Vous disposez d'un ensemble de contenus Opale à votre disposition et vous aimeriez pouvoir l'analyser selon les différents types d'éléments possibles : cours, exercices, notions tout en permettant de trier par rapport aux différents sujets de ces dit contenus.
Pour se faire, vous mettrez les contenus que vous voulez analyser en input de opale_to_elasticSearch et vous lancerez le script lançant le fichier ANT.
Vous pourrez ensuite accéder à des graphiques Kibana à une adresse donnée et paramétrer vos graphiques afin d'obtenir les informations qui vous intéresse.
28

Delaunay Gregory's avatar
Delaunay Gregory committed
29
30
31
32
33
A savoir que les contenus opale de plusieurs machines/utilisateurs peuvent être capitalisés car l'ensemble des instances de base elasticSearch installées forment un cluster accessible via l'interface Kibana"

##Utilisation
-------------
L'utilisation complète d'opale_to_elasticSearch nécessite l'utilisation de la stack ELK (ElasticSearch, Logstash, Kibana).
Delaunay Gregory's avatar
Delaunay Gregory committed
34
35
36
- 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
Gregory's avatar
Gregory committed
37
38
- Mettre le fichier esconf.conf situé dans opale_to_elasticSearch/conf/logstash/ dans %{dossier_installation_logstash}/
- Editer le fichier esconf.conf : ligne 11, remplacez "path => ["/elasticSearch/logstash/input/*.json"]" par "path => ["%{votreCheminAbsolu}/opale_to_elasticSearch/logstash/input/*.json"]"
Delaunay Gregory's avatar
Delaunay Gregory committed
39
- Sauvegarder les modifications.
Delaunay Gregory's avatar
Delaunay Gregory committed
40
41
42
43
44

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
Delaunay Gregory's avatar
Delaunay Gregory committed
45
- Attendre les messages de logstash qui indiquent le lancement sans problème.
Delaunay Gregory's avatar
Delaunay Gregory committed
46
- lancer la transformation opale_to_elasticsearch en mettant d'abord les *.scar dans opale_to_elasticsearch/input
Delaunay Gregory's avatar
Delaunay Gregory committed
47
- 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
Delaunay Gregory's avatar
Delaunay Gregory committed
48
- 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.
Gregory's avatar
Gregory committed
49
50
51
52
53
54
55
- aller sur localhost:5601 
- Normalement il vous demande de créer un index, par défaut logstash-* . Si oui, laissez par défaut.
- 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")
- Vous pouvez cliquez sur les différents éléments des graphiques pour filtrer les informations, les graphiques s'actualiseront en fonction.