== Description ==
LogIQ is a powerful debug log viewer that makes WordPress debugging easier and more efficient. With its intuitive interface and smart features, you can quickly identify and resolve issues in your WordPress site.
= Key Features =
- Real-time Log Monitoring: View WordPress debug logs directly from your admin dashboard
- Complex Data Handling:
- Beautifully formats and displays complex data types like JSON and arrays
- Syntax highlighting for better readability
- Collapsible sections for nested data structures
- Perfect for debugging webhook payloads, API responses, and complex objects
- Smart Log Parsing:
- Automatically categorizes logs into different levels (Fatal, Error, Warning, Notice, Deprecated, Info, Debug)
- Intelligent detection of data types (JSON, Arrays, Objects)
- Context-aware formatting for different log sources
- Advanced Filtering:
- Filter logs by level, date, and content
- Search within specific log types
- Combine multiple filters for precise results
- Save and load filter presets
- Clickable File Links: Click on file paths in log entries to open them directly in your code editor
- Editor Integration:
- Supports Visual Studio Code
- Supports Sublime Text
- Supports PhpStorm
- Falls back to file:// protocol if no supported editor is found
- Clean Interface:
- Modern, responsive design with color-coded log levels
- Dark/Light mode support
- Customizable column layout
- Quick access toolbar
- Pagination: Navigate through large log files with ease
- Security: Built with WordPress security best practices
= System Information =
-
Status Dashboard:
- Real-time log file size monitoring
- Memory usage statistics
- PHP version and configuration
- WordPress environment details
- Server information
- Active plugins and themes
-
Settings Management:
- Configure log retention periods
- Set up automatic log rotation
- Customize display preferences
- Manage user permissions
- Configure editor preferences
- Set up email notifications
= Perfect For =
- WordPress Developers
- Theme Developers
- Plugin Developers
- System Administrators
- Technical Support Teams
- Quality Assurance Engineers
= Editor Integration =
LogIQ makes debugging easier by providing clickable file links in your log entries. When you click a file link:
- The file opens in your default code editor
- The cursor moves to the specific line mentioned in the log
- Supported editors (VS Code, Sublime Text, PhpStorm) open directly to the relevant line
- No configuration needed - works automatically with your installed editor
= Requirements =
- WordPress 5.8 or higher
- PHP 7.4 or higher
- WP_DEBUG and WP_DEBUG_LOG must be enabled in wp-config.php
== Installation ==
- Upload the
logiqfolder to the/wp-content/plugins/directory - Activate the plugin through the 'Plugins' menu in WordPress
- Go to Tools > LogIQ to start viewing your debug logs
== Usage ==
= Getting Started =
- Install & Activate LogIQ plugin From Wordpress org or Download and put the file inside your plugin directory then activate
- Go to WordPress admin dashboard
- Navigate to Tools > LogIQ -> Settings
- Enable Wordpress debug logging and Log to debug.log file and save
- You'll see your debug logs displayed in a clean, organized interface
= Using the Log Viewer =
-
Viewing Logs
- Logs are displayed in chronological order (newest first)
- Each log entry shows:
- Timestamp
- Log level (color-coded)
- Message content
- File path and line number (if available)
-
Filtering Logs
- Use the filter buttons at the top to show specific log levels:
- Fatal
- Error
- Warning
- Notice
- Deprecated
- Info
- Debug
- Click multiple filters to combine them
- Use the search box to find specific text in logs
- Use the filter buttons at the top to show specific log levels:
-
Navigating Logs
- Use pagination controls at the bottom to view older logs
- Click the refresh button to see new logs
- Use the "Jump to Top" button to return to the latest logs
= Working with File Links =
-
Opening Files in Editor
- Click any file path in a log entry
- The file will open in your default code editor
- The cursor will automatically move to the relevant line
-
Supported Editors
- Visual Studio Code (recommended)
- Sublime Text
- PhpStorm
- System default text editor (fallback)
-
Editor Detection
- LogIQ automatically detects your installed editors
- No configuration needed
- Works with the first supported editor found
= Advanced Features =
-
Complex Data Viewing
- JSON data is automatically formatted and syntax-highlighted
- Arrays are displayed in collapsible sections
- Click to expand/collapse complex data structures
-
Log Management
- Logs are automatically rotated to prevent large file sizes
- Old logs are archived for reference
- Clear logs option available in settings
-
Security Features
- Only users with appropriate permissions can view logs
- Sensitive data is automatically masked
- IP addresses and personal information are protected
= Tips & Best Practices =
-
For Developers
- Use appropriate log levels for different types of messages
- Include relevant context in log messages
- Use file paths and line numbers for easier debugging
-
For Administrators
- Regularly check logs for errors and warnings
- Set up appropriate user permissions
- Monitor log file size and rotation
-
Troubleshooting
- If logs aren't showing up, verify WP_DEBUG settings
- If editor links aren't working, check editor installation
- If performance is slow, consider increasing PHP memory limit
== Frequently Asked Questions ==
= Which code editors are supported? =
LogIQ supports Visual Studio Code, Sublime Text, and PhpStorm. If none of these are installed, it will fall back to your system's default text editor.
= Do I need to configure my editor? =
No configuration is needed. LogIQ automatically detects your installed editors and uses the appropriate protocol to open files.
= What if I don't have any supported editors installed? =
The plugin will fall back to using the file:// protocol, which will open the file in your system's default text editor.
= How does the editor integration work? =
When you click a file link in a log entry, LogIQ detects your installed editors and constructs the appropriate URL to open the file. For supported editors, it will open directly to the specific line number mentioned in the log.
= How does LogIQ handle complex data types? =
LogIQ automatically detects and formats complex data types like JSON and arrays. When these data types are logged, they are displayed with proper indentation, syntax highlighting, and collapsible sections for better readability. This makes it easier to debug and understand complex data structures in your logs.
== Screenshots ==
- Main log viewer interface with color-coded log levels
- Log filtering in action
- Complex log data
- Clickable file links in log entries
- Editor integration demonstration
- Settings
- System Information
== Changelog ==
= 1.0.0 =
- Initial release
- Real-time log viewing with automatic updates
- Smart log parsing and categorization
- Advanced filtering by log level
- Editor integration with clickable file links
- Support for VS Code, Sublime Text, and PhpStorm
- Security enhancements and responsive design
== Upgrade Notice ==
= 1.0.0 = Initial release with smart log viewer, complex log data reader, editor integration and clickable file links.
== Privacy Policy ==
LogIQ does not collect or store any personal data. All log data is stored locally on your server and is only accessible to users with appropriate permissions.
== Additional Information ==
For support, feature requests, or bug reports, please visit our GitHub repository or contact us through our support portal.
== Credits ==
Developed by AKM Elias
