From 6a9c5901155c9329d2d3eb6839688721d81d86f8 Mon Sep 17 00:00:00 2001 From: AnthonyGuillauma Date: Sun, 6 Apr 2025 16:04:29 +0200 Subject: [PATCH 1/2] =?UTF-8?q?Docs:=20Mise=20=C3=A0=20jour=20de=20la=20do?= =?UTF-8?q?cumentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Mise à jour de l'index de la documentation pour les nouvelles fonctionnalités de la version 0.2.0 --- docs/source/index.rst | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 778e4ba..9c4db89 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,17 +23,56 @@ Grâce à LogBuster, vous pouvez extraire des informations essentielles, gérer - **Extraire des statistiques clés** : Obtenez des données précieuses sur vos fichiers de logs. - **Exporter les données en JSON** : Accédez à un format structuré pour vos analyses. +- **Exporter des graphiques** : Générez des graphiques de vos fichiers de logs. +- **Filtrer les analyses** : Filtrez les analyses en toute simplicité. - **Gérer les erreurs de format avec précision** : Identifiez rapidement les anomalies et les erreurs de vos fichiers log. **d(■᎑■⌐) Utilisation** --------------------------- ``` -python app/main.py chemin_log [-s SORTIE] +python app/main.py chemin_log [-s SORTIE] [-i IP] [-c CODE_STATUT_HTTP] [--camembert CAMEMBERT] ``` - `chemin_log` : Le chemin vers le fichier de log Apache à analyser. - `-s SORTIE` (optionnel) : Le chemin où sauvegarder les résultats de l'analyse. Si non spécifié, les résultats seront sauvegardés dans un fichier `analyse-log-apache.json`. +- `-i IP` (optionnel) : Le filtre à appliquer sur les adresses IP des entrées du fichier de log. Uniquement les entrées avec cette adresse IP seront analysées. +- `-c CODE_STATUT_HTTP` (optionnel) : Le filtre à appliquer sur les code de statut http des entrées du fichier de log. Uniquement les entrées avec ce code de statut http seront analysées. +- `--camembert CAMEMBERT` : (optionnel) : Active la génération de graphiques camemberts dans lors de l'analyse pour les statistiques compatibles. Les statistiques comptatibles. + +**(ò_ó)⊃ Format de l'analyse** +------------------------ + +Lors de l'analyse des fichiers de logs, LogBuster fait en sorte de regrouper les statistiques clés par catégories. + +Voici ci-dessous le format de l'analyse en JSON: + + - chemin: chemin absolu du fichier + - total_entrees: nombre total d'entrées dans le fichier + - filtre: filtres appliqués à l'analyse + - adresse_ip: filtre sur l'adresse IP (None si désactivé) + - code_statut_http: filtre sur le code de statut http (None si désactivé) + - statistiques: + - total_entrees_filtre: nombre total d'entrées analysées + - requetes: + - top_urls: top 3 des urls + - dictionnaires contenant: + - url: ressource demandée + - total: nombre d'entrée avec cette ressource demandée + - taux: pourcentage d'entrée avec cette ressource demandée + - reponses: + - repartition_code_statut_http: répartition des codes de statut http + - dictionnaires contenant: + - code: code de statut http retourné + - total: nombre d'entrée avec ce code de statut http retourné + - taux: pourcentage d'entrée avec ce code de statut http retourné + +Pour les graphiques camemberts, un fichier HTML est généré avec ce graphique. +Néanmoins, toutes les statistiques ne sont pas compatibles avec ce type d'affichage. + +Voici la liste des statistiques comptatibles avec les graphiques: + +- `repartition_code_statut_http` : Répartition des codes de statut HTTP. (nom: camembert-code_statut_http) **(ง'̀᎑'́)ง Format des fichier de log Apache** ------------------------------------------------ From 9f8e775a15c42352e23a801e4eed27ead2540dfd Mon Sep 17 00:00:00 2001 From: AnthonyGuillauma Date: Sun, 6 Apr 2025 16:05:57 +0200 Subject: [PATCH 2/2] =?UTF-8?q?Docs:=20Modification=20suite=20=C3=A0=20une?= =?UTF-8?q?=20erreur=20de=20titre?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Modification d'un titre où sa ligne du dessosu était trop courte --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9c4db89..a56e540 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,7 +41,7 @@ python app/main.py chemin_log [-s SORTIE] [-i IP] [-c CODE_STATUT_HTTP] [--camem - `--camembert CAMEMBERT` : (optionnel) : Active la génération de graphiques camemberts dans lors de l'analyse pour les statistiques compatibles. Les statistiques comptatibles. **(ò_ó)⊃ Format de l'analyse** ------------------------- +-------------------------------- Lors de l'analyse des fichiers de logs, LogBuster fait en sorte de regrouper les statistiques clés par catégories.