87 lines
No EOL
3.5 KiB
Markdown
87 lines
No EOL
3.5 KiB
Markdown
# Drift Job Reporting
|
||
|
||
## Überblick
|
||
|
||
Das Projekt **drift_job_reporting** ist ein experimentelles Reporting-System für Drift-Analysen in CI-Umgebungen. Es generiert sowohl maschinenlesbare als auch menschenlesbare Berichte über Drift-Ergebnisse und Metriken aus automatisierten Testläufen.
|
||
|
||
**Artikel:** [https://donau2space.de/tag-134-1311-drift-job-scharf-geschaltet-erste-live-runs-echte-labels/](https://donau2space.de/tag-134-1311-drift-job-scharf-geschaltet-erste-live-runs-echte-labels/)
|
||
|
||
**Git Repository:** [https://git.donau2space.de/Mika/drift_job_reporting](https://git.donau2space.de/Mika/drift_job_reporting)
|
||
|
||
### 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
|
||
|
||
Das Repository enthält die folgenden Artefakte:
|
||
|
||
### 1. drift_report_json
|
||
- **Art:** json_dataset
|
||
- **Ziel:** linux-userspace
|
||
- **Sprachen:** JSON
|
||
- **Zweck:** Enthält maschinenlesbare Drift-Berichte mit relevanten Metriken zur Bewertung von Drift-Konformität.
|
||
|
||
**API-Funktion:**
|
||
- `generate_drift_report_json(window_size, pass_count, warn_count, fail_count, warn_ratio, pinned_split, unpinned_split)`
|
||
*Erzeugt die Datei* `drift_report.json`, *die alle Metriken der Drift-Analyse enthält.*
|
||
|
||
**Datenstruktur:**
|
||
- `drift_report` (JSON-Objekt) mit den Feldern:
|
||
- window_size
|
||
- pass_count
|
||
- warn_count
|
||
- fail_count
|
||
- warn_ratio
|
||
- pinned_split
|
||
- unpinned_split
|
||
|
||
### 2. drift_report_md
|
||
- **Art:** doc_only
|
||
- **Ziel:** linux-userspace
|
||
- **Sprachen:** Markdown
|
||
- **Zweck:** Menschenlesbarer Report mit detailreichen Drift-Informationen und Warnhinweisen, generiert aus den gleichen Eingabewerten wie der JSON-Report.
|
||
|
||
**API-Funktion:**
|
||
- `generate_drift_report_md(window_size, pass_count, warn_count, fail_count, warn_ratio, pinned_warn_fail_count)`
|
||
*Erzeugt die Datei* `drift_report.md`, *die zur direkten menschlichen Auswertung dient.*
|
||
|
||
**Datenstruktur:**
|
||
- `drift_report_md` (Markdown-Dokument) mit den Feldern:
|
||
- window_size
|
||
- pass_count
|
||
- warn_count
|
||
- fail_count
|
||
- warn_ratio
|
||
- pinned_warn_fail_count
|
||
|
||
## Installation & Nutzung
|
||
|
||
Da keine eigenständigen CLI-Tools oder binären Module enthalten sind, erfolgt die Nutzung über Integration in bestehende CI-Pipelines oder Skriptaufrufe aus Python-Umgebungen.
|
||
|
||
**Beispiel-Nutzung:**
|
||
- Aufruf der Generierungsfunktionen aus einem Python-Workflow.
|
||
- Übergabe der Zähler- und Verhältniswerte für Drift-Analysen.
|
||
- Speicherung der erzeugten Drift-Reports als Artefakte im CI-Lauf.
|
||
|
||
## Typische Use-Cases
|
||
|
||
- Automatisierte Auswertung und Dokumentation von CI-Drift-Ergebnissen.
|
||
- Integration in Monitoring- oder Qualitäts-Reporting-Dashboards.
|
||
- Vergleich mehrerer Build-Pipelines hinsichtlich Stabilität und Driftverhalten.
|
||
- Audit-geeignete, parallele Ausgabe für Mensch und Maschine.
|
||
|
||
## Struktur & mögliche Erweiterungen
|
||
|
||
- Erweiterung des JSON-Schemas um zusätzliche Drift-Metriken (z. B. Latenzabweichungen, Threshold-Trigger).
|
||
- Automatische Korrelation zwischen *pinned* und *unpinned* Runs.
|
||
- Generierung von HTML- oder PDF-Reports als Ergänzung zum Markdown-Output.
|
||
- Python-Wrapper zur direkten CLI-Erzeugung der Reports.
|
||
|
||
## Lizenz
|
||
|
||
Lizenz: **MIT License**
|
||
|
||
Alle Inhalte dieser Repository-Dokumentation wurden automatisiert durch KI erstellt. Die Nutzung erfolgt auf eigenes Risiko, ohne Anspruch auf Korrektheit oder Funktionsgarantie. |