Unimus writes log files to the following directories:
Linux: /var/log/unimus Windows: C:\ProgramData\Unimus\log |
Depending on the deployment type, you will find either the unimus.log file (for the Unimus Server) or the unimus-core.log file (for Remote Core deployments) in these directories.
In cases where Unimus fails to start correctly, or when there's an issue with the connection between the Server and a Core, checking the log file should be the first step in troubleshooting.
The Unimus log file contains detailed information about the following:
System events – Unimus Server and Core startup events, communication between the Unimus Server and Core, log level changes (e.g., enabling/disabling debug mode)
Database operations – Connections to the database, schema updates
Unimus system setting changes – Notification settings, schedules, user management, device credential updates, etc.
Tag and zone management – Creation, modification, and deletion of tags and zones
Job events – Device discovery, configuration backups, Mass Config Pushes, Network Scans, Config Searches
Device CLI accesses
Connections to NMS systems (NMS Sync)
Incoming API requests
For advanced troubleshooting, you can enable Debug Logging and/or Device Output Logging.
Navigate to the Zones menu.
Click the expander arrow on the right side of the Zone you want to debug.
Debug Logging
Device Output Logging
When Debug Logging is enabled, the Core (the device communication layer) outputs its properties to the log file, including SSH-related settings such as ciphers, key exchange (KEX) algorithms, compression, Diffie–Hellman groups, and public key types.
We recommend enabling Debug Logging when troubleshooting device discovery issues, as it provides detailed logs of device driver processing during discovery.
When Device Output Logging is enabled, a full record of CLI communication between Unimus and the network devices is stored in a separate log file. Each Zone has its own device output log file, located on the Core responsible for that Zone. These logs are especially useful for diagnosing issues with Mass Config Push presets.
Note: Device output logs may contain sensitive information (e.g., full command outputs or credentials in cleartext). We strongly recommend deleting these logs once debugging is complete.
In addition to enabling debug logging, you can further customize the level of detail in Unimus logs by using JVM options.
Specifically, for Mass Config Push jobs, you can log which commands are executed on which devices by setting the relevant JVM option. For detailed instructions, please refer to the following page: https://wiki.unimus.net/display/UNPUB/Detailed+logging+for+Config+Push+jobs.
Since these JVM options are processed at service startup, don't forget to restart Unimus for the new logging settings to take effect.
Unimus uses Logback, a Java-based logging framework, for built-in log rotation.
By default, logs are rotated when their size reaches 50 MB, and Unimus retains up to 9 archived log files.
You can customize these defaults in the unimus.properties configuration file:
On Linux: /etc/unimus/unimus.properties
On Windows: C:\ProgramData\Unimus\unimus.properties
Ensure that the configured values fall within the supported ranges listed below.
# Defines maximum log file size in MB (1–2047) logging.file.size = 50 # Defines how many rotated log files to keep (2–2147483647) logging.file.count = 9 |
Unimus can simultaneously log to both the local file system and a remote syslog server.
///TBD