Add readme_md
This commit is contained in:
parent
2924607066
commit
f54442ab2d
1 changed files with 95 additions and 0 deletions
95
readme_md
Normal file
95
readme_md
Normal file
|
|
@ -0,0 +1,95 @@
|
||||||
|
# gate_v1_logging_experiment
|
||||||
|
|
||||||
|
## Überblick
|
||||||
|
Dieses Experiment untersucht die Testung und Protokollierung von warnenden Entscheidungen innerhalb eines CI-Umfelds. Es dient der Analyse, wie Entscheidungen, Warnraten und Ablaufmechanismen im Gate-V1-System nachvollziehbar dokumentiert und ausgewertet werden können.
|
||||||
|
|
||||||
|
[Artikel lesen](https://donau2space.de/tag-157-100-wolken-leichter-regen-ich-lasse-gate-v1-zum-ersten-mal-warn-sagen-und-ich-entscheide-ob-ich-ihm-glaube/)
|
||||||
|
[Git Repository](https://git.donau2space.de/Mika/gate_v1_logging_experiment)
|
||||||
|
|
||||||
|
### 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 drei Python-Skripte (linux-userspace) zur Erfassung, Protokollierung und Analyse von Entscheidungen und Abläufen in einem kontinuierlichen Integrationssystem.
|
||||||
|
|
||||||
|
### Artefakte
|
||||||
|
|
||||||
|
#### 1. logging_module
|
||||||
|
- **Art:** python_script
|
||||||
|
- **Ziel:** linux-userspace
|
||||||
|
- **Sprache:** Python
|
||||||
|
- **Zweck:** Protokollierung von Entscheidungen und Analyse der WARN-Raten während CI-Runs.
|
||||||
|
|
||||||
|
**API-Funktionen:**
|
||||||
|
- `log_decision(decision_type, reason_code)` – erfasst und speichert Entscheidungen inklusive Begründung.
|
||||||
|
- `generate_report()` – erstellt einen zusammenfassenden Bericht der protokollierten Entscheidungen.
|
||||||
|
|
||||||
|
**Datenstrukturen:**
|
||||||
|
- `LogEntry (json)` – Felder: `timestamp`, `decision_type`, `reason_code`, `additional_info`
|
||||||
|
|
||||||
|
#### 2. whitelist_expiration
|
||||||
|
- **Art:** python_script
|
||||||
|
- **Ziel:** linux-userspace
|
||||||
|
- **Sprache:** Python
|
||||||
|
- **Zweck:** Verwaltung von Whitelist-Einträgen mit definiertem Ablaufdatum.
|
||||||
|
|
||||||
|
**API-Funktionen:**
|
||||||
|
- `set_expiration(entry_id, days)` – legt die Ablaufzeit eines Whitelist-Eintrags fest.
|
||||||
|
- `renew_entry(entry_id)` – verlängert einen bestehenden Eintrag, falls möglich.
|
||||||
|
|
||||||
|
**Datenstrukturen:**
|
||||||
|
- `WhitelistEntry (json)` – Felder: `entry_id`, `expires_at`, `reason_code`
|
||||||
|
|
||||||
|
#### 3. timing_analysis
|
||||||
|
- **Art:** python_script
|
||||||
|
- **Ziel:** linux-userspace
|
||||||
|
- **Sprache:** Python
|
||||||
|
- **Zweck:** Analyse von Timing-Offsets zwischen internen Variablen und Prozessen.
|
||||||
|
|
||||||
|
**API-Funktionen:**
|
||||||
|
- `analyze_timing_offsets(timing_data)` – berechnet zeitliche Abweichungen zwischen Prozessschritten.
|
||||||
|
- `report_timing_anomalies()` – erstellt einen Bericht identifizierter Anomalien.
|
||||||
|
|
||||||
|
**Datenstrukturen:**
|
||||||
|
- `TimingData (json)` – Felder: `timestamp`, `t_gate_read`, `t_index_visible`, `offset`
|
||||||
|
|
||||||
|
## Installation & Nutzung
|
||||||
|
Erfordert eine funktionierende Python-Umgebung (Python ≥ 3.8) und Standardbibliotheken.
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
1. Repository klonen:
|
||||||
|
```bash
|
||||||
|
git clone https://git.donau2space.de/Mika/gate_v1_logging_experiment
|
||||||
|
cd gate_v1_logging_experiment
|
||||||
|
```
|
||||||
|
2. Abhängigkeiten installieren (falls vorhanden):
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Nutzung
|
||||||
|
Module können direkt über Python importiert oder als eigenständige Skripte ausgeführt werden. Beispiel:
|
||||||
|
```bash
|
||||||
|
python logging_module.py
|
||||||
|
python whitelist_expiration.py
|
||||||
|
python timing_analysis.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## Typische Use-Cases
|
||||||
|
- Erfassung und Analyse von Entscheidungen mit Warnstatus im CI-System.
|
||||||
|
- Verwaltung temporärer Berechtigungen und Whitelists.
|
||||||
|
- Untersuchung zeitlicher Abweichungen zwischen Gate-Systemkomponenten.
|
||||||
|
|
||||||
|
## Struktur & mögliche Erweiterungen
|
||||||
|
- Einbindung zusätzlicher Log-Typen über `logging_module`.
|
||||||
|
- Erweiterung der Whitelist-Logik um automatisierte Bereinigung.
|
||||||
|
- Integration der Timing-Analyse in Überwachungsdashboards.
|
||||||
|
- Optionale Anbindung an externe Reportingsysteme.
|
||||||
|
|
||||||
|
## Lizenz
|
||||||
|
Dieses Projekt steht unter der **MIT-Lizenz**.
|
||||||
|
|
||||||
|
---
|
||||||
|
*Diese README-Datei wurde automatisch generiert. Nutzung auf eigene Verantwortung.*
|
||||||
Loading…
Reference in a new issue