Add README.md

README.md

@@ -0,0 +1,76 @@
+# run_analysis_aux_workers
+
+## Überblick
+Dieses Projekt untersucht die Leistung verschiedener aux-Worker-Konfigurationen, um den optimalen Wert für die Log-Analyse zu bestimmen. Die Analyse wird mithilfe eines Python-Skripts durchgeführt, das Log-Daten strukturiert auswertet und mit Ergebnissen aus CSV-Datasets kombiniert wird.
+
+**Hinweis**  
+Alle Inhalte wurden per KI generiert.  
+Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko.  
+Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
+
+**Weiterführende Ressourcen:**  
+[Artikel zur Analyse](https://donau2space.de/tag-194-run-37-im-nieselregen-bringt-aux3-noch-tail-gewinn-oder-nur-mehr-slots/)  
+[Git Repository](https://git.donau2space.de/Mika/run_analysis_aux_workers)
+
+## Inhalt des Repositories
+
+### 1. Python-Skript: Log-Analyse (`artifact.1`)
+- **Art:** python_script  
+- **Ziel:** linux-userspace  
+- **Sprachen:** Python  
+- **Zweck:** Analysiert Log-Daten verschiedener aux-Worker-Konfigurationen und ermittelt relevante Leistungsparameter.
+
+**API-Funktion:**
+- `analyze_logs(log_file_path)` → gibt `analysis_result` zurück.  
+  Zweck: Lädt Log-Dateien, extrahiert Metriken (p99_tail, band_width) und generiert eine Ergebniszusammenfassung.
+
+**Datenstruktur:**
+- `LogData (json)`  
+  Felder: timestamp, aux_worker, p99_tail, band_width
+
+### 2. CSV-Dataset der Ergebnisse (`artifact.2`)
+- **Art:** csv_dataset  
+- **Ziel:** mixed  
+- **Sprache:** CSV  
+- **Zweck:** Enthält tabellarische Resultate der Analyse-Läufe verschiedener aux-Worker-Konfigurationen.
+
+**Tabellenstruktur:**
+- `RunResults (table)`  
+  Felder: run_id, aux_worker, p99_tail, band_width, timestamp
+
+### 3. Dokumentation (`artifact.3`)
+- **Art:** doc_only  
+- **Ziel:** mixed  
+- **Zweck:** Beschreibt Methodik, Testaufbau und Ergebnisse der Leistungsanalyse.
+
+## Installation & Nutzung
+
+Voraussetzung: Python ≥ 3.10
+
+### Installation
+1. Repository klonen:  
+   `git clone https://git.donau2space.de/Mika/run_analysis_aux_workers`
+2. Abhängigkeiten installieren:  
+   `pip install -r requirements.txt`
+
+### Nutzung
+Das Skript kann zur Analyse eigener Logdateien verwendet werden.
+
+**Beispiel:**  
+`python analyze_logs.py --log-file ./data/logs/run_aux3.log`
+
+Ergebnis: Strukturierte Datei mit Analyseparametern (`analysis_result.json`).
+
+## Typische Use-Cases
+- Vergleich der Auswirkung verschiedener aux-Worker-Werte auf die Systemperformance.
+- Ableitung optimaler Konfigurationen für Log-Analysen in verteilten Systemen.
+- Visualisierung von Laufzeitdaten und Tail-Performance.
+
+## Struktur & mögliche Erweiterungen
+- Erweiterung der LogData-Struktur um weitere Metriken (z. B. CPU-Auslastung, IO-Wait).
+- Integration von Visualisierungsmodulen (Matplotlib, Plotly) für die Ergebnisdarstellung.
+- Automatisierte Reports aus den CSV-Ergebnissen.
+
+## Lizenz
+Lizenziert unter der **MIT-Lizenz**.  
+Alle Inhalte wurden automatisch generiert und werden ohne Gewähr bereitgestellt.