README.md aktualisiert

This commit is contained in:
alf
2025-08-16 10:00:33 +00:00
parent 4f10228860
commit 2bb270e1a2

View File

@ -21,3 +21,70 @@ Es unterstützt verschiedene Log-Levels und schreibt sowohl auf die Konsole als
2. Binde es in deinem Script mit `source` ein:
```bash
source /pfad/zu/logger.sh
## Verwendung
### 1. Initialisierung
Setze die Logdatei (optional, Standard: `$HOME/log.txt`):
```bash
log_init "/pfad/zur/logdatei.log" # Benutzerdefinierter Pfad
# oder
log_init # Nutzt den Standardpfad ($HOME/log.txt)
```
### 2. Logging-Funktionen
| Funktion | Beschreibung | Beispiel |
|---------------|----------------------------------|-------------------------------------------|
| `log_info` | Informationsmeldung loggen | `log_info "Das ist eine Info."` |
| `log_warn` | Warnmeldung loggen | `log_warn "Achtung, etwas ist ungewöhnlich!"` |
| `log_error` | Fehlermeldung loggen | `log_error "Ein Fehler ist aufgetreten!"` |
| `log_start` | Script-Start markieren | `log_start "Backup-Prozess"` |
| `log_end` | Script-Ende markieren | `log_end "Backup-Prozess"` |
### 3. Beispiel
```bash
#!/bin/bash
source logger.sh
log_init "$HOME/mein_script.log"
log_start "Datenverarbeitung"
log_info "Starte Datenimport..."
# ... dein Code ...
log_warn "Datenformat unvollständig, aber fortsetzbar."
# ... dein Code ...
log_error "Fehler beim Schreiben der Datei!"
log_end "Datenverarbeitung"
```
---
## Konfiguration
- **Standard-Logdatei**: `$HOME/log.txt`
- **Voreingestellter Pfad im Script**: `$HOME/Gitea/logger/log.txt`
(kann in Zeile 2 der `logger.sh` angepasst werden)
---
## Beispiel-Ausgabe
### In der Konsole:
```
2025-08-16 14:30:00 [INFO] Das ist eine Info.
2025-08-16 14:30:05 [WARN] Achtung, etwas ist ungewöhnlich!
```
### In der Logdatei:
```
2025-08-16 14:30:00 [START] --- Backup-Prozess gestartet ---
2025-08-16 14:30:00 [START] --- Script: ./mein_script.sh ---
2025-08-16 14:30:00 [INFO] Starte Datenimport...
2025-08-16 14:30:05 [WARN] Datenformat unvollständig, aber fortsetzbar.
2025-08-16 14:30:10 [ERROR] Fehler beim Schreiben der Datei!
2025-08-16 14:30:15 [END] --- Backup-Prozess abgeschlossen ---
```
---