This is an old revision of the document!

Documentation » Configuration » Preferences Dialog »

Logging Tab (Preferences Dialog)

Logging tab allows user to configure session logging. For easier access before opening a session, the tab is duplicated on Login dialog.

Advertisement

To enable logging, select logging format, Text log or XML log.

Once the logging is enabled, you can configure the Logging options.

In Logging level you can select Debug 1 or Debug 2 for more verbose logging. You will probably need these (together with logging to file), when reporting bugs only.

To enable logging to file tick Log to file checkbox and specify log file. Log file name can contain following patterns: !Y (year), !M (month), !D (day), !T (time), !@ (hostname), !S (session name), !! (exclamation mark); and environment variables with syntax %NAME%. It is not possible to change log file name in middle of the session for XML logging.

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. Appending is not allowed for XML logging.

If you enable logging to file in mid-session the past events will not be written to the log retrospectively. Note that simultaneous logging of several sessions to file is not supported. 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.

Last modified: by martin