Configuring the Log Level in AWI

{"URL":["/*.*/awa/administration_awi_logging"],"heroDescriptionIdentifier":"ice_logging_intro","customCards":[{"id":"ice_modify_logging","title":"Modifying the Log Level in AWI","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Admin/admin_AWI_Logging.htm","languages":["en-us"]},{"id":"ice_administration_perspective","title":"Understanding the Administration Perspective","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Admin/AdministrationPerspective.htm","languages":["en-us"]},{"id":"ice_Overview_AWI","title":"Understanding the User Interface","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/_Common/GettingStarted/GS_OverviewAWI.htm","languages":["en-us"]}]}

When errors occur, the logging information helps you find and troubleshoot the reason. The AWI logging is enabled by default, with INFO as the default log level. As an administrator with the privilege to Create diagnostic information, you can change the AWI log level so that more or less event occurrences are written to the log file.

You can change the AWI log level in two different ways:

Through the AWI Management > Logging page in the user interface, as described in this section
By editing the logback.xml configuration file, where the log level is defined, see logback.xml - Configuring Log Levels

Important! Changing the log level through the UI is only possible in Client 0.

Modifying the Log Level in AWI

Follow the instructions below to modify the log level in the Automic Web Interface.

Log in to Client 0 and, in the Administration perspective, go to AWI Management . The Logging page is displayed.
In Logs Include select the log level you want to apply to the log files.

There are five log levels. The available log levels from highest to lowest are:
- ERROR
  
  Failure of some action of an AWI component that AWI was not able to recover from, such as nullPointExceptions or closedStreamExceptions.
  
  Tracing Data in Message
  
  No user-identifying data. However, hostnames, other site-specific data, class names, object names, and the like are included with the event related specifications. The message contains the full stack trace.
- WARNING
  
  Unexpected behavior of an AWI component, such as unstable network connections that require auto-reconnect from AWI, a post-timeout retry, or triggering of a workaround for a third-party bug .
  
  Tracing Data in Message
  
  Same as ERROR level
- INFO (default)
  
  Configuration values at login or component startup, or global configuration changes.
  
  Tracing Data in Message
  
  Same as ERROR level but without the full stack trace.
- DEBUG
  
  High-level user-specific actions such as login/logout events, user changes (such as object edits), authorization related events (such as successful/failed setup actions), and important performance measures
  
  Tracing Data in Message
  
  User information (such as user ID and HTTP session ID) and event related specifications.
- TRACE
  
  Low-level user-specific actions such as navigation, object open, button clicks, the payload of backend-calls, internal application events, and all calls to the backend.
  
  Tracing Data in Message
  
  Same as DEBUG.
Notes:
- Extensive logging can impact AWI's performance. In case of performance problems, check your log level and reduce the written messages by specifying a higher log level.
- It is recommended that you use DEBUG on testing and development instances only and INFO on production.
- In AAKE you have additional options to change the default log level. For more information, see Configuring Container-Based Systems.
Confirm that you want to change the log level.