LogBuster

                                  .-. .-')                 .-')    .-') _     ('-.  _  .-')  ,---.
                                  \  ( OO )               ( OO ). (  OO) )  _(  OO)( \( -O ) |   |
 ,--.      .-'),-----.   ,----.    ;-----.\  ,--. ,--.   (_)---\_)/     '._(,------.,------. |   |
 |  |.-') ( OO'  .-.  ' '  .-./-') | .-.  |  |  | |  |   /    _ | |'--...__)|  .---'|   /`. '|   |
 |  | OO )/   |  | |  | |  |_( O- )| '-' /_) |  | | .-') \  :` `. '--.  .--'|  |    |  /  | ||   |
 |  |`-' |\_) |  |\|  | |  | .--, \| .-. `.  |  |_|( OO ) '..`''.)   |  |  (|  '--. |  |_.' ||  .'
(|  '---.'  \ |  | |  |(|  | '. (_/| |  \  | |  | | `-' /.-._)   \   |  |   |  .--' |  .  '.'`--' 
 |      |    `'  '-'  ' |  '--'  | | '--'  /('  '-'(_.-' \       /   |  |   |  `---.|  |\  \ .--. 
 `------'      `-----'   `------'  `------'   `-----'     `-----'    `--'   `------'`--' '--''--' 

Bienvenue dans le monde de LogBuster, l'outil ultime pour analyser, décortiquer et sauver vos logs Apache des griffes du chaos. Vous avez des logs qui traînent, qui sont indéchiffrables ou tout simplement encombrants ? Pas de panique, LogBuster est là pour les attraper, les analyser et vous offrir des statistiques claires et précises, comme jamais auparavant !

Le document de réflexion est disponible ici.

📋 Table des matières

• 👻 Fonctionnalités
• 📦 Installation
• 🛠️ Utilisation de base
• ⚠️ Précautions
• 📖 Documentation
• 🧪 Lancer les tests
• 📜 Licence

👻 Fonctionnalités

• 📄 Parsing avancé de logs Apache.
• 📉 Extraire des statistiques clés.
• 🥧 Génération de graphiques camemberts.
• 🧽 Filtrer les analyses.
• 🗂️ Ranger les données par catégorie.
• 🧹 Indiquer les erreurs de format avec précision.
• 🚚 Exporter les données en JSON.

📦 Installation

Bash (linux/macOS)

git clone https://github.com/AnthonyGuillauma/code_source
cd code_source
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Windows (cmd)

git clone https://github.com/AnthonyGuillauma/code_source
cd code_source
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt

🛠️ Utilisation de base

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 (plus d'infos ici).

⚠️ Précautions

Le projet LogBuster utilise des caractères Unicode, tels que des symboles spéciaux, dans le terminal pour rendre l'affichage plus plaisant. Assurez-vous que votre terminal est configuré pour prendre en charge l'affichage de caractères Unicode afin de profiter pleinement de l'expérience utilisateur.

Si vous rencontrez des problèmes d'affichage (comme des symboles manquants ou mal rendus), vous pouvez essayer les solutions suivantes :

• Utiliser un terminal compatible avec Unicode (par exemple, Terminal sous macOS, Windows Terminal sous Windows, ou des terminaux comme GNOME Terminal ou Konsole sous Linux).
• Vérifier que votre terminal utilise une police qui prend en charge les caractères Unicode (par exemple, DejaVu Sans Mono ou Consolas).

📖 Documentation

La documentation complète du code du projet se situe ici.

Si vous souhaitez la générer vous même, suivez ces étapes :

Tout d'abord, placez-vous dans le dossier docs qui contient les fichiers sources de la documentation :

cd docs

Puis, générez la documentation via la commande suivante :

./make html

Enfin, ouvrez le fichier html build/html/index.html généré dans un navigateur.

🧪 Lancer les tests

Les tests unitaires du projet peuvent être exécutés avec pytest. Pour lancer les tests, assurez-vous d'avoir activé l'environnement virtuel et installé les dépendances.

Premièrement, placez-vous dans le dossier tests qui contient les fichiers de configuration pour les tests unitaires :

cd tests

Ensuite, exécutez les tests avec la commande suivante :

pytest

Enfin, si vous souhaitez également afficher la couverture des tests unitaires, utilisez la commande suivante :

pytest  --cov=../app --cov-report=term-missing

📜 Licence

Ce projet est sous licence MIT.