This section explains how to configure tracing in the BSF Server and NAF Authentication Filter.

Configuring BSF Server tracing

The BSF Server is a SLEE service which uses the standard SLEE tracing features. When setting tracer levels in rhino-console, you must specify the service and SBB IDs that you want to trace. The BSF’s service ID is:

name=sentinel-gaa-bsf,vendor=OpenCloud,version=3.0.0

Its SBB IDs are:

name=sentinel-gaa-bootstrap-sbb,vendor=OpenCloud,version=3.0.0
name=sentinel-gaa-zh-sbb,vendor=OpenCloud,version=3.0.0

Fortunately you do not need to enter the entire service or SBB IDs when setting tracer levels. The settracerlevel command in rhino-console supports tab-completion and can match simple patterns. For example, to enable "Finest" tracing for all SBBs in the BSF service in rhino-console, you could use:

settracerlevel sbb service=ServiceID[name=sentinel-gaa-bsf,*],sbb=* root Finest

Configuring NAF Authentication Filter logging

The NAF Authentication Filter uses Log4j for logging, which is included in the Sentinel VoLTE XCAP web application. To enable debug logging in the filter, you must edit the log4j2.properties file deployed with the web application. This is found in $TOMCAT_HOME/webapps/rem/WEB-INF/classes/log4j2.properties.

To enable the majority of debug logs from the filter, add these lines to log4j2.properties, and restart Tomcat:

logger.rem.name=rem.server.sentinel.gaa
logger.rem.level=DEBUG
logger.gaa.name=sentinel.gaa
logger.gaa.level=DEBUG
logger.naf.name=sentinel.gaa.naf.digest
logger.naf.level=INFO
Caution It is recommended that you do not normally enable DEBUG logging for sentinel.gaa.naf.digest, as the parameters logged during cryptography calculations could be used to compromise password security. These logs are not normally relevant except when debugging new development.

The available log keys in the NAF Authentication Filter are:

rem.server.sentinel.gaa
sentinel.gaa.naf.digest
sentinel.gaa.naf.filter
sentinel.gaa.zn.cassandra
sentinel.gaa.zn.session
sentinel.gaa.zn.stack
sentinel.gaa.cassandra

To enable debugging for a particular log key, use the following in log4j2.properties:

logger.<any log-key name>.name=<log-key>
logger.<any log-key name>.level=DEBUG

For example, to enable "DEBUG" tracing for the NAF filter:

logger.filter.name=sentinel.gaa.naf.filter
logger.filter.level=DEBUG
Previous page Next page