Skip to content

Commit de1bfff

Browse files
craig[bot]williamchoe3
andcommitted
Merge #151492
151492: roachtest: readme notes for finding crdb logs on local deployments r=williamchoe3 a=williamchoe3 Adding notes to `readme.md` on finding local crdb logs from running roachtest locally because Stan and I noticed that specific information not being documented anywhere. Co-authored-by: William Choe <[email protected]>
2 parents e6ae789 + 76b8b70 commit de1bfff

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

pkg/cmd/roachtest/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,19 @@ laptop online. The CI job is run as follows:
225225
* Changes → Build branch: `<branch>`
226226
* Parameters → `env.TESTS`: `^<test>$`
227227
* Parameters → `env.COUNT`: `<runs>`
228+
229+
### Cockroach node logs and artifacts for roachtests running locally
230+
231+
When running tests locally, you may want to inspect cockroach node logs
232+
`logs/<n>.cockroach.log` or specific channel / stderr logs that are in `<n>.unredacted/`
233+
e.g.
234+
* `logs/1.cockroach.log`
235+
* `logs/1.unredacted/cockroach-kv-distribution.log`
236+
237+
When using roachtest locally, these logs are placed in your home directory in
238+
`~/local/<n>/` e.g. `~/local/1/`.
239+
240+
Note: These directories will be cleared when your deployment is being deleted,
241+
i.e. after your test run. To keep these logs & artifacts use `roachtest run`
242+
flags `--debug` or `--debug-always` to keep your deployment. See `roachtest run -h`
243+
for more information.

0 commit comments

Comments
 (0)