Debian Codegraph @

doc/features/advanced/logviewer.rst

raw
1 .. _ref-to-logviewer:
2
3 Log viewer
4 ==========
5
6 .. meta::
7 :description: DataLab's log viewer
8 :keywords: DataLab, log, viewer, crash, bug, report
9
10 Despite countless efforts (unit testing, test coverage...),
11 DataLab might crash or behave unexpectedly.
12
13 For those situations, DataLab provides two logs (located in your home directory):
14 - "Traceback log", for Python exceptions
15 - "Faulthandler log", for system failures (e.g. Qt-related crash)
16
17 .. note::
18
19 The log viewer is accessible from the "?" menu in the main window.
20
21 .. figure:: /images/shots/logviewer.png
22
23 DataLab log viewer (see "?" menu)
24
25 If DataLab crashed or if any Python exception is raised during
26 its execution, those log files will be updated accordingly.
27 DataLab will even notify that new informations are available in
28 log files at next startup. This is an invitation to submit a bug report.
29
30 Reporting unexpected behavior or any other bug on `GitHub Issues`_
31 will be greatly appreciated, especially if those log file contents
32 are attached to the report (as information on your installation
33 configuration, see :ref:`ref-to-instviewer`).
34
35 .. _GitHub Issues: https://github.com/DataLab-Platform/DataLab/issues/new/choose