Difference between revisions of "Documentation/Nightly/SlicerApplication/ErrorLog"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(4 intermediate revisions by 3 users not shown)
Line 8: Line 8:
  
 
When reporting a bug on the mailing list or in the bug tracker, it is valuable information to include a dump of the errors that appear in the Error Log dialog.
 
When reporting a bug on the mailing list or in the bug tracker, it is valuable information to include a dump of the errors that appear in the Error Log dialog.
 +
 +
==To capture the entire error log for a report==
 +
Open the ''Report bugs and request enhancements'' window, which is accessible from ''Help -> Report a bug''.
 +
* The window shows the current log by default, which can be copied to clipboard easily by pressing the button below
 +
* Recent logs can be explored by selecting an entry in the ''Recent log files'' dropdown
 +
 +
[[Image:ReportBugsAndRequestEnhancements.png|thumb|center|600px|'Report a bug' dialog]]
 +
 +
<!-- (commented out just in case)
 +
* Click in the ErrorLog dialog '''top''' section
 +
* Type Control-A to '''select all''' (Command-A on Mac)
 +
* Click in the ErrorLog dialog '''bottom''' section
 +
* Type Control-A to '''select all''' (Command-A on Mac)
 +
* Type Control-C to '''copy''' (Command-C on Mac)
 +
* Paste from clipboard into your email or issue report
 +
-->
 +
 +
==Analyze error log==
 +
 +
Error log viewer applications can be used for convenient searching and filtering of error logs.
 +
 +
For example, [logging.apache.org/chainsaw/ Apache Chainsaw] log viewer can load and parse Slicer logs using this configuration:
 +
 +
* Select ''Process a log file''
 +
* Log file URL: choose use ''Open File...'' button to select file
 +
* Log file format type: ''PatternLayout format''
 +
* Log file format: <code>[LEVEL][LOGGER] TIMESTAMP [CLASS] (FILE) - MESSAGE</code>
 +
* Log file timestamp format: <code>dd.mm.yyyy HH:mm:ss</code>
 +
 +
[[Image:ApacheChainsawLogAnalysis.png|thumb|center|600px|Viewing and filtering logs using Apache Chainsaw]]

Latest revision as of 16:22, 25 September 2018

Home < Documentation < Nightly < SlicerApplication < ErrorLog


For the latest Slicer documentation, visit the read-the-docs.


Error Log dialog

The error log dialog is accessible from View -> Error Log or via the Ctrl+0 shortcut.

All the outputs (errors, warnings, messages, information) generated by the application and modules are gathered in this dialog. This readout is useful for reporting bugs or usability problems back to the Slicer Development Team.

The dialog is split in 2 parts, the top section is a digest listing of outputs that are merged by type and time. If multiple errors are output within a short period (<1ms) of time from a given component, they will show up as 1 item in the digest list. The bottom section of the dialog prints all the details of the digest list. Selecting one or multiple items in the digest list, results in the printing of all merged lines in the detailed bottom list.

When reporting a bug on the mailing list or in the bug tracker, it is valuable information to include a dump of the errors that appear in the Error Log dialog.

To capture the entire error log for a report

Open the Report bugs and request enhancements window, which is accessible from Help -> Report a bug.

  • The window shows the current log by default, which can be copied to clipboard easily by pressing the button below
  • Recent logs can be explored by selecting an entry in the Recent log files dropdown
'Report a bug' dialog


Analyze error log

Error log viewer applications can be used for convenient searching and filtering of error logs.

For example, [logging.apache.org/chainsaw/ Apache Chainsaw] log viewer can load and parse Slicer logs using this configuration:

  • Select Process a log file
  • Log file URL: choose use Open File... button to select file
  • Log file format type: PatternLayout format
  • Log file format: [LEVEL][LOGGER] TIMESTAMP [CLASS] (FILE) - MESSAGE
  • Log file timestamp format: dd.mm.yyyy HH:mm:ss
Viewing and filtering logs using Apache Chainsaw