Error Logs
The Error Logs module enables users to monitor platform-wide errors, investigate incidents, and export logs for offline analysis. It includes tabular summaries, image-based insights, note management, and exporting capabilities.
Sections Overview
This page is divided into two main areas:
- Error Logs Table – displays all recorded errors in a structured view.
- Details and Export Options – provides in-depth insight and export features for each entry.
Error Logs Table
A structured table listing all captured error events. The columns include:
- Notification ID: Unique identifier for the error.
- User: Email or username linked to the error.
- Location: Platform section or URL where the error occurred.
- Details: Summary of the issue encountered.
- API: API endpoint or internal service involved.
- Images: Button to preview screenshots or visual evidence.
- Note: Field to add or review investigation notes.
- Create Time: Timestamp when the error occurred.
- Report Time: When the error was reported into the system.
- Export: Option to download the individual error record.
Error Details & Visualization
Clicking a row in the table allows further inspection of the error via:
- Image Previews: View associated screenshots or snapshots of the failure context.
- Notes Section: Add or update internal notes for follow-up or resolution logs.
- API Info: See backend endpoint and service that failed.
- System Logs: Review technical messages if available.
Visualizing Errors
The image preview feature allows users to see graphical representations or screenshots related to the error for easier identification and troubleshooting.
Exporting Error Logs
Users can export logs in various formats for external review or documentation.
Popup Notification
A popup notification system is available for immediate user feedback when errors occur or actions are performed (e.g., exporting logs).
Example: A test popup displaying a message with an "OK" button for user acknowledgment.
Usage Notes
- Ensure to check the timestamps to correlate errors with system activities.
- Utilize the export feature to maintain records or conduct deeper offline analysis.
- Use image previews and notes for contextual understanding and troubleshooting.
Best Practices
- Regularly monitor the Error Logs page for any recurring issues.
- Use the notes feature to document solutions or ongoing investigations for future reference.
- Export logs periodically for backup and compliance purposes.