exit_metrics_analysis/metrics_visualization/README.md

97 lines
No EOL
3 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Metrics Visualization App
## Überblick
Die **Metrics Visualization App** ist ein webbasiertes Dashboard zur Analyse und Visualisierung von Exit-Metriken über verschiedene Runs hinweg. Sie unterstützt technische Nutzer und Analysten bei der Identifikation von Trends, Anomalien und Qualitätsabweichungen in den Messdaten.
---
## Ziel der Anwendung
Das Frontend dient der **vergleichenden Betrachtung von Laufmetriken**, um Fragestellungen wie folgende zu beantworten:
- Wie entwickeln sich Warn- und Fehlerraten über Runs hinweg?
- Gibt es auffällige Veränderungen in der DeltatVerteilung (Δt < 0)?
- Weichen Runs mit gleichem `setup_fingerprint` signifikant voneinander ab?
---
## Hauptfunktionen
- 🔹 **Visualisierung von ExitMetriken:** Darstellung von `warn_rate`, `unknown_rate` und `Δt < 0` pro Run
- 🔹 **RunVergleich:** Gegenüberstellung von Runs mit identischem `setup_fingerprint`
- 🔹 **Filterfunktion:** Eingrenzung auf *pinned* oder *unpinned* Runs
- 🔹 **Interaktive UI:** Dynamische Tabellen und Diagramme, aktualisiert über Benutzerfilter
- 🔹 **APIIntegration:** LiveAbruf der Metrikdaten über `/metrics`
- 🔹 **Responsive Layout:** Optimiert für Desktop und Tablet
---
## Datenfluss
1. **Fetch:** Die Anwendung ruft über die Route `/metrics` (GET) aktuelle Metrikdaten ab.
2. **Processing:** Die Daten werden im Browser aufbereitet und zwischengespeichert.
3. **Rendering:** Diagramme und Tabellen werden auf Grundlage der Metrikdaten gerendert.
4. **Interaction:** Änderungen des Filters führen zu neuem APIAbruf und aktualisierter Anzeige.
---
## API-Nutzung
**Route:** `/metrics`
**Methode:** `GET`
**Optionale Parameter:**
- `filter=pinned|unpinned`
- `setup_fingerprint=<id>`
**Beispielhafte Response:**
```json
[
{
"run_id": "run_001",
"setup_fingerprint": "fp_a1b2c3",
"warn_rate": 0.12,
"unknown_rate": 0.03,
"delta_t_stats": { "lt_zero": 5 },
"timestamp": "2026-02-12T09:21:00Z"
}
]
```
**Verwendung in JSDateien:**
- `js/api.js`: Schnittstelle zum Abruf der Metrikdaten
- `js/app.js`: Initialisierung, StateManagement und Logik
- `js/ui.js`: DOMUpdate und Interaktionen
---
## Struktur
```
metrics_visualization/
├─ index.html # Einstiegspunkt des Dashboards
├─ css/
│ └─ style.css # Basislayout und Komponentenstile
├─ js/
│ ├─ app.js # App-Initialisierung und State-Verwaltung
│ ├─ api.js # API-Aufrufe (GET /metrics)
│ └─ ui.js # UI-Komponenten und DOM-Manipulationen
└─ README.md # Dokumentation
```
---
## Deployment-Hinweise
1. **Build & Serve:** Einfaches statisches Hosting reicht (z.B. Nginx oder Node.js Static Server).
2. **APIEndpunkt:** Der Server muss die Route `/metrics` bereitstellen; CORS muss für das Frontend erlaubt sein.
3. **Caching:** Optionale Nutzung clientseitigen Caches für wiederholte Abfragen.
4. **Responsiveness:** Test auf 768px und 1024px Viewports empfohlen.
---
## Lizenz & Copyright
© 2026 Donau2Space.de