Statistics log description - SSO

Statistics log is the same as the audit log, except the personally identifiable information (PII) is not shown.

This log is useful for statistical analysis or in for cases where access to personally identifiable information is tightly controlled.

Figure 1: Statistics Log – someone (unidentified) has logged out. Another user (unidentified) accessed Logviewer application.

Enabling Statistics Log

Statistics Log is disabled by default to maximize system performance.

If you have a SSO cluster installation you need to configure both nodes in the same way.


Enabling in logger configuration

In order to start creating Statistics log events, you need to edit the logger configuration file which resides in the following location in the default installation:

Windows:

C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\custom\logging\include-logback.xml

Linux: 

/usr/local/ubisecure/ubilogin-sso/ubilogin/custom/logging/include-logback.xml

To enable Statistics log please add statistics=info to the turboFilter <DefaultLevels> configuration:

  <!-- (1) Default levels for Diagnostic logs entry types -->
  <turboFilter class="com.ubisecure.common.logging.MarkerBasedLogFilter">
    <DefaultLevels>audit=info;tech=info;diag.*=info;statistics=info</DefaultLevels>
  </turboFilter>

Details about the logger configuration in Understanding SSO logger configuration.

If you don't want to change the default level in the logger configuration, you may also enable or disable Statistics log in the SSO Management UI Logging view by switching the level between OFF and INFO. Changing via UI affects to both nodes in the cluster.

Figure 2: SSO Management UI Logging view

Enabling in Log Viewer

Edit the following file with a text editor to enable the log in the Log Viewer:

Windows:

C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\logviewer\WEB-INF\ filesource.properties

Linux:

/usr/local/ubisecure/ubilogin-sso/ubilogin/logviewer/WEB-INF/filesource.properties

Add the following section, modifying XX to a unique sequential number

# UAS Statistics
logsource.FileSource.filetype.XX.name = UAS Statistics
logsource.FileSource.filetype.XX.type = statistics
logsource.FileSource.filetype.XX.path = C\:\\Program Files\\Ubisecure\\ubilogin-sso\\ubilogin/logs
logsource.FileSource.filetype.XX.filename = uas3_statistics.%YYYY-%MM-%DD.log

Redeploy and restart

To apply configuration changes please redeploy and restart the Ubisecure SSO by executing:

Windows:

C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\config\tomcat\update.cmd

Linux:

/usr/local/ubisecure/ubilogin-sso/ubilogin/config/tomcat/update.sh