- Container orchestration: Pods that might be evicted or OOM-killed before background threads finish uploading traces.
- Distributed training: Multiple processes that write traces in parallel, where any single process might fail.
- Unreliable networks: Environments where connectivity to the Weave server is intermittent.
- Batch jobs: Long-running jobs where losing trace data from a crash is costly.
weave.flush() or weave.finish() before the process exits to ensure all data is uploaded. For more information, see Trace data loss in worker processes.
The write-ahead log is opt-in. It will be enabled by default in a future release.
Enable the write-ahead log
To enable the WAL for your Weave client, set theWEAVE_ENABLE_WAL environment variable to true:
weave.init():
How it works
When the WAL is enabled:- Weave appends each call to the Weave API (object creates, call starts, call ends, and so on) to a JSONL file on disk instead of holding it only in memory.
- Each process writes to its own log file, so parallel processes don’t conflict.
- A background sender reads the log files and flushes their contents to the Weave server.
- After the data is successfully sent, Weave removes the log file.
.weave/wal/ within your working directory, organized by entity and project. Each file contains the raw API requests as JSON objects, one per line.
When the client starts, it checks for existing log files from previous runs. If any are found, the sender flushes them along with any new data. This means Weave automatically recovers data written by a process that crashed the next time the client runs.
Environment variables
The following environment variables control WAL behavior.| Variable | Type | Default | Description |
|---|---|---|---|
WEAVE_ENABLE_WAL | bool | false | Enables the write-ahead log. When set to true, Weave writes the API requests to disk locally before sending them to the server. |
WEAVE_DISABLE_WAL_SENDER | bool | false | Disables the WAL sender. When set to true, Weave writes the requests to disk locally but doesn’t flush them to the server. This is useful for debugging. |