From 3143c0ffd0243dedb7d4b3f2807099eb511594a9 Mon Sep 17 00:00:00 2001 From: Sebastian 'gonX' Jensen Date: Mon, 11 Mar 2024 09:54:02 +0100 Subject: [PATCH] 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 --- site/_wiki/Documentation/Logs.md | 26 +++++++++++++++----------- site/_wiki/FAQ/General.md | 2 +- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/site/_wiki/Documentation/Logs.md b/site/_wiki/Documentation/Logs.md index 924a2eb..03a3cfa 100644 --- a/site/_wiki/Documentation/Logs.md +++ b/site/_wiki/Documentation/Logs.md @@ -4,31 +4,35 @@ title: Logs ## GUI -To view logs, click on the Console tab. Optionally, change filter from Information to Debug for more detailed logs. +To view the current logs, click on the Console tab. Optionally, change filter from Information to Debug for more detailed logs. -To export logs, click Help ⇒ Export diagnostics in the top menu bar. +You can also find previous logs in the `Logs/` folder of the application data location. +See more in the [Daemon log](#daemon-log) section. -Sometimes, the OpenTabletDriver daemon can crash hard enough that the errors can't be -sent to the GUI. In this case, you can find a -partial log in the location specified [here](#daemon-log). +To export logs, click Help ⇒ Export diagnostics in the top menu bar. ## Daemon -The output from daemon is the log. +The output from daemon is logged to the `Logs/` folder. -On Linux when running daemon via systemd service, the log for the daemon is recorded by systemd. +On Linux when running daemon via systemd service, the log for the daemon is also recorded by systemd. To view that log, run the following command as your user: ```bash journalctl --user-unit opentabletdriver.service ``` -### Exception Log Location {#daemon-log} +### Daemon Log Location {#daemon-log} + +If the daemon crashes from an "unrecoverable" exception, the error is appended to the log file. +It contains a stack trace defining where the error happened, which is useful for debugging. + +Up to 20 log files will be stored in the `Logs/` folder, using the date of when the daemon started as a file name. -If the daemon crashes from an "unrecoverable" exception, the `daemon.log` file will -include a stack trace defining where the error happened, which is useful for debugging. +The log files are formatted in an almost-JSON format. It is likely they are missing the array end (`]`) which +some JSON parsers do not like. However, the format remains mostly human-readable. -The `daemon.log` file is in the application data folder, located here: +The `Logs/` folder is in the application data folder, located here: {% include appdata-location.md %} diff --git a/site/_wiki/FAQ/General.md b/site/_wiki/FAQ/General.md index e2fcd96..22188e8 100644 --- a/site/_wiki/FAQ/General.md +++ b/site/_wiki/FAQ/General.md @@ -41,7 +41,7 @@ The application data directory contents are as follows: | :---------------: | :----: | :---------- | | `settings.json` | File | Stores the driver settings | `tablet-data.txt` | File | Stores the recorded tablet data from Tablet Debugger -| `daemon.log` | File | Contains a stack trace if the daemon has crashed +| Logs | Folder | Contains up to 20 daemon logs in near-JSON format ([more info]({% link _wiki/Documentation/Logs.md %}#daemon-log)) | Backup | Folder | Contains old versions of OpenTabletDriver and its settings | Cache | Folder | Contains cached metadata for the Plugin Manager | Plugins | Folder | Contains installed plugins (`.dll` files). This folder should not be modified manually.