The Debug Logging module enables administrators and support teams to capture detailed logs for troubleshooting and resolving system issues in the Shift Left API platform. Comprehensive logging helps diagnose errors, monitor system behavior, and maintain operational transparency.
Key Features : #
- Verbose Logging: Capture detailed system events and debug information for troubleshooting purposes.
- Reset to Defaults / Save Settings: Easily revert to default configurations or save custom logging settings.
Log Level Configuration : #
Select the level of detail captured in logs:
| Log Level | Description |
| Info | Logs errors, warnings, and informational messages. |
| Warning | Logs warnings and errors only. |
| Error | Logs errors only. |
| Debug | Logs detailed debug information, including system states and variable values. |
Note: Higher log levels include all messages from lower levels.
Output Configuration : #
Determine where logs are recorded:
- Log to file: Persist logs on disk for historical review
- Log to console: Output logs in real-time to console for live monitoring
- Log to database: Store logs in the system database for analysis and reporting
File Logging Configuration : #
Manage file-based logs with the following settings:
- Max File Size (MB): 10 MB per file
- Max Number of Files: 5
Older files are rotated automatically to maintain system performance.
Context Configuration : #
Enhance log entries with additional context for better debugging:
- Include timestamp in log entries – Tracks when events occurred
- Include user context in log entries – Identifies the user responsible for actions
Sensitive Data Protection : #
Sensitive information is automatically redacted to maintain security and compliance:
- Sensitive Field Patterns: password, apiKey, token, secret
- Any log entries containing these fields are masked or redacted to prevent exposure of confidential data
Security Notice: Ensures sensitive information is never exposed in logs while maintaining traceability for debugging.
Use Cases : #
- Debug failing API test executions
- Trace system errors and warnings
- Monitor real-time system performance
- Investigate user-reported issues with detailed context
- Comply with security and audit policies
Best Practices : #
- Enable debug logging only when needed to avoid performance impact
- Regularly archive and rotate logs to prevent disk overflow
- Combine with Audit Logs for comprehensive troubleshooting
- Review sensitive data patterns periodically to ensure protection
