The Cleanup tab provides tools to manage your log files and prevent them from growing too large.

Automatic Log File Management

Importance of Log Cleanup

• Prevents log files from consuming excessive disk space
• Helps maintain a manageable number of log entries

Disk Space Considerations

• Large log files can impact server performance
• Especially important on shared hosting environments

Cleanup Safety and Backups

Original logs are preserved before cleanup (the option available for Pro users)

Cleanup Configuration

Setting Maximum Log Size (MB)

• Define the maximum allowed log file size
• Recommended: 10MB or less for optimal performance

Cleanup Methods

Truncate (Keep Last X%)

• Removes older entries while preserving recent logs
• Configurable percentage to retain (e.g., keep last 20%)

Empty File Completely

• Clears the entire log file
• Useful for starting fresh after resolving issues

Archive with Backup (Pro)

• Creates a backup before cleanup
• Archived logs can be restored if needed

Choosing the Right Method

• Truncate: Best for ongoing monitoring
• Empty File: Useful after resolving all issues
• Archive: Recommended before major site changes

Scheduled Cleanup

Available Cleanup Frequencies

• Every 6 hours: Aggressive cleanup for high-traffic sites
• Every 12 hours: Balanced approach for active sites
• Twice Daily: Standard cleanup schedule
• Once Daily: Suitable for most monitoring needs

Viewing Next Scheduled Cleanup Time

• Displayed in the cleanup summary section
• Helps plan for expected maintenance windows

WP-Cron Integration

• Uses WordPress built-in cron system
• No additional server cron jobs required

Manual Cleanup

Running Cleanup On Demand

• Click the “Run Now” button to initiate immediate cleanup
• Useful before troubleshooting or maintenance

Understanding Cleanup Results

• View statistics after cleanup completion
• See file size before and after
• Percentage of space freed
• Number of entries removed
• New file size

Cleanup Notifications

• Receive email alerts after cleanup tasks
• Includes summary of actions performed

For advanced features, see the Advanced Features guide.

The Alerts tab allows you to configure email notifications for critical errors.

Setting Up Email Alerts

Enabling/Disabling Notifications

• Toggle the main switch to enable or disable alerts
• Disabled by default for new installations

Configuring Notification Recipient (Free)

• Enter a single email address in the recipient field
• Supports standard email formats

Adding Multiple Recipients (Pro)

• Up to 3 recipients can be added in the Pro version
• Use a separate input field for each recipient; do not separate Emails by comma

Alert Frequency Options

Hourly Notifications

• Receives alerts every hour with accumulated errors
• Good for active development or high-traffic sites

Twice Daily Notifications

• Alerts sent at 12-hour intervals
• Balances frequency and email volume

Daily Notifications

• Single daily digest of all errors
• Suitable for routine monitoring

Weekly Notifications

• Summary sent once per week
• Ideal for long-term tracking without clutter

Understanding Cron Schedules

• Alerts are triggered by WordPress cron jobs. The notification may be delayed if the site has low traffic.
• Next scheduled time is displayed in the interface

Error Level Selection (Pro Feature)

Understanding Different Error Levels

• Database Errors: Issues with database queries
• Fatal Errors: Crashes that stop script execution
• Parse Errors: Syntax issues in PHP code

Default Monitoring Levels

• Database Errors
• Fatal Errors
• Parse Errors
• Deprecated function usage

Additional Selectable Levels (Pro)

• Warnings: Non-critical issues that may become problems
• Notices: Informational messages about potential issues
• Custom: User-defined error types

Reducing Notification Noise

• Select only the most critical error levels
• Use another notification interval

Testing & Management

Sending Test Emails

• Click the “Send Test Email” button to verify the setup immediately after enabling notifications

Verifying Email Delivery

• Check your inbox for the test email
• Ensure emails aren’t being marked as spam

Viewing Next Scheduled Notification Time

• Displayed in the alert summary section
• Helps plan for expected email arrivals

Example of incoming Email

For log file management, see the Cleanup Tab guide.

The Settings tab allows you to configure how the plugin behaves and displays information.

Log Update Mode Configuration

Manual Update Mode

• Logs update only when you refresh the page
• Lower resource usage, ideal for large log files

Auto Update Mode

• Logs update automatically every 10 seconds
• Provides real-time monitoring but uses more resources

Performance Considerations

• Auto mode is best for active debugging sessions
• Manual mode is suitable for routine checks or large logs

Datetime Display Options

Absolute Time Format

• Shows full date and time (e.g., “2026-05-15 14:30:22”). The output format depends on the website’s datetime setting in Settings -> General -> Date Format
• Useful for precise timestamp comparisons

Relative Time Format

• Displays time relative to now (e.g., “2 hours ago”)
• Easier to understand at a glance

Switching Between Formats

• Toggle between formats using the datetime format switcher
• Your preference is saved for future sessions

Timezone Settings

Setting Custom Timezone

1. Click the timezone selector dropdown
2. Search for your desired timezone

Using WordPress Default Timezone

• Automatically inherits WordPress site timezone
• Ensures consistency with other WordPress features

Why Timezone Matters

• Ensures log timestamps match your local time
• Helps correlate errors with specific events

Impact on Log Entry Timestamps

• Affects how timestamps are displayed in the log table
• Does not change the actual log file contents

For email notification setup, see the Alerts Tab guide.

This section provides in-depth technical information for advanced users.

Glossary of Terms

WP_DEBUG Constants Explained

WP_DEBUG

Master switch for debugging. When true, WordPress outputs errors, notices, and warnings.

WP_DEBUG_LOG

Logs errors to debug.log file. Essential for persistent error tracking. There is no sense in case WP_DEBUG is off.

WP_DEBUG_DISPLAY

Controls whether errors display on screen. Should be false in production environments. There is no sense in case WP_DEBUG is off.

SCRIPT_DEBUG

Forces WordPress to use development versions of core JS/CSS files. Useful for debugging JavaScript issues. There is no sense in case WP_DEBUG is off.

Cron Jobs in WordPress

WP-Cron runs scheduled tasks like alerts and cleanups. Triggered by site visits or real cron jobs. Can be manually executed via wp-cron.php.

Log Rotation Concepts

Process of archiving and removing old log entries. Helps maintain manageable log file sizes. Automated in the Pro version.

AJAX Polling

Technique used for live updates. In Auto mode, the plugin polls the log file every 10 seconds to check for any updates.

Stack Traces

Hierarchy of function calls leading to an error. Shows the path from initial request to failure point. Essential for pinpointing root causes.

Log Entry Types

• Notice: Non-critical issues (e.g., deprecated functions)
• Warning: Serious but non-fatal problems
• Fatal Error: Crashes script execution
• Database Error: Issues with database queries
• Parse Error: Syntax issues in PHP code

Custom Constants

• DBG_LV_USER_DEFINED_LOG_FILE_LIMIT: Override default 10MB limit.
  Exmaple: define('DBG_LV_USER_DEFINED_LOG_FILE_LIMIT', 20971520); // 20MB in bytes
  Open wp-config.php and add the line before the /* That's all, stop editing! */ comment.

For feature comparison, see the Free vs Pro Features guide.

This guide provides practical examples for different user types.

For Developers

Debugging Plugin Conflicts

Enable WP_DEBUG and WP_DEBUG_LOG to start capturing errors. Reproduce the conflict scenario and check logs for Fatal Errors or Database Errors.

Tracking Deprecation Warnings

Filter logs by “Deprecated” error type to identify outdated functions. Use SearchBuilder to find specific deprecated calls in your codebase.

Monitoring Database Query Errors

Filter by “Database Error” type to check for slow queries or connection issues. Optimize problematic database operations based on the error details.

Identifying Performance Bottlenecks

Look for repeated Warning entries and check stack traces for time-consuming functions. Use the datetime filter to correlate with slow page loads.

Using Stack Traces Effectively

Click on a log entry to expand the stack trace. Follow the call hierarchy from bottom (origin) to top (error). Identify which function or plugin triggered the issue.

For Site Administrators

Monitoring Site Health

Set up daily alerts for Fatal Errors and Database Errors. Review logs weekly for recurring issues. Use the relative time format to spot recent problems.

Identifying Problematic Plugins/Themes

Filter logs by file path to find plugin-specific errors. Check for errors originating from /wp-content/plugins/. Deactivate suspicious plugins and monitor for improvements.

Setting Up Preventive Maintenance Alerts

Configure alerts for Warning or Fatal-level errors. Set frequency to “Twice Daily” for active monitoring. Add your maintenance team’s email addresses.

Regular Log File Cleanup

Schedule automatic cleanup to run daily. Set maximum log size to 5MB for optimal performance. Keep the last 10% of logs for historical reference.

Security Monitoring

Filter logs by “Parse Error” to catch syntax issues. Monitor for unusual file access patterns. Set up alerts for errors in security-sensitive plugins.

For Agencies

Managing Multiple Client Sites

Use the same alert configuration across all client sites. Standardize error level monitoring (Fatal + Database Errors). Document each site’s typical error patterns.

Standardized Monitoring Setup

Create a checklist for new client onboarding:

• Enable debug logging
• Configure alerts with agency email
• Set cleanup schedule

Client Site Email Alerts Configuration

Add client contact emails as recipients (Pro). Set appropriate alert frequency based on site activity. Document alert configurations for each client.

Automated Log Maintenance Strategies

Implement cleanup schedules based on site traffic:

• High-traffic: Every 6 hours
• Medium-traffic: Twice daily
• Low-traffic: Daily

Reporting and Documentation

Export logs monthly for client reports (Pro). Use CSV exports to create error trend charts. Document recurring issues and resolutions.

For technical reference, see the Technical Reference guide.

This section covers advanced functionality for power users and developers.

Custom Log Path Support

The plugin automatically detects custom log file paths defined in your WordPress configuration. This supports non-standard locations for debug.log files, which is useful when you need to store logs outside the default WordPress directory structure.

Plugin Auto-Detection Methods

The plugin scans common WordPress directories and checks for alternative debug log locations. It uses multiple detection methods to locate your debug.log file, including:

• Standard WordPress root directory
• wp-content directory
• Custom paths defined in wp-config.php

Limitations with Custom Paths

Some features may be limited if the custom path is outside standard directories. Ensure that the custom path is writable by WordPress to avoid access issues.

Debug Constants Behavior with Custom Paths

WP_DEBUG_LOG must still be defined in wp-config.php, even when using custom paths. The plugin adapts to the specified path while maintaining all core functionality.

Export Features (Pro)

The Pro version provides CSV export capabilities with advanced filtering options. This allows you to download logs for external analysis.

Exporting Logs to CSV Format

Download logs as comma-separated values compatible with spreadsheet software. This format is ideal for:

• Importing into Excel or Google Sheets
• Creating visualizations and charts
• Sharing with team members

Date Range Filtering for Exports

Select specific time periods for export to focus on relevant data. This feature is particularly useful when:

• Investigating issues during specific time windows
• Generating reports for particular periods
• Analyzing trends over time

Custom Time Range Selection

Set start and end dates for export using the date picker interface. You can filter by:

• Specific hours within a day
• Full days or weeks
• Custom date ranges

Using Exported Data for Analysis

Import exported CSV files into your preferred analysis tools. This allows you to:

• Apply advanced filtering and sorting
• Create pivot tables for trend analysis
• Generate charts and graphs

CSV Structure and Columns

Exported files include all log table columns:

• Timestamp: When the error occurred
• Type: Error level (Notice, Warning, etc.)
• Description: Detailed error message
• File: Source file path
• Line: Line number in the file
• Stack Trace: Full call hierarchy

The log file Security

The plugin includes features to help you secure your debug log files.

Debug File Accessibility Warnings

The plugin detects if your log file is publicly accessible and alerts you to potential security risks. This helps prevent sensitive information from being exposed.

The plugin verifies whether debug.log can be accessed via browser. It checks direct URL access to the file

Security Best Practices

Follow these recommendations to secure your debug logs:

• Place debug.log outside the web root when possible
• Restrict file permissions to 640 or more restrictive
• Regularly clean up old logs

.htaccess Protection Recommendations

Add these rules to your .htaccess file:

<Files ~ "^debug\.log$">
  Order deny,allow
  Deny from all
</Files>

This prevents public access while maintaining plugin functionality.

This guide outlines the differences between the free and premium versions of Debug Log Viewer.

Free Features

Unlimited Log Viewing

The free version provides complete access to your debug log history without any limitations on the number of entries you can view. This allows for comprehensive monitoring and analysis of all errors generated by your WordPress site.

Real-Time Log Monitoring

You can monitor logs in real-time using the Auto mode, which polls the log file every 10 seconds. Alternatively, use Manual mode to refresh logs only when needed.

Basic Search and Filtering

The free version includes full-text search across all log entries, allowing you to quickly locate specific errors. You can also filter logs by error type such as Notice, Warning, Fatal Error, and more.

SearchBuilder Advanced Filtering

Create complex filter combinations using the SearchBuilder tool. This feature allows you to save and manage multiple filter sets for recurring analysis tasks.

Debug Constants Management

Easily toggle WordPress debug constants like WP_DEBUG, WP_DEBUG_LOG, SCRIPT_DEBUG, and WP_DEBUG_DISPLAY. The plugin provides security warnings when enabling WP_DEBUG_DISPLAY to prevent exposing sensitive information on production sites.

Single Email Recipient Alerts

Configure one email address to receive notifications about critical errors. Choose from multiple alert frequencies including Hourly, Twice Daily, Daily, or Weekly.

Stack Trace Viewing

Expand stack traces for each log entry to see the full call hierarchy leading to an error. This helps identify the root cause of issues.

Column Visibility Controls

Customize your log table view by showing or hiding columns based on your needs. This allows you to focus on the most relevant data for your analysis.

Pro Features

CSV Export with Date Ranges

The Pro version allows you to download logs as CSV files with the ability to filter exports by custom date ranges. This is useful for analyzing errors within specific time periods.

Custom Time Range Filtering

Select specific time periods for analysis and export data between any two dates. This feature is particularly helpful when investigating issues that occurred during specific time windows.

Advanced Email Alert Customization

Monitor additional error levels such as Warnings and Notices, which are not available in the free version. You can also configure alerts for custom error types specific to your needs.

Multiple Email Recipients

Add up to three email addresses for notifications, allowing you to distribute alerts across team members. This ensures that multiple stakeholders can stay informed about critical errors.

Automatic Log Cleanup

Schedule regular log file maintenance to prevent files from growing too large. Choose from multiple cleanup frequencies such as Every 6 hours, Every 12 hours, Twice Daily, or Once Daily.

Scheduled Cleanup with Multiple Frequencies

The Pro version offers more flexibility in scheduling cleanup tasks. You can align these schedules with your site’s maintenance windows to minimize impact on performance.

Priority Support

Pro users receive priority support with faster response times. This ensures that critical issues are addressed promptly, reducing downtime and improving site reliability.

Feature Comparison Table

Feature	Free Version	Pro Version
Log Viewing	✓ Unlimited	✓ Unlimited
Real-Time Updates	✓ Auto/Manual	✓ Auto/Manual
Basic Search & Filtering	✓	✓
SearchBuilder	✓	✓
Debug Constants Control	✓	✓
Email Alerts	1 Recipient	Up to 3
CSV Export		✓ Date Range
Custom Time Filtering		✓
Additional Error Levels	Database Errors Fatal Errors Parse Errors Deprecated	Database Errors Fatal Errors Parse Errors Deprecated Warnings Notices Custom
Automatic Cleanup		✓ Scheduled
Priority Support	Standard	✓ Priority

For more information about upgrading to the Pro version, visit our pricing page.

The Log View tab is the primary interface for monitoring and analyzing debug logs.

Viewing Debug Logs

Understanding the Log Table Structure

The log table displays entries with these columns:

• Timestamp: When the error occurred
• Type: Error level (Notice, Warning, Fatal Error, etc.)
• Datetime: Full date and time
• Description: Error message details with callstack (if presented)
• File: Source file path
• Line: Line number in the file

Table Interface Features

The interface includes pagination controls for large log files and row display options (10, 25, 50, or 100 entries per page). The responsive design adapts to different screen sizes.

Debug Constants Control

Toggling WP_DEBUG

• Enable or disable debug mode directly from the interface
• Changes are reflected in real-time

Managing Other Constants

• SCRIPT_DEBUG: Controls script version loading
• WP_DEBUG_LOG: Logs errors to debug.log file
• WP_DEBUG_DISPLAY: Shows errors on screen (use with caution)

Security Warning for WP_DEBUG_DISPLAY

On production sites, this should usually be disabled to prevent sensitive data exposure.

Search & Filtering

Basic Search Functionality

• Use the search bar to filter logs by keyword
• Searches across all columns simultaneously

Understanding Log Entry Types

Common error types include:

• Notice: Non-critical issues that do not stop script execution. Notices typically indicate minor problems such as undefined variables, deprecated behavior usage, or small inconsistencies in the code. While they do not break functionality, they may signal areas that should be cleaned up to ensure stability and future compatibility.
• Warning: More serious issues that still allow the script to continue running. Warnings often occur when a file cannot be included, an argument is invalid, or an operation fails but does not completely halt execution. These should be investigated, as they may lead to unstable behavior.
• Fatal Error: Critical errors that immediately stop script execution. Fatal errors occur when PHP encounters a problem it cannot recover from, such as calling an undefined function, exceeding memory limits, or failing to load a required class. These errors typically result in a white screen or a visible error message.
• Database Error: Errors related to database operations. These occur when a query fails, a table does not exist, credentials are incorrect, or the database server is unreachable. Database errors can break site functionality, especially when retrieving or saving content.
• Deprecated Error: ndicates that a function, method, parameter, or feature is outdated and should no longer be used. Deprecated elements still work but are scheduled for removal in future versions. These notices help developers update their code before compatibility breaks.
• Custom: Log entries intentionally created by developers or plugins for debugging or monitoring purposes. Custom logs are not native PHP error types but are manually written using logging functions. They help track specific events, variable values, API responses, or execution flow during development and troubleshooting.

Column Visibility Controls

Show or hide columns based on your needs:

• Toggle visibility using the column selector dropdown

Advanced Filtering – SearchBuilder

For complex filtering, use the SearchBuilder:

• Create multiple filter conditions
• Combine criteria using AND/OR logic

Real-Time Updates

Live Updates Mode

• Auto mode: Polls the log file every 10 seconds
• Manual mode: Updates only when refreshed by clicking to the button

Performance Considerations

• Auto mode provides real-time monitoring but uses more resources
• Manual mode is suitable for large log files or low-resource environments

Log Actions

Viewing Stack Traces

• Click on an entry to expand the stack trace
• See the full call hierarchy leading to the error

Copying Stack Traces

• One-click copy functionality for easy sharing
• Copies formatted text to clipboard

Reading Detailed Error Descriptions

• Full error messages with context
• File and line references for quick navigation

Log File Information

• View the current log file path
• Check file size with warnings for large files (>10MB)
• Verify file accessibility and security

For more advanced features, see the Settings Tab guide.

This guide explains the layout and navigation of the Debug Log Viewer interface.

The main dashboard provides a centralized view of your debug logs with the following elements:

• Header section: Plugin title, version info, and navigation controls
• Free vs Pro plan badges: Visual indicators for available features
• Upgrade indicators: Links to premium features when applicable

Tab Navigation

Log View (Primary Feature)

• Displays the debug log table with all entries
• Includes search, filter, and sorting controls

Settings Tab

• Configure update modes, datetime formats, and timezone settings
• Manage log file preferences

Alerts Tab

• Set up email notifications for critical errors
• Configure recipients and alert frequencies

Cleanup (Pro)

• Access to automatic log file management tools
• Scheduled cleanup configuration

Interface Elements

Container Layout

• Responsive design that adapts to screen size
• Clean, organized sections for easy navigation

Toast Notifications

• Brief pop-up messages for actions like updates or errors
• Auto-dismiss after a few seconds

Modal Dialogs

• Used for confirmation prompts (e.g., clearing logs)
• Overlay with focused content and action buttons

Navigation Tips

• Use the tab system to switch between features
• Hover over elements for tooltips and additional info
• Check the status bar for current log file details

For detailed feature usage, see the Core Features – Log View Tab guide.

This guide covers the installation methods and initial setup of the Debug Log Viewer plugin.

Installation Methods

Installing from WordPress Plugin Directory

1. Navigate to Plugins → Add New in your WordPress admin
2. Search for “Debug Log Viewer”
3. Click Install Now
4. After installation, click Activate Plugin

Manual Installation

1. Download the plugin zip file from WordPress.org or the official site
2. Upload via Plugins → Add New → Upload Plugin
3. Alternatively, upload the plugin folder to /wp-content/plugins/ via FTP or File Manager
4. Activate through Plugins → Installed Plugins

First-Time Setup

Plugin Activation Process

• After activation, you can go to the to the plugin dashboard
• A welcome screen appears with setup instructions

Initial Configuration

1. The plugin automatically detects your current debug settings
2. Recommended: Enable WP_DEBUG and WP_DEBUG_LOG if not already active
3. Configure your preferred update mode (Manual or Auto) in Settings tab

Understanding the Demo Log Entry

• The plugin may insert a demo entry to verify functionality
• This appears as a “Notice” type log with timestamp and description

Next Steps

After setup, proceed to the User Interface Guide for navigation instructions.