Differences
This shows you the differences between the selected revisions of the page.
| ui_pref_logging 2013-04-29 | ui_pref_logging 2023-11-22 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== Logging Tab (Preferences Dialog) ====== | + | ====== The Logging Page (Preferences Dialog) ====== |
| - | The //Logging tab// on the [[ui_preferences|Preferences dialog]] allows user to configure [[logging|session and XML logging]]. For easier access before opening a session, the tab is duplicated on [[ui_login_logging|Login dialog]]. | + | The //Logging page// on the [[ui_preferences|Preferences dialog]] allows user to configure [[logging|session and XML logging]]. |
| &screenshotpict(pref_logging) | &screenshotpict(pref_logging) | ||
| - | ===== Session log ===== | + | &toc_title_page_sections |
| - | To enable session log, check //Enable session logging on level//. | + | |
| - | To increase verbosity of the session log select //Debug 1// or //Debug 2// level. You will probably need these (together with logging to file), when [[reporting|reporting bugs]] only. | + | ===== [[session_log]] Session log ===== |
| + | To enable logging to a file, check //Enable session logging on level//. | ||
| - | To enable logging to file tick //Log to file// checkbox and specify [[local_path|local path]] to log file. Log file name can contain following patterns: ''!Y'' (year), ''!M'' (month), ''!D'' (day), ''!T'' (time), ''!@'' (hostname), ''!S'' (session name), ''!P'' (process ID), ''!!'' (exclamation mark). | + | To increase a verbosity of the session log, select //Debug 1// or //Debug 2// level. You will probably need these (together with a logging to file), when [[reporting|reporting bugs]] only. The //Debug 2// level can significantly deteriorate performace. To decrease a verbosity of the session log, select //Reduced// level. |
| + | |||
| + | Specify [[local_path|local path]] to log file into //Log path// box. Log file name can contain following patterns: ''!Y'' (year), ''!M'' (month), ''!D'' (day), ''!T'' (time), ''!@'' (hostname), ''!S'' (session name), ''!P'' (process ID), ''!!'' (exclamation mark). | ||
| If you select //Append// option, and the logging file already exists, session log will be appended to the end of the file. Otherwise the existing file will be overwritten. | If you select //Append// option, and the logging file already exists, session log will be appended to the end of the file. Otherwise the existing file will be overwritten. | ||
| + | |||
| + | You can limit a log file size by specifying a maximum size in bytes in //Rotate log files after reaching// box. Supported units are ''K'', ''M'' and ''G''. If a log file reaches the configured limit, it is archived to a file with extension ''.1'', ''.2'', etc. You can limit number of archived log files using //Delete old logs files, keep ... files// checkbox. | ||
| If you enable logging to file in mid-session the past events will not be written to the log retrospectively. Note that to log several sessions simultaneously to file, you need to ensure unique names of the log files (e.g. using some of the patterns above). Passwords are not written to log file. | If you enable logging to file in mid-session the past events will not be written to the log retrospectively. Note that to log several sessions simultaneously to file, you need to ensure unique names of the log files (e.g. using some of the patterns above). Passwords are not written to log file. | ||
| - | When you tick //Show log window// checkbox, session log window will appear. For peformance reasons it is recommended to limit number of displayed lines. Note that if you tick //Show log window// checkbox on Login dialog, the log window will appear only after you open the session. Once the session is already opened you can show/hide log window also from //Options// menu and from toolbar. If you display log window in mid-session the past events will be displayed only if the //Enable logging// was already ticked before. | + | Tick //Log passwords and other sensitive information// to turn off obfuscation of passwords and other sensitive information in session log. It is useful when debugging authentication issues. |
| - | ===== XML log ===== | + | ===== [[xml]] XML log ===== |
| To enable [[logging_xml|XML log]], check //Enable XML logging to file// and specify [[local_path|local path]] to log file. You can use the same patterns as for session log file (see above). | To enable [[logging_xml|XML log]], check //Enable XML logging to file// and specify [[local_path|local path]] to log file. You can use the same patterns as for session log file (see above). | ||
| Line 23: | Line 27: | ||
| ===== Further Reading ===== | ===== Further Reading ===== | ||
| - | Read more about [[ui_preferences|Preferences dialog]] and its other [[ui_preferences#tabs|tabs]]. | + | Read more about [[ui_preferences|Preferences dialog]] and its other [[ui_preferences#pages|pages]]. |