...

• Modifier le paramètre cluster.name : par défaut il utilise elasticsearch. Si vous lancez un autre serveur elasticsearch non paramétré sur le même réseau, il va commencer à recopier toutes les données car ils considéreront qu'ils font partie du même cluster.

  Bloc de code
  # Nom du cluster utilisé pour Agimus. Toutes les machines utilisées (si vous utilisez le mécanisme de distribution) doivent avoir le même. cluster.name: Agimus

  
  

• Modifier le paramètre node.name : permet de savoir plus précisément quelle machine pose problème le cas échéant. Le nœud est un serveur elasticsearch. Vous pouvez lui donner le nom réel du serveur pour plus de clarté.

  Bloc de code
  # Nom du noeud (une des machines du cluster). Permet de différencier chaque machine du cluster. node.name: "Agimus1"

  
  

• Prévoir beaucoup de RAM sur la ou les machines du cluster. Le heap space (variable d'environnement ES_HEAP_SIZE) du processus ne devrait pas dépasser 50% de la RAM.

• Ajouter le paramètre indices.fielddata.cache.size : 40% .
  Ceci permet de limiter l'espace de heap alloué à fielddata et d'éviter que les requêtes ne soient bloquées par un circuit breaker (cf http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_limiting_memory_usage.html)

  Bloc de code
  indices.fielddata.cache.size: 40%

  
  

• Avant de commencer l'indexation, ajoutez ces templates qui permettent de paramétrer les champs par défaut et un meilleur fonctionnement pour l'usage qui est fait d'elasticsearch.

  • [Facultatif] Ingest pipeline qui va être exécutée par défaut pour toute insertion dans un index agimus.
    Permet de créer 3 nouveaux champs : Jour de la semaine, heure du jour, type de périphérique lisible. Ces champs seront utilisés dans les rendus kibana.

    Bloc de code
    title Ingest pipeline - création automatique de champ collapse true
    $ curl -XPUT "http://localhost:9200/_ingest/pipeline/agimus" -d ' { "description": "ajout des champs heure et jour de la semaine pour l'événement et valeur lisible de is_mobile", "processors": [ { "set": { "field": "ts", "value": "{{@timestamp}}" } }, { "script": { "lang": "painless", "source": """ ZonedDateTime dateEvt = ZonedDateTime.parse(ctx.ts); ZonedDateTime dateEvtChezNous = dateEvt.withZoneSameInstant(ZoneId.of('Europe/Paris')); ctx.heure = dateEvtChezNous.getHour(); ctx.jour_semaine = dateEvtChezNous.getDayOfWeek().getValue() +"-"+dateEvtChezNous.getDayOfWeek().getDisplayName(TextStyle.SHORT, Locale.FRANCE); """ } }, { "remove": { "field": "ts" } }, { "script": { "lang": "painless", "source": """ if (ctx?.is_mobile =="0") { ctx.is_mobile_hr = "Ordinateur"; } else if (ctx?.is_mobile =="1") { ctx.is_mobile_hr = "Smartphone/Tablette"; } else { ctx.is_mobile_hr = "Non détectable"; } """ } } ] }

    
    

  • Template principal. Si vous n'utilisez pas la pipeline ci-dessus, retirez la ligne "default_pipeline" : "agimus",
    Les champs texte sont par défaut de type keyword car nous n'utiliserons généralement pas de recherche approximative mais chaque valeur aura un sens uniquement si elle est prise en compte dans sa totalité
    Les types des autres champs sont prédéfinis pour éviter des erreurs à l'ingestion des données et pour permettre une bonne utilisation dans kibana

    Bloc de code
    title template "agimus" collapse true
    $ curl -XPUT "http://localhost:9200/_template/agimus" -d ' { "order" : 0, "index_patterns" : [ "ag-*" ], "settings" : { "index" : { "default_pipeline" : "agimus", "refresh_interval" : "1s", "number_of_shards" : "1", "number_of_replicas" : "0" } }, "mappings" : { "dynamic_templates" : [ { "string_fields" : { "mapping" : { "type" : "keyword" }, "match_mapping_type" : "string", "match" : "*" } } ], "properties" : { "@timestamp" : { "type" : "date" }, "estinscrit" : { "type" : "boolean" }, "@version" : { "type" : "keyword" }, "insc-annee" : { "type" : "integer" } } }, "aliases" : { } }'

    
    

  • Template de l'index contenant le dump ldap et de ldap-stat permettant le suivi du ldap. Il vous faudra peut-être le modifier si vous y intégrer des valeurs spécifiques

    Bloc de code
    title template "ldap" collapse true
    $ curl -XPUT "http://localhost:9200/_template/ldap" -d ' { "order" : 0, "index_patterns" : [ "ldap*" ], "settings" : { "index" : { "number_of_shards" : "3", "number_of_replicas" : "0", "refresh_interval" : "60s" } }, "mappings" : { "dynamic_templates" : [ { "string_fields" : { "mapping" : { "type" : "keyword" }, "match_mapping_type" : "string", "match" : "*" } } ], "properties" : { "@timestamp" : { "type" : "date" }, "estinscrit" : { "type" : "boolean" }, "@version" : { "type" : "keyword" }, "insc-annee" : { "type" : "integer" } } }, "aliases" : { } }'

    
    

  • Exemples de templates spécifiques s'appliquant à un type de log en particulier

    Bloc de code
    title Template s'appliquant aux cours moodle collapse true
    $ curl -XPUT "http://localhost:9200/_template/moodlecours" -d ' { "order" : 2, "index_patterns" : [ "ag-moodlecours-*" ], "settings" : { }, "mappings" : { "dynamic_templates" : [ { "type_activites_as_int" : { "path_match" : "mdl_type_activites.*", "mapping" : { "type" : "integer" } } } ], "properties" : { "mdl_id_comp" : { "type" : "integer" }, "mdl_activites" : { "type" : "nested", "properties" : { "id_activite" : { "type" : "integer" } } }, "mdl_courseid" : { "type" : "integer" }, "mdl_id_cat" : { "type" : "integer" }, "mdl_id_coll" : { "type" : "integer" }, "mdl_actif" : { "type" : "boolean" } } }, "aliases" : { } }'

    
    

    Bloc de code
    title Template s'appliquant aux logs moodle collapse true
    $ curl -XPUT "http://localhost:9200/_template/moodledb" -d ' { "order" : 2, "index_patterns" : [ "ag-moodledb-*" ], "settings" : { }, "mappings" : { "properties" : { "mdl_courseid" : { "type" : "integer" }, "mdl_id" : { "type" : "integer" }, "mdl_contextinstanceid" : { "type" : "integer" }, "mdl_objectid" : { "type" : "integer" }, "mdl_contextid" : { "type" : "integer" }, "mdl_actif" : { "type" : "boolean" } } }, "aliases" : { } }'

    
    

    Bloc de code
    title Template s'appliquant aux logs ezpaarse collapse true
    $ curl -XPUT "http://localhost:9200/_template/ezagimus" -d ' { "order" : 2, "index_patterns" : [ "ag-ezagimus-*" ], "settings" : { }, "mappings" : { "properties" : { "size" : { "type" : "integer" }, "on_campus" : { "type" : "boolean" }, "status" : { "type" : "integer" } } }, "aliases" : { } }'

    
    

    Bloc de code
    title Template s'appliquant aux logs trace collapse true
    $ curl -XPUT "http://localhost:9200/_template/trace" -d ' { "order" : 0, "index_patterns" : [ "trace*" ], "settings" : { "index" : { "number_of_shards" : "3", "number_of_replicas" : "0", "refresh_interval" : "60s" } }, "mappings" : { "dynamic_templates" : [ { "string_fields" : { "mapping" : { "type" : "keyword" }, "match_mapping_type" : "string", "match" : "*" } } ], "properties" : { "@timestamp" : { "type" : "date" }, "@version" : { "type" : "keyword" } } }, "aliases" : { } }'

    
    

    Bloc de code
    title Template s'appliquant aux logs rocketchat collapse true
    $ curl -XPUT "http://localhost:9200/_template/rocketchat" -d ' { "order" : 2, "index_patterns" : [ "ag-rocketchat-*" ], "settings" : { }, "mappings" : { "properties" : { "rc_totalChannels" : { "type" : "long" }, "rc_totalUsers" : { "type" : "long" }, "rc_totalRooms" : { "type" : "long" }, "rc_totalMessages" : { "type" : "long" }, "rc_totalConnectedUsers" : { "type" : "long" }, "rc_totalDirectMessages" : { "type" : "long" }, "rc_totalPrivateGroupMessages" : { "type" : "long" }, "rc_totalChannelMessages" : { "type" : "long" }, "rc_totalLivechatMessages" : { "type" : "long" }, "rc_totalLivechat" : { "type" : "long" }, "rc_totalPrivateGroups" : { "type" : "long" }, "rc_totalDirect" : { "type" : "long" } } }, "aliases" : { } }'

    
    

    Astuce
    title POUR TESTER
    Pour vous assurer que les commandes ont été prises en compte, vérifier que vous avez les entrées "logs_agimus" et , "ldap", "trace" et templates spécifiques ajoutés en lançant la commande suivante : Bloc de code curl -XGET "http://localhost:9200/_template/?pretty"

    
    

...

• Pour en savoir plus sur elasticsearch : http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/

• Il est possible d'installer le plugin kopf pour elasticsearch qui vous permettra de requêter et administrer votre serveur elasticsearch. Pour cela, taper dans votre répertoire elasticsearch :

  Bloc de code
  bin/plugin -install lmenezes/elasticsearch-kopf OU bin/plugin -DproxyHost=host_name -DproxyPort=port_number -install lmenezes/elasticsearch-kopf

  Pour l'utiliser, il suffit alors d'accéder à l'adresse http://agimus.univ.fr:9200/_plugin/kopf

Sense est également utile pour requêter votre cluster elasticsearch. Il propose de l'autocomplétion, indentation des requêtes. C'est un outil très utile au moment de la conception de vos index pour vérifier les contenus.
Depuis la version 4.2, sense est devenu un plugin de kibana au lieu de Marvel précédemment (outil payant en production).
Pour installer sense :
• télécharger la dernière version de kibana

décompresser et lancer la commande suivante dans le dossier

Bloc de code
./bin/kibana plugin --install elastic/sense

Si votre version d'elasticsearch est inférieure à 2, vous devez désactiver les fonctionnalités principales de kibana

Bloc de code
title Ajout dans ./config/kibana.yml
kibana.enabled: false # disable the standard kibana discovery, visualize & dashboard plugins elasticsearch.enabled: false # do not require a running Elasticsearch 2.0 instance

Lancer ensuite kibana ( ./bin/kibana) et accéder à l'url http://agimus.univ.fr:5601/app/sense


• Il existe d'autres plugins intéressants :

  • ElasticsearchHQ,

  • Bigdesk, ...

Python

Python est utilisé pour faire une synthèse quotidienne de la répartition dans le LDAP par type de population.

Pour cela le script (donné ci-dessous), nécessite un plugin elasticsearch afin d'interroger le LDAP. Pour installer ce plugin lancer la commande suivante :

pip install elasticsearch

Si vous rencontrez des problèmes avec pip, vous pouvez télécharger et installer directement :

#Récupération du paquet du module
wget https://pypi.python.org/packages/source/e/elasticsearch/elasticsearch-1.4.0.tar.gz
#Récupération de sa dépendance
wget https://pypi.python.org/packages/source/u/urllib3/urllib3-1.9.tar.gz

# On décompresse les fichiers
tar -zxf urllib3-1.9.tar.gz
tar -zxf elasticsearch-1.4.0.tar.gz

#On installe d'abord la dépendance
cd urllib3-1.9
python setup.py install
#Puis le module elasticsearch
cd ../elasticsearch-1.4.0
python setup.py install

• Vous pouvez installer l'application Cerebro (https://github.com/lmenezes/cerebro) qui est le remplaçant du plugin kopf utilisé sur la version 2.
  Elle vous permettra de suivre l'état de votre cluster d'avoir des informations sur les index, alias et autres composants du cluster.
  Une fois installée, l'application est disponible sur le port 9000
• Il existe deux outils maintenant disponibles par défaut dans l'onglet "Dev Tools" de kibana. Prenez le temps de les tester ils pourront vous aider :
  
  • Console : pour tester vos requêtes ES ou vérifier le contenu de vos index
  • Grok debugger : pour vous aider à créer vos découpages grok dans logstash
    
    

Python

Python 3 est utilisé pour faire une synthèse quotidienne de la répartition dans le LDAP par type de population.

Pour cela le script (donné ci-dessous), nécessite un plugin elasticsearch afin d'interroger le LDAP. Pour installer ce plugin lancer la commande suivante :

pip install elasticsearch

Si vous rencontrez des problèmes avec pip, vous pouvez télécharger la version que vous souhaitez et installer directement :

#Récupération du paquet du module
wget https://pypi.python.org/packages/source/e/elasticsearch/elasticsearch-7.8.1.tar.gz
#Récupération de sa dépendance
wget https://pypi.python.org/packages/source/u/urllib3/urllib3-1.22.tar.gz

# On décompresse les fichiers
tar -zxf urllib3-1.22.tar.gz
tar -zxf elasticsearch-7.8.1.tar.gz

#On installe d'abord la dépendance
cd urllib3-1.22
python setup.py install
#Puis le module elasticsearch
cd ../elasticsearch-7.8.1
python setup.py install

[agimus@agimus scripts]$ cp config-sample.py config.py
# Paramétrer les informations spécifiques à votre installation
[agimus@agimus scripts]$ vim config.py   
[agimus@agimus scripts]$ python test-elasticsearch.py
L'index test-index est cree
Il y a 1 document(s) dans l'index test-index :
Créé le 2020-08-03T12:03:55.976158 par testeur : Elasticsearch fonctionne dans python
L'index de test "test-index" est supprimé.

Le test s'est déroulé correctement. Le plugin elasticsearch pour python est installé correctement

[agimus@agimus scripts]$ 

[agimus@agimus scripts]$ python test-elasticsearch.py