Show/Hide Toolbars

The Smart Client logs information that might me valuable to administrators or support personnel for tuning performance, tracking down configuration errors and finding reasons for errors. The data logged is logged in form of log entries that contain textual information in English language together some metadata as described in table 1.

For a persistent record of this data the Application Server makes use of its own logging engine that persists log messages according to a default log configuration.You may override this default behavior by providing your own nlog.config file in the Smart Client Application directory, for more information on creating custom log configurations visit the NLog website. The Logging chapter for the Application Server also lists examples for custom logging configuration.

The default logging configuration for the smart clients writes all log messages to files in the log files directory.

Log files are named like Smart Client Log <YYYY-MM_DD hh:mm:ss>.txt. The files contain the time stamp, the log level and the message of the log entries. The date encoded in the file name is the date of the first entry in the log file.

All log data with a Log level of Error or Fatal will be additionally written to the Windows Event Log. The event log entry will contain the time stamp, the log level and the message of the log entries and if the log entry contains an exception also the textual representation of that exception. The Event log entries are written to the Application Event log and the source for the entries is Application.

For debugging and support important log messages are logged directly a logentries.com account owned by Pöyry Infra GmbH.

Whenever the Smart Client encounters an unexpected problem, and therefore shuts down unexpectedly it will also copy some error information to the Windows Clipboard.

Log entry element

Description

Time stamp of logging

Date and time when the log entry was generated

Message

Textual information

Log level

Trace - very detailed logs, which may include high-volume information such as protocol payloads. This log level is typically only enabled during development

Debug - debugging information, less detailed than trace, typically not enabled in production environment.

Info - information messages, which are normally enabled in production environment

Warn - warning messages, typically for non-critical issues, which can be recovered or which are temporary failures

Error - error messages

Fatal - very serious errors

System exception

Exceptions thrown by the system (optional)

Table 1: Data stored in a log entry

Log source

Description

SmartClient

A very general log source for most things logged by the Smart Client

Table 2: Log message sources used by the Smart Client

© 2021 AFRY Austria GmbH, www.redbex.com