39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
<!-- file: kb-logging/README.md -->
|
||
<!-- version: 3 -->
|
||
|
||
# kb-logging
|
||
|
||
`kb-logging` initialise le subscriber global `tracing` à partir d’une configuration de routes explicites vers la console ou des fichiers.
|
||
|
||
## Responsabilités
|
||
|
||
- sélectionner les routes activées ;
|
||
- appliquer niveaux, targets exactes et préfixes wildcard ;
|
||
- créer les writers non bloquants ;
|
||
- gérer les formats human, compact, pretty et JSON ;
|
||
- gérer les rotations de fichiers supportées ;
|
||
- conserver les `WorkerGuard` pendant toute la durée du processus.
|
||
|
||
## Hors périmètre
|
||
|
||
La crate ne charge pas le fichier de configuration et ne définit pas les targets des autres crates. `kb-config` fournit les valeurs et chaque crate publie son propre target canonique.
|
||
|
||
## API publique
|
||
|
||
- `init_logging` initialise le subscriber global ;
|
||
- `LoggingConfig`, `LogTargetConfig` et `LogTargetFilterConfig` décrivent les routes ;
|
||
- `LoggingGuard` maintient les writers et expose les routes installées ;
|
||
- `tracing_target` retourne le target canonique de la crate ;
|
||
- `LogFileRoute` reste disponible pour les anciens appelants file-only.
|
||
|
||
## Statut
|
||
|
||
L’initialisation multi-routes est fonctionnelle. Elle échoue explicitement si aucune route n’est activée ou si le subscriber global a déjà été initialisé.
|
||
|
||
## Documents
|
||
|
||
- [Utilisation](USAGE.md)
|
||
- [Travaux restants](TODO.md)
|
||
- [Historique](CHANGELOG.md)
|
||
- [Guide de configuration](../kb-config/USAGE.md)
|