Browse Source

README.md décrit le processus.

Citnop 3 years ago
parent
commit
5cd7e37497
1 changed files with 37 additions and 1 deletions
  1. 37 1
      README.md

+ 37 - 1
README.md

@@ -1,3 +1,39 @@
1 1
 # YaPLog
2 2
 
3
-Prototype d'analyseur de log nfcapd, pour un reporting quotidien, et détermination de saturations sur les liens IP.
3
+Prototype d'analyseur de log nfcapd, pour un reporting quotidien, et détermination de saturations sur les liens IP.
4
+
5
+Description
6
+===========
7
+
8
+  le script Bash chef/chef_d_orchestre est l'ordonnanceur qui appelle chacune des fonctions
9
+  le programme cleanRAM/useRAM sert à allouer/désallouer 1/2 de la RAM de l'ordinateur le plus vite possible
10
+  cpp/ contient le parser C++ qui va représenter les Packet (IP:port, poids, date, durée) sur une journée
11
+  (genHourMin/genHourMin.py permet de générer les quarts d'heure de la journée)
12
+  gnuplot/plotgnu.sh permet de réaliser un graph à partir d'un CSV
13
+  nfcapd2ascii/ contient nfdumpall.sh qui permet de passer du format binaire nfcapd à du texte ASCII
14
+  preparser/contient acsvify qui permet de passer du texte à un format CSV plus standard et plus léger. il contient aussi csvify qui met de la couleur (ajout de caractères d'échappement, ne pas utiliser pour la production, il génère beaucoup de texte)
15
+
16
+Fonctionnement
17
+==============
18
+
19
+Le script chef_d_orchestre suit les étapes suivantes pour tous les sites (Warning si les logs d'un site ne sont pas fournis) :
20
+
21
+  cp :
22
+    les archives sont copiées dans des répertoires pour éviter les mélanges entre les fichiers.
23
+    NOTE: il faut appeler l'archive ****-siteNN-*****.zip, où * n'est pas important, mais non vide, N = numéro du site (entre 01 et 135)
24
+  unzip :
25
+    le programme extrait l'archive zip
26
+    l'archive contient normlement 96 quarts d'heure.
27
+  bin2ascii/nfcapd:
28
+    le programme transforme les 96 quarts d'heure du format binaire vers du texte ASCII
29
+  cat:
30
+    le programme concatène les 96 fichiers ASCII produits
31
+  ascii2csv/pre-parser:
32
+    le programme réalise un préparsing du fichier texte ascii pour obtenir un CSV plus léger et plus facile à parser.
33
+  csv2res/graphEchantTabl:
34
+    le programme analyse chacun des paquets pour en faire une représentation générale.
35
+  graphs:
36
+    le prgramme crée des images PNG à partir de chacun des CSV produits.
37
+  FIN.
38
+
39
+