Skip to end of metadata
  • Created by Former user, last modified on 2022-09-29
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Logback has been chosen as the logging framework because it supports all the functionality that had been implemented in the SSO proprietary logging system.

Logback configuration files have been organized in the following way:

  1. Each web application has in its class path a similar kind of logback.xml file which simply defines the context name for the application and includes the actual logger configuration

  2. The logger configuration shared by all web applications is named include-logback.xml and it contains all the definitions required by SSO logback configuration

There is normally no need for the customers to modify these configuration files but in the following examples we go through the interesting parts in them.

Main logback.xml files

The logback.xml files reside in these location for each web application in the default installation (<webapp> is the name of the web application like uas, logviewer, sso-api etc.):

  • Linux: /usr/local/ubisecure/ubilogin-sso/ubilogin/webapps/<webapp>/WEB-INF/classes from where it is copied to /usr/local/ubisecure/ubilogin-sso/tomcat/webapps/<webapp>/WEB-INF/classes during the installation process

  • Windows: C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\<webapp>\WEB-INF\classes from where it is copied to C:\Program Files\Ubisecure\ubilogin-sso\tomcat\webapps\<webapp>\WEB-INF\classes during the installation process

 The contents of the logback.xml file (uas web application, Windows installation)
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true" scan="false" scanPeriod="30 seconds">
	<property name="LOG_CONTEXT" scope="context" value="uas" />
	
  <include file="C:\Program Files\Ubisecure\ubilogin-sso\ubilogin/custom/logging/include-logback.xml"/>    
</configuration>

Notes:

  • The attribute debug="true" in the configuration element facilitates troubleshooting for logging configuration

    • When set to true, logback will print status information to the console as it processes the configuration

    • In Windows installations, see the note about Windows console log in the end of this page

    • All other web applications except uas has this setting as false in order not to repeat the status information many times

  • The attribute scan="false" in the configuration element disables scanning of changes in the logger configuration files (logback.xml and include-logback.xml)

    • If set to true, logback will reload the logger configuration if either of the files have been changed

    • Interval to scan for file changes is defined by scanPeriod

    • All web application has this setting as false by default

  • The LOG_CONTEXT property is individual for each web application, it is the same as the folder name of that application

Shared include-logback.xml file

….

Note about Windows console log

Links:

  • No labels

Ubisecure Privacy Policy & Cookie Statement