Updated Log files (markdown)

master
Peter Hutterer 2019-08-23 13:45:33 +10:00
parent fb1f2d53a9
commit ffb0ed30c5
1 changed files with 32 additions and 0 deletions

@ -2,6 +2,38 @@ Downloading drawings from a tablet is destructive - the drawings get deleted aft
The default directory for all of Tuhi's data storage is `$XDG_DATA_DIR/tuhi`, usually `$HOME/.local/share/tuhi/`. Inside are the various data files Tuhi uses.
An example for the files in that directory:
```
$ tree $XDG_DATA_DIR/tuhi
/home/username/.local/share/tuhi/
├── 1566523887.json # The json files used by the GUI
├── 1566523888.json.deleted # A deleted drawing
├── 1566523990.json
├── DC:2C:26:A0:C9:A8
│   ├── 1566523887.json # cached by the tuhi server, these files
│ ├── 1566523887.json # may be removed at any time when the
│ ├── 1566523990.json # server decides to purge old files
│   ├── raw
│   │   ├── log-1566523792-2019-08-23-11:29:52.yaml # raw data logs, never deleted
│   │   ├── log-1566523813-2019-08-23-11:30:13.yaml
│   │   ├── log-1566523880-2019-08-23-11:31:20.yaml
│   │   └── log-1566531491-2019-08-23-13:38:11.yaml
│   └── settings.ini # stores the device settings
└── session-logs # session logs, never deleted
├── tuhi-19-08-23-11:29:39.log
├── tuhi-19-08-23-11:30:49.log
├── tuhi-19-08-23-11:31:14.log
├── tuhi-19-08-23-13:17:59.log
├── tuhi-19-08-23-13:34:44.log
└── tuhi-19-08-23-13:36:26.log
```
## Session logs
The log output of a tuhi session is saved to `$XDG_DATA_DIR/tuhi/session-logs` with a timestamp as name. This is the equivalent of piping the commandline output into that log file.
## Raw log files
Any communication between Tuhi and the device is logged as a YAML file in `$XDG_DATA_DIR/tuhi/<bluetooth address>/raw/`. The files are named after the time they were created, e.g. `log-1565844084-2019-08-15-14:41:24.yaml`, i.e. in the format `log-$UNIX_TIMESTAMP-$HUMAN_READABLE_TIME.yaml`.