diff --git a/README.md b/README.md new file mode 100644 index 0000000..2721d54 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# tag_148_gate_v1_analysis + +## Überblick +Analyse der Spike-Problemstellung im Gate v1 mit Fokus auf Timing und Artefakt-Verfügbarkeit. Das Projekt umfasst Skripte und Datensätze zur Untersuchung von Log- und Artefaktzuständen über verschiedene Zeitpunkte hinweg. + +**Link zum Artikel:** [https://donau2space.de/tag-148-gate-v1-tag-3-der-spike-war-meist-nur-zu-frueh-gezaehlt/](https://donau2space.de/tag-148-gate-v1-tag-3-der-spike-war-meist-nur-zu-frueh-gezaehlt/) + +**Git Repository:** [https://git.donau2space.de/Mika/tag_148_gate_v1_analysis](https://git.donau2space.de/Mika/tag_148_gate_v1_analysis) + +### 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. + +--- + +## Inhalt des Repositories +### Artefakt 1: logging_analysis +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprachen:** Python +- **Zweck:** Analyse von Logdaten zur Identifikation von Artefaktpfaden und Zeitverläufen. +- **API-Funktionen:** + - **analyze_log(log_file_path)** → Gibt eine Analysezusammenfassung zurück. +- **Datenstruktur:** LogEntry (JSON) mit Feldern: timestamp, expected_artifact_path, artifact_key, status. + +### Artefakt 2: data_collection +- **Art:** csv_dataset +- **Ziel:** mixed +- **Sprachen:** CSV +- **Zweck:** Sammlung und statistische Erhebung von Artefakt-Statuswerten. +- **Datenstruktur:** ArtifactStatus (Tabelle) mit Feldern: artifact_key, status, timestamp. + +### Artefakt 3: snapshot_comparator +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprachen:** Python +- **Zweck:** Vergleich von Artefakt-Snapshots zu zwei unterschiedlichen Zeitpunkten. +- **API-Funktionen:** + - **compare_snapshots(snapshot1, snapshot2)** → Gibt Vergleichsergebnisse zwischen Snapshots zurück. +- **Datenstruktur:** Snapshot (JSON) mit Feldern: artifact_key, status_before, status_after. + +--- + +## Installation & Nutzung +### Voraussetzungen +- Linux-System mit installiertem Python (≥3.8) +- Zugriff auf die notwendigen Log- und CSV-Datenbestände + +### Installation +1. Repository klonen: + `git clone https://git.donau2space.de/Mika/tag_148_gate_v1_analysis` +2. Abhängigkeiten installieren (sofern vorhanden): + `pip install -r requirements.txt` + +### Nutzung +- Aufruf der Analyse: + `python logging_analysis.py ` +- Vergleich von Snapshots: + `python snapshot_comparator.py ` + +Beide Skripte erzeugen strukturierte Ergebnisdateien im JSON-Format mit Zusammenfassungsstatistiken. + +--- + +## Typische Use-Cases +- Untersuchung von Zeitverzögerungen bei Artefakt-Zugriffen. +- Validierung der Artefaktverfügbarkeit während Entwicklungszyklen. +- Vergleich von Statusänderungen zwischen Systemständen. +- Erstellung automatisierter Auswertungsreports aus Logdaten. + +--- + +## Struktur & Erweiterbarkeit +Das Repository folgt einer modularen Struktur. Python-Skripte sind klar voneinander getrennt, was den Austausch und die Erweiterung einzelner Analysekomponenten ermöglicht. + +Erweiterungen können unter anderem beinhalten: +- Zusätzliche Auswertungsroutinen für neue Artefaktformate. +- Erweiterte Visualisierung der Vergleichsergebnisse. +- Automatisierte Korrelation zwischen Logeinträgen und CSV-Daten. + +--- + +## Lizenz +Veröffentlicht unter der **MIT-Lizenz**. + +Alle Inhalte wurden automatisch durch KI erstellt. Nutzung auf eigene Verantwortung. \ No newline at end of file