Configuring Additional Logging
The log level is set to INFO for all services by default. If more information is needed in order to diagnose an issue, the log level may be updated to DEBUG or even TRACE. The instructions are the same as seen in the Reconfiguring xDeTECH Services guide.
At a high level:
- Stop the service(s) on the container.
- Edit the log file and application.properties/application.yaml.
- Restart the service(s).
- Check that the service(s) restarted successfully.
The service log files and config file locations are listed in the Container Directory Structure guide.
Updating the log levels for VCDx
VCDx has two levels of logs: service logs and snap-in logs which are generated by the native snap-ins that implement the algorithms and analyze the audio.
Update Service Log Level
The VCDx service logging is configured in the log4j2.xml file
The line to update is: <Logger name="com.daon" level="info" additivity="false">
Change "info" to "debug" or "trace".
Logging json Response
As of VCDx 1.1.0.2, the json response can be included in the log output when an API response is returned. To enable this feature (off by default), set the logging.log.json.response=true in application.properties or set the environment variable LOGGING_LOG_JSON_RESPONSE=true.
Updating the log level for VGSx
Update the application.properties line logging.level.com.daon.sentinel.vgs=INFO and change INFO to DEBUG or TRACE. Alternatively, set the environment variable LOGGING_LEVEL_COM_DAON_SENTINEL_VGS to the desired log level. The environment variable takes precedence over the property file.
Logging json Response
As of VGSx 1.1.0.1, the json response can be included in the log output when an API response is returned. To enable this feature (off by default), set the logging.log.json.response=true in application.properties or set the environment variable LOGGING_LOG_JSON_RESPONSE=true.
Updating the log level for VGSx Tester
The VGSx Tester requires two changes:
- Update the log4j2.xml line
<Logger name="com.daon" level="info" additivity="false">and change info to debug or trace. - Update the application.yaml section and update INFO to DEBUG or TRACE: