Welcome to the Debug 360 plugin by Orcus Labs! This powerful tool enhances WordPress debugging by providing detailed error logging, notification options, and advanced features for troubleshooting your site. Whether you’re a site administrator or a developer, this guide will help you get started and make the most of Debug 360.
Table of Contents
Overview
Debug 360 is a WordPress plugin designed to streamline debugging by capturing, logging, and managing PHP errors on your site. It offers a user-friendly interface to view logs, configure error handling, and set up notifications. With premium features (via Freemius integration), it extends functionality with webhook support for real-time error reporting.
Key capabilities:
- View and manage error logs in table or log format.
- Enable a custom error handler to override PHP defaults.
- Send email notifications to administrators for critical errors.
- Integrate with external services via webhooks (premium feature).
Installation
- Download and Install:
- From the WordPress admin dashboard, go to Plugins > Add New.
- Search for “Debug 360” by Orcus Labs.
- Click Install Now, then Activate.
- Manual Installation:
- Download the plugin ZIP file from the official source (e.g., WordPress.org or Orcus Labs site).
- Upload it via Plugins > Add New > Upload Plugin.
- Activate the plugin after uploading.
- Premium Features (optional):
- After activation, opt into the premium version via the Freemius prompt to unlock advanced features like webhook integration.
Getting Started
Once activated, Debug 360 adds a menu item to your WordPress admin dashboard:
- Navigate to Debug 360 in the sidebar to access the plugin’s main interface.
- If multiple modules are installed, you’ll see a list of available options; otherwise, it defaults to the Debug Log Viewer.
Initial Setup
- Visit the Debug 360 menu.
- Configure initial settings (see Settings below) to enable features like the custom error handler or notifications.
- Start monitoring your site’s errors through the Debug Log Viewer.
Main Features
Debug Log Viewer
The Debug Log Viewer displays PHP errors logged by WordPress or captured by the custom error handler.
- Access: Under Debug 360 > Debug 360.
- Views:
- Table View: Shows errors in a sortable table with columns for timestamp, error level, and message. Use filters to narrow by error type (e.g., Fatal Error, Warning).
- Log View: Displays raw log entries with optional syntax highlighting.
- Actions:
- Filter errors by type using buttons above the table.
- Sort by timestamp or error level.
- Delete individual logs or bulk delete selected entries.
- Clear all logs with the Clear Debug Log button.
- Pagination: Navigate large log sets with page links or a slider.
Custom Error Handler
Debug 360 can replace PHP’s default error handling with a custom system.
- Enable: Toggle Enable Custom Error Handler in the settings sidebar.
- Behavior:
- Captures all PHP errors (warnings, notices, fatal errors).
- Logs them to a database table (
wp_Orcus_Labs_Debug_360_Debug_Log
). - Optionally disables PHP’s default error logging and display.
- Use Case: Ideal for capturing errors without cluttering
debug.log
or exposing them to users.
Email Notifications
Receive alerts when errors occur.
- Enable: Toggle Notify Admin via Email in the settings sidebar.
- Configure:
- Select an error level threshold (e.g., Fatal Error, Error, Warning, Notice) in the Error Level to Notify dropdown.
- Behavior:
- Sends an HTML email to the admin email address (
get_option('admin_email')
) with error details. - Limits emails to once per day per unique error to prevent spam.
- Sends an HTML email to the admin email address (
Advanced Settings (Premium)
Available with the premium version via Freemius.
- Access: Under Debug 360 > Advanced Settings.
- Webhooks:
- Create and manage webhooks to send error notifications to external services (e.g., Slack, Discord).
- Configure webhook URL, notification level, and active status.
- Test webhooks directly from the interface.
- Use Case: Real-time error monitoring for development teams or external logging systems.
Settings
The settings sidebar (on the Debug 360 admin page) lets you configure the plugin:
- Debugging Options:
- Enable Custom Error Handler: Activate the custom error handler.
- WP_DEBUG: Toggle WordPress debug mode.
- WP_DEBUG_LOG: Enable logging to
wp-content/debug.log
. - WP_DEBUG_DISPLAY: Show errors on-screen (not recommended for live sites).
- SCRIPT_DEBUG: Load unminified scripts/CSS.
- Notification Settings:
- Notify Admin via Email: Enable email alerts.
- Error Level to Notify: Set the minimum error severity for notifications.
- Save Settings: Click Save Settings to apply changes. This updates
wp-config.php
(with backups created automatically).
Note: Modifying wp-config.php
requires write permissions. Check file permissions if you see errors.
Troubleshooting
- No Errors Displayed:
- Ensure WP_DEBUG or the custom error handler is enabled.
- Check the database table (
wp_Orcus_Labs_Debug_360_Debug_Log
) for entries.
- Emails Not Sending:
- Verify your admin email (Settings > General) is valid.
- Check server mail configuration (e.g., via a plugin like WP Mail SMTP).
- Webhook Issues (Premium):
- Test the webhook URL manually to ensure it’s reachable.
- Review error responses in the Advanced Settings interface.
- Settings Not Saving:
- Confirm
wp-config.php
is writable by the web server. - Look for backup files (
wp-config-backup-*.php
) if updates fail.
- Confirm
Support
For assistance:
- Help Page: Click the Help button in the Debug 360 menu to visit our website.
- Contact: Reach out via support@orcuslabs.com or the WordPress plugin support forum.
- Documentation: Additional resources are available at orcuslabs.com/debug-360-docs.