Statistics log is the same as the audit log, except the personal identifying user principal information 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.
To enable Statistics Log please edit the configuration file (logback.xml replacing log4j.properties since SSO 9.0)
Configuring via logback.xml file (SSO 9.x and newer)
The logback.xml file is located in ubilogin customization directory (ubilogin-sso/ubilogin/custom/logging/logback.xml) and contains the configuration of all SSO logging. Learn about Logback configuration file syntax.
To enable Statistics Log please add statistics=<level>
to the turboFilter
configuration, e.g. for level INFO
it should looks like:
<configuration> <turboFilter class="com.ubisecure.common.logging.MarkerBasedLogFilter"> <DefaultLevels>audit=info;tech=info;diag.*=info;statistics=info</DefaultLevels> </turboFilter> ... </configuration>
This way, all entries for the statistics
marker will automatically be added to the logs if any appender includes the marker, e.g. for the uas_statistics log file:
<configuration> ... <appender name="STATISTICS_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <filter class="ch.qos.logback.core.filter.EvaluatorFilter"> <evaluator class="ch.qos.logback.classic.boolex.OnMarkerEvaluator"> <marker>statistics</marker> </evaluator> <onMismatch>DENY</onMismatch> <onMatch>NEUTRAL</onMatch> </filter> <encoder> <pattern>${AUDIT_FILE_LOG_PATTERN}</pattern> </encoder> <!-- >file>${UAS_LOG_FILE}_statistics.log</file--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${UAS_LOG_FILE}_statistics.%d{yyyy-MM-dd}.log</fileNamePattern> ... </rollingPolicy> </appender> ... </configuration>
More examples of Logback configuration can be found in Diag log description section.
Configuring via log4j.properties file (SSO 8.x)
To enable Statistics Log please edit the following file with a text editor:
Windows:
C:\Program Files\Ubisecure\ubilogin-sso\ubilogin\webapps\ubilogin\WEB-INF\log4j.properties
Linux:
/usr/local/Ubisecure/ubilogin-sso/ubilogin/webapps/ubilogin/WEB-INF/log4j.properties
Add or uncomment the following line is present
log4j.logger.ubilogin.statistics = INFO, Statistics
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/webapps/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/webapps/config/tomcat/update.sh