Skip to content

Commit 3143c0f

Browse files
committed
FAQ: Update to OTD's new logging method
OpenTabletDriver removed the `daemon.log` crash file and instead logs everything to a single folder. See OpenTabletDriver/OpenTabletDriver#3100 on GitHub for more information
1 parent 5751bf7 commit 3143c0f

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

site/_wiki/Documentation/Logs.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,35 @@ title: Logs
44

55
## GUI
66

7-
To view logs, click on the <kbd>Console</kbd> tab. Optionally, change filter from <kbd>Information</kbd> to <kbd>Debug</kbd> for more detailed logs.
7+
To view the current logs, click on the <kbd>Console</kbd> tab. Optionally, change filter from <kbd>Information</kbd> to <kbd>Debug</kbd> for more detailed logs.
88

9-
To export logs, click <kbd>Help</kbd> ⇒ <kbd>Export diagnostics</kbd> in the top menu bar.
9+
You can also find previous logs in the `Logs/` folder of the application data location.
10+
See more in the [Daemon log](#daemon-log) section.
1011

11-
Sometimes, the OpenTabletDriver daemon can crash hard enough that the errors can't be
12-
sent to the GUI. In this case, you can find a
13-
partial log in the location specified [here](#daemon-log).
12+
To export logs, click <kbd>Help</kbd> ⇒ <kbd>Export diagnostics</kbd> in the top menu bar.
1413

1514
## Daemon
1615

17-
The output from daemon is the log.
16+
The output from daemon is logged to the `Logs/` folder.
1817

19-
On Linux when running daemon via systemd service, the log for the daemon is recorded by systemd.
18+
On Linux when running daemon via systemd service, the log for the daemon is also recorded by systemd.
2019
To view that log, run the following command as your user:
2120

2221
```bash
2322
journalctl --user-unit opentabletdriver.service
2423
```
2524

26-
### Exception Log Location {#daemon-log}
25+
### Daemon Log Location {#daemon-log}
26+
27+
If the daemon crashes from an "unrecoverable" exception, the error is appended to the log file.
28+
It contains a stack trace defining where the error happened, which is useful for debugging.
29+
30+
Up to 20 log files will be stored in the `Logs/` folder, using the date of when the daemon started as a file name.
2731

28-
If the daemon crashes from an "unrecoverable" exception, the `daemon.log` file will
29-
include a stack trace defining where the error happened, which is useful for debugging.
32+
The log files are formatted in an almost-JSON format. It is likely they are missing the array end (`]`) which
33+
some JSON parsers do not like. However, the format remains mostly human-readable.
3034

31-
The `daemon.log` file is in the application data folder, located here:
35+
The `Logs/` folder is in the application data folder, located here:
3236

3337
{% include appdata-location.md %}
3438

site/_wiki/FAQ/General.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The application data directory contents are as follows:
4141
| :---------------: | :----: | :---------- |
4242
| `settings.json` | File | Stores the driver settings
4343
| `tablet-data.txt` | File | Stores the recorded tablet data from Tablet Debugger
44-
| `daemon.log` | File | Contains a stack trace if the daemon has crashed
44+
| Logs | Folder | Contains up to 20 daemon logs in near-JSON format ([more info]({% link _wiki/Documentation/Logs.md %}#daemon-log))
4545
| Backup | Folder | Contains old versions of OpenTabletDriver and its settings
4646
| Cache | Folder | Contains cached metadata for the Plugin Manager
4747
| Plugins | Folder | Contains installed plugins (`.dll` files). This folder should not be modified manually.

0 commit comments

Comments
 (0)