Add README.md

This commit is contained in:
Mika 2025-12-12 15:42:25 +00:00
parent c55cff94b3
commit 683d80fb41

66
README.md Normal file
View file

@ -0,0 +1,66 @@
# Integer Buckets Testing
## Überblick
Dieses Repository dokumentiert das Experiment **integer_buckets_testing**, das die Validierung und Verbesserung der Integer-Buckets-Aggregation sowie die Implementierung von BPF für CI-Messungen untersucht. Dabei werden deterministische Eigenschaften von Aggregationsverfahren geprüft und deren Verhalten unter Nutzung von eBPF- und kprobe-basierten Instrumentierungen verglichen.
[Link zum Artikel](https://donau2space.de/tag-85-nachmittag-integer-buckets-verifiziert-unit-test-kommentiert-naechster-ci-schritt/)
### 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
### 1. integer_buckets_tests
- **Art:** Python-Skript (Unit-Tests)
- **Ziel:** Linux-Userspace
- **Sprachen:** Python
- **Zweck:** Validierung von Integer-Buckets mit Fokus auf deterministische Eigenschaften und dokumentierte Testkommentare.
- **API-Funktion:**
- `test_integer_buckets(data)` → Gibt Assertion-Ergebnisse zur Prüfung der Aggregationskonsistenz zurück.
### 2. bpf_vs_kprobe_analysis
- **Art:** Python-Skript
- **Ziel:** Linux-Userspace
- **Sprachen:** Python
- **Zweck:** Analyse der Laufzeiten von BPF und kprobe, Darstellung von Varianzanalysen zur Performancebewertung.
- **API-Funktion:**
- `compare_bpf_kprobe(runs)` → Gibt Vergleichsergebnisse zu Laufzeitmetriken zurück.
### 3. runbook_snippet
- **Art:** Dokumentation
- **Ziel:** gemischt
- **Sprachen:** keine
- **Zweck:** Erklärung der neuen Testkommentare und deren Kontext innerhalb der Integer-Buckets-Teststrategie.
## Installation & Nutzung
1. **Abhängigkeiten installieren:**
- Python ≥ 3.8 erforderlich
- Empfohlen: Nutzung einer virtuellen Umgebung (`venv`)
- Installation der Abhängigkeiten über `pip install -r requirements.txt`
2. **Testausführung:**
- Ausführen der Tests direkt mit `pytest` oder `python -m unittest`
3. **Analyse starten:**
- `python bpf_vs_kprobe_analysis.py` führt den Laufzeitvergleich durch.
## Typische Use-Cases
- Validierung von Integer-Bucket-Aggregationen innerhalb von CI-Pipelines
- Benchmarking von eBPF- und kprobe-Implementierungen
- Vergleich von deterministischen Aggregationsverhalten im Linux-Userspace
- Nutzung der Runbook-Dokumentation als Grundlage für neue Testkommentierungsrichtlinien
## Struktur & mögliche Erweiterungen
- **test/** enthält Unit-Tests zu Integer-Buckets
- **analysis/** Skripte zur Laufzeitanalyse
- **docs/** Runbook und erklärende Dokumentation
Mögliche Erweiterungen:
- Integration zusätzlicher BPF-Messpunkte
- Erweiterung der Testabdeckung auf fließkomma-basierte Buckets
- Automatisierte CI-Auswertung der Analyseergebnisse
## Lizenz
Dieses Projekt steht unter der **MIT-Lizenz**.
Hinweis: Diese README.md wurde automatisch durch ein KI-System generiert. Alle Angaben ohne Gewähr. Nutzung auf eigene Verantwortung.