Description
Lumiblog Debug Log Inspector is a powerful quality assurance and debugging tool that monitors your WordPress debug.log file for plugin-specific errors. Unlike other debug tools, it allows you to monitor ANY WordPress plugin through an easy-to-use settings interface – no coding required!
Key Features
- Universal Plugin Monitoring: Add any WordPress plugin to monitor through a simple settings page
- No Code Editing: Add/edit/delete monitored plugins through the WordPress admin interface
- Real-time Monitoring: Automatically scans your debug.log file for errors
- Visual Status Indicators: Color-coded admin bar display (Green = OK, Red = Errors Found, Gray = Debug Logging Disabled)
- Auto-Detection: Option to only monitor plugins that are currently active
- Plugin-Specific Tracking: Individual status for each monitored plugin
- Last Error Display: Shows the most recent error message for quick diagnosis
- Duplicate Prevention: Smart validation prevents adding the same plugin twice
- Enable/Disable Plugins: Toggle monitoring for specific plugins without deleting them
- Lightweight: Minimal performance impact with efficient log reading
- Well-Organized Code: Modular file structure for easy maintenance and customization
Perfect For
- QA Teams testing multiple plugins
- Plugin Developers debugging their own plugins
- WordPress Developers monitoring client sites
- Agency Teams managing multiple WordPress installations
- Anyone who wants to keep track of plugin errors
How It Works
- Install and activate the plugin
- Go to Settings > Log Inspector
- Add any plugin you want to monitor by providing:
- Plugin Name (e.g., “WooCommerce”)
- Plugin File Path (e.g., “woocommerce/woocommerce.php”)
- Search Terms (e.g., “woocommerce, wc-“)
- Check the admin bar for real-time error status
Requirements
To use this plugin effectively, you need to enable WordPress debug logging by adding these constants to your wp-config.php file:
define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
Testing the Plugin
To verify Lumiblog Debug Log Inspector is working correctly, follow these steps:
Step 1: Enable Debug Logging
Add to your wp-config.php:
define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
Step 2: Add a Plugin to Monitor
- Go to Settings > Log Inspector
- Click “Add New Plugin to Monitor”
- Fill in the form with a plugin you have installed (e.g., WooCommerce)
- Plugin Name:
WooCommerce - Plugin File Path:
woocommerce/woocommerce.php - Search Terms:
woocommerce, wc-
- Plugin Name:
- Click “Add Plugin”
Step 3: Generate a Test Error
Option A – Using a Test Plugin File:
-
Create a simple test plugin in
wp-content/plugins/test-error/test-error.php:<?php
/**- Plugin Name: Test Error Generator
*/
if ( isset( $_GET[‘trigger_test_error’] ) ) {
trigger_error( ‘This is a test error from WooCommerce integration’, E_USER_WARNING );
}
- Plugin Name: Test Error Generator
-
Activate the test plugin
- Visit:
yoursite.com/wp-admin/?trigger_test_error=1 - Check your admin bar – it should turn RED
Option B – Trigger a Real Error:
-
Temporarily add this line to any active plugin’s main file:
trigger_error( ‘woocommerce test error for debugging’, E_USER_WARNING ); -
Reload any page in your WordPress admin
- Remove the line immediately after testing
Step 4: Check the Results
- Look at the admin bar – “LOG INSPECTOR” should now be RED
- Click on “LOG INSPECTOR” to see:
- WooCommerce: ERROR!
- Last Error: [Your test error message]
- Go to Settings > Log Inspector to manage monitored plugins
Step 5: View the Debug Log (Optional)
Navigate to wp-content/debug.log to see the actual error entries that were logged.
Clean Up:
- Remove the test code you added
- Either delete
wp-content/debug.logor clear its contents - The admin bar should return to GREEN
Additional Information
Debug Constants
For enhanced debugging, you can also add these optional constants to your wp-config.php:
define( 'SCRIPT_DEBUG', true );
define( 'SAVEQUERIES', true );
define( 'WP_DEBUG_DISPLAY', false ); // Set to false on production sites
For Developers
The plugin is designed to be easily extendable. All classes are well-documented and follow WordPress coding standards. Feel free to fork and customize for your specific needs.
Support
For support, feature requests, or bug reports, please visit the WordPress.org support forums for this plugin.
Contributing
Contributions are welcome! Please visit the plugin’s WordPress.org page for more information.
Installation
Automatic Installation
- Log in to your WordPress admin panel
- Navigate to Plugins > Add New
- Search for “Lumiblog Debug Log Inspector”
- Click “Install Now” and then “Activate”
Manual Installation
- Upload the
debug-log-inspectorfolder to the/wp-content/plugins/directory - Activate the plugin through the ‘Plugins’ menu in WordPress
- Go to Settings > Log Inspector to configure
After Installation
- Ensure WP_DEBUG_LOG is enabled in your
wp-config.phpfile - Navigate to Settings > Log Inspector
- Add plugins you want to monitor
- Look for “LOG INSPECTOR” in your WordPress admin bar
FAQ
-
How do I enable debug logging?
-
Add these lines to your
wp-config.phpfile (before the “That’s all, stop editing!” line):define( 'WP_DEBUG', true ); define( 'WP_DEBUG_LOG', true ); -
What do the colors in the admin bar mean?
-
- Green: All monitored plugins are error-free
- Red: At least one plugin has errors in the debug log
- Gray: Debug logging is not enabled
-
Can I monitor any WordPress plugin?
-
Yes! You can add any WordPress plugin to monitor. Just provide the plugin name, file path, and search terms through the settings page.
-
What are “Search Terms”?
-
Search terms are keywords that the plugin looks for in your debug.log file. For example, if you’re monitoring WooCommerce, you might use “woocommerce, wc-” as search terms. These should be unique identifiers that appear in error messages from that plugin.
-
How do I find the plugin file path?
-
The plugin file path is usually in the format:
folder-name/main-file.phpFor example:
– WooCommerce:woocommerce/woocommerce.php
– Contact Form 7:contact-form-7/wp-contact-form-7.php
– Yoast SEO:wordpress-seo/wp-seo.phpYou can find this in your WordPress admin under Plugins > Installed Plugins (it’s shown below each plugin name).
-
How much of the debug.log is scanned?
-
By default, the plugin scans the last 300KB of your debug.log file. You can customize this in Settings > Log Inspector > General Settings.
-
Will this slow down my site?
-
No. The plugin only runs in the WordPress admin area and uses efficient file reading techniques to minimize performance impact.
-
Can I temporarily disable monitoring for a plugin?
-
Yes! In the settings page, you can toggle any plugin on/off without deleting it from your list.
-
Does this work with Multisite?
-
Yes, the plugin works on WordPress Multisite installations.
-
Can I monitor custom/proprietary plugins?
-
Absolutely! As long as the plugin generates errors in the debug.log, you can monitor it.
-
How do I test if the plugin is working?
-
See the “Testing the Plugin” section below for detailed instructions on how to verify everything is working correctly.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“Lumiblog Debug Log Inspector” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “Lumiblog Debug Log Inspector” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- Initial release