-
Notifications
You must be signed in to change notification settings - Fork 39
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Currently, the Electron app uses console.log statements throughout the codebase for logging purposes. While this is suitable for development, it is not ideal for production environments, as logs are not persisted and can be difficult to access once the app is closed or crashes.
This ticket proposes replacing all instances of console.log, console.error, console.warn, and other similar console methods with a proper file-based logging system. This will improve maintainability, traceability, and debugging in production environments.
Acceptance Criteria:
- Replace all console.log, console.error, console.warn, etc., with a centralized logging utility.
- Implement a logging library such as winston, electron-log, or log4js, capable of writing logs to rotating log files.
- Configure different log levels (e.g., info, warn, error, debug).
- Logs should be written to a designated logs/ directory within the app’s data path (app.getPath('userData')).
- Ensure logging works in both the main and renderer processes (if needed).
- Optional: Retain console output in development mode for easier debugging.
- Document the logging usage in the project’s README or internal developer guide.
Benefits:
- Persistent log files for diagnostics and support.
- Cleaner separation between development and production behavior.
- Better error tracking and debugging, especially for non-technical users.
Related Work / Notes:
- Look into using electron-log as it’s built for Electron apps and supports both main and renderer processes.
- Ensure log files do not grow indefinitely - use log rotation or size limits.
- Be mindful of sensitive data - avoid logging user PII or security-sensitive information.
- Also look into the current logger.ts implementation and clean up if necessary
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed