The Console shows your Burrow's server output as it happens: the requests it handles, the messages it writes, and errors with their full stack traces. Use it to see what the server is doing right now, or to find out why something failed. For who did what in the Burrow, see the Audit log.
Opening it#
Open the account menu in the top right and select Console. The Owner can always open it. Anyone else needs a role that grants Console, which none of the built-in roles do, so it has to be a custom role.
The page opens with the most recent 500 lines, then adds each new line as the server writes it. The status in the top right shows the connection:
Status | Meaning |
|---|---|
Live | Connected. New lines appear as they are written. |
Reconnecting | The connection dropped, for example while the Burrow restarts. It reconnects on its own. |
Paused | You paused the view. See Pausing below. |
Session ended | You were signed out, or your role no longer grants Console. The stream stops as soon as either happens. |
Reading a line#
Part | Shows |
|---|---|
Time | When the line was written, in your local time, to the millisecond. |
Level | INFO for normal operation, WARN for something worth a look, ERROR for a failure. DEBUG and TRACE appear only rarely. |
Source | The part of the server that wrote the line. |
Message | What happened. A stack trace follows the line it belongs to, indented beneath it. |
Filtering#
Type in Filter lines to show only lines whose message or source contains that text. A matching line keeps its stack trace with it. Use the level menu to hide the quieter lines:
All levels
Info and above
Warnings and above
Errors only
While a filter is set, the line under the title shows how many lines match out of how many there are. Filters only change what you see; lines that don't match are still kept and come back when you clear the filter.
Pausing#
Select Pause to hold the view still, for example to read a stack trace while lines keep arriving. New lines are kept while you are paused, and the button shows how many are waiting. Select Resume to add them in order and carry on. Up to 5,000 lines are held during a pause; past that, the oldest held lines are dropped.
Scrolling up also stops the view from following new lines. Select Jump to latest to go back to the bottom.
The page keeps the latest 5,000 lines. Older ones leave the page but stay in the log files.
Saving and clearing#
Save view downloads exactly what is on screen, with your filters applied, as a plain text .log file. Clear empties the view. It doesn't touch the server's logs, and reopening the page shows the most recent lines again.
Log files#
Select Log files to see the files the server writes, which go back further than the page and survive a restart. The list shows burrow.log, the file being written now, then older files, newest first, each with its size and a download button. Beneath the list are the folder they are in and their total size.
The files are in the logs folder of the Burrow's data directory. A new file starts each day, and whenever the current one reaches 20 MB. Files are kept for 14 days, up to 200 MB in total, and the oldest are removed first.
In the audit log#
Opening the Console and downloading a log file are both recorded in the audit log, with who did it and where from. Save view builds its file in your browser from what is already on screen, so it adds no entry of its own.