Log Settings for Web UIs
Logging is the process of recording important events, errors, and operational details about your system. Proper logging helps with troubleshooting, auditing, and maintaining the security and reliability of your Syncplify Server! instance.
The Log Settings section in the Global Configuration page of the SuperAdmin UI controls logging specifically for the web management interfaces (SuperAdmin and Admin UIs). These settings do not affect logging for individual virtual sites, which have their own logging configurations in their respective Admin UIs.
Log Severity Levels
The Severity setting determines the minimum level of log messages that will be recorded. Log levels are hierarchical: selecting a level includes all more critical levels above it.
| Severity | Description | Typical Use Cases |
|---|---|---|
| ERROR | Indicates significant problems that prevent core functionality | System failures, critical exceptions, unexpected errors that disrupt service |
| WARNING | Signals potential issues that don't immediately stop system operation | Resource constraints, unexpected conditions, potential future problems |
| INFO | Records normal operational events and system state changes | Successful operations, system startup/shutdown, configuration changes |
| DEBUG | Provides detailed information useful for troubleshooting | Granular system behavior, method entry/exit points, detailed processing steps |
| TRACE | Most verbose logging level, capturing extremely detailed system interactions | Comprehensive system flow tracking, deep diagnostic information |
NOTE
When you select a severity level, all messages at that level and more critical levels will be logged. For example, choosing "INFO" will log INFO, WARNING, and ERROR messages.
Choosing the right severity level helps balance between capturing important system information and avoiding log file bloat. For production environments, INFO is typically recommended, while DEBUG and TRACE are more suitable for development and troubleshooting.
Log Destination
The "To" setting determines where logs are sent. It does not affect what is logged, only the destination.
Stdout Logging
When "To" is set to stdout, logs are directed to the console output. This is useful for containerized deployments or when running the server interactively.
- Color Output: Determines whether log entries are displayed in color in the console. This can enhance readability but may not be suitable for all environments.
File Logging
When "To" is set to file, logs are written to disk. This is the most common option for persistent logging.
- Encoding: Choose between JSON or W3C format. JSON is recommended for easier integration with Security Information and Event Management (SIEM) systems.
- Directory: Specify the folder where log files will be stored.
- Auto-rotate by file size: Set a maximum file size that triggers log rotation. Uses SI units (e.g., "100MB" or "2GB").
- Max files to keep: Limits the number of log files retained. Oldest files are automatically deleted when this limit is reached.
- Auto-delete logs older than: Specify a number of days after which log files are automatically deleted, regardless of the "max files to keep" setting.
- Automatically compress: When enabled, rotated log files are compressed using gzip to save disk space.
Proper log rotation and retention settings help prevent disk space issues.
Syslog Logging
When "To" is set to syslog, logs are sent to a syslog server, commonly used in enterprise environments for centralized logging and monitoring.
- Network: Choose between "udp" or "tcp" protocols for transmitting logs.
- Address: Specify the address and port of the syslog server (e.g., "10.10.5.23:514").
- Tag: A short identifier for the log source (e.g., "ss7").
- Marker: An additional identifier, often used to indicate the log format (e.g., "json").
IMPORTANT
Carefully consider your logging needs and infrastructure when configuring these settings. Incorrect configuration may impact system performance or lead to loss of important log data. If you're unsure about the optimal settings for your environment, consult with your IT security team or a logging specialist.