Passer au contenu principal
Le journal à écriture anticipée (WAL) enregistre les requêtes API sur disque avant de les envoyer au serveur. Par défaut, le client met les requêtes en mémoire tampon. Si le processus s’arrête de manière inattendue, les données mises en mémoire tampon sont perdues. Le WAL de Weave résout ce problème en écrivant les requêtes sur disque avant de les envoyer. Lorsque vous activez le WAL, le client écrit d’abord chaque requête API dans un fichier JSONL local, puis en envoie le contenu au serveur. Si un processus plante ou si le serveur est inaccessible, les données restent sur disque et Weave les envoie automatiquement lorsque le client est relancé. Le WAL est particulièrement utile dans les environnements où les processus peuvent être interrompus ou le serveur temporairement indisponible :
  • Orchestration de conteneurs : pods susceptibles d’être évincés ou arrêtés faute de mémoire avant que les threads d’arrière-plan aient fini de téléverser les traces.
  • Entraînement distribué : plusieurs processus écrivent des traces en parallèle, et l’un d’eux peut échouer.
  • Réseaux peu fiables : environnements où la connectivité au serveur Weave est intermittente.
  • Tâches par lots : tâches de longue durée pour lesquelles la perte de données de trace à la suite d’un plantage est coûteuse.
Pour les environnements de courte durée comme les fonctions serverless, envisagez également d’appeler weave.flush() ou weave.finish() avant la fin du processus afin de vous assurer que toutes les données sont téléversées. Pour plus d’informations, voir Perte de données de trace dans les processus worker.
Le journal à écriture anticipée doit être activé explicitement. Il sera activé par défaut dans une future version.

Activer le journal à écriture anticipée

Pour activer le WAL pour votre client Weave, définissez la variable d’environnement WEAVE_ENABLE_WAL sur true :
export WEAVE_ENABLE_WAL=true
Vous pouvez également le configurer en Python avant d’appeler weave.init() :
import os
os.environ["WEAVE_ENABLE_WAL"] = "true"
Aucune autre modification du code n’est nécessaire. Le WAL fonctionne de façon transparente avec le code de tracing Weave existant.

Fonctionnement

Lorsque le WAL est activé :
  1. Weave ajoute chaque appel à l’API Weave (création d’objet, début d’appel, fin d’appel, etc.) à un fichier JSONL sur disque au lieu de le conserver uniquement en mémoire.
  2. Chaque processus écrit dans son propre fichier journal, afin que les processus parallèles n’entrent pas en conflit.
  3. Un processus d’envoi en arrière-plan lit les fichiers journaux et effectue le vidage de leur contenu vers le serveur Weave.
  4. Une fois les données envoyées avec succès, Weave supprime le fichier journal.
Les fichiers journaux sont stockés dans .weave/wal/ dans votre répertoire de travail, organisés par entité et par projet. Chaque fichier contient les requêtes API brutes sous forme d’objets JSON, à raison d’un objet par ligne. Au démarrage du client, celui-ci vérifie s’il existe des fichiers journaux issus d’exécutions précédentes. S’il en trouve, le processus d’envoi en effectue le vidage avec les nouvelles données. Cela signifie que Weave récupère automatiquement, au prochain démarrage du client, les données écrites par un processus qui a planté.

Variables d’environnement

Les variables d’environnement suivantes contrôlent le comportement du WAL.
VariableTypeDefaultDescription
WEAVE_ENABLE_WALboolfalseActive le journal à écriture anticipée. Lorsqu’elle est définie sur true, Weave écrit les requêtes API localement sur le disque avant de les envoyer au serveur.
WEAVE_DISABLE_WAL_SENDERboolfalseDésactive l’expéditeur WAL. Lorsqu’elle est définie sur true, Weave écrit les requêtes localement sur le disque, mais n’effectue pas leur vidage vers le serveur. C’est utile pour le débogage.
Pour obtenir la liste de toutes les variables d’environnement disponibles pour Weave, voir la page de référence des variables d’environnement.