Versions Compared

Old Version 13

changes.mady.by.user Former user

Saved on

compared with

New Version 14

changes.mady.by.user John Jellema

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 the defined context name for the application and in a logback.xml file. This file also includes the actual logger configuration for the application.

  2. The logger configuration shared Common logger configurations, used by all web applications is named found in the include-logback.xml and it file. This file contains all the definitions required by SSO logback configuration

...

  1. .

Main logback.xml files

The logback.xml files reside in these locations the default installation 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

There is no need to customise these filesfor the customers to modify either of these configuration files, but below are examples with explanations.

Expand
titleThe contents of the logback.xml file with explanations

SSO authentication server (uas)

Linux installation /usr/local/ubisecure/ubilogin-sso/ubilogin/webapps/uas/WEB-INF/classes/logback.xml:

Code Block
<?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="/usr/local/ubisecure/ubilogin-sso/ubilogin/custom/logging/include-logback.xml"/>    
</configuration>

Windows installation C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\uas\WEB-INF\classes\logback.xml:

Code Block
<?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 the 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 Troubleshooting the log configuration at 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 changedInterval logging configurations found in both files

    • The interval to scan for any file changes is defined by the scanPeriod setting

    • All web application has this setting as applications have this set to false by default

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

...

The include-logback.xml file reside resides in this the following location in the default installation and it is meant for some customisation:. This file in intended to permit customisation: JOHN edited to here

  • Linux: /usr/local/ubisecure/ubilogin-sso/ubilogin/custom/logging

  • Windows: C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\custom\logging

...