DeepSurface maintains multiple types of logs for different purposes. This guide briefly discusses each type of log, their locations, and what common deployment options are available.
The base operating system relies on standard logging services (e.g. rsyslogd) and is configured in a way typical of modern Linux distributions. Most system logs can be found under the /var/log directory, which are largely maintained by the rsyslogd service.
When installing DeepSurface, detailed logging information is captured and stored in the /var/log/deepsurface-install.log file. This log is mostly useful if the deepsurface-install script failed unexpectedly. If this occurs, please provide this log file to the DeepSurface support team for further investigation.
The DeepSurface appliance is the main service of RiskAnalyzer and uses a log management system that is independent from the operating system log service. The current log file is located at /var/log/deepsurface-appliance/current. Several other files can be found in the same directory. Those whose names begin with the @ character are older versions of the current log file. These logs contain verbose logging information generated by the appliance service, but are rotated strictly by size, which means an extensive history may not be kept. Subsets of these logs are tracked separately in the database (as in the case of scan logs) or are sent to the operating system's syslog daemon (as in the case of security audit events).
When hosts or Windows domains are scanned by DeepSurface, the detailed logs generated by this event are captured in the database and made available in the Web UI. For more information, see the Scan Logs section of documentation.
A subset of appliance logs are also sent to the operating system's syslog daemon. This can be tuned by modifying the SYSLOG_LEVELS parameter in the /etc/kanchil/deepsurface.conf file, which contains a list of the different appliance logging levels that can be sent to syslog. By default, only the AUDIT level is reported. The available logging levels are:
CRITICAL: Major service failure eventsERROR: Major errors or unexpected conditionsWARNING: Error conditions that are recoverable, but may indicate a degradation of functionalityAUDIT: Security-relevant events, such as user logins or authentication configuration changesINFO: General informationDEBUG: Detailed information used by DeepSurface developers for performance tuning or defect detectionNote that DeepSurface reports these events to the to the syslog DAEMON facility stream.
After updating the /etc/kanchil/deepsurface.conf, the appliance service must be restarted for the changes to take effect. You can do this by running the command: sudo svc -k /etc/service/deepsurface-appliance
The DeepSurface host operating system uses the rsyslog service to maintain syslog events. This service can be configured to send messages to other systems through the standard syslog protocol as well as a TLS encrypted form of this protocol. For more information on how to do this, refer to the Rsyslog Documentation and TLS client configuration examples.
The DeepSurface updater service runs independently of the main appliance and is designed to perform software upgrades. This service triggers the updates of both operating system package upgrades and DeepSurface software upgrades. This service maintains a log (in the same format as the appliance service) under the /var/log/deepsurface-updater directory.
If you need to report a problem to the DeepSurface support team, it will often speed up the resolution process by providing your DeepSurface appliance logs and basic configuration information. To make this process easy, the web console has a feature that allows you to download a ZIP file of the main appliance logs and other supporting information. Simply click on your profile icon in the top right corner of the web console and select About. Then click the "Download Support Info" button at the bottom of the page. It may require several seconds for the file to be generated. If you do not see it appear, you may need to disable your browser's pop-up blocker. Once downloaded, simply transmit the downloaded ZIP file to the DeepSurface support team via secure email or make other arrangments.