Skip to main content
PureClarity’s logging system provides detailed insights into feed processing, server-side requests, and system behavior. The dedicated logging features help troubleshoot issues and monitor system performance.

​
Logging Features Overview

​
Dedicated Log File

All PureClarity activity is logged to a dedicated file located at: 
<magento-root>/var/log/pureclarity.log
Benefits of dedicated logging:
  • Isolated debugging - PureClarity logs separated from general Magento logs
  • Easier analysis - Focused content for troubleshooting
  • Better support - Clean log files for support requests
  • Performance monitoring - Track PureClarity-specific performance
The dedicated log file was introduced in version 6.1.0 and provides much cleaner debugging than mixed system logs.

​
Debug Logging Feature

When enabled, debug logging provides detailed information about:
  • Feed processing - Detailed feed generation and transmission logs
  • Server-side requests - Complete request/response cycles
  • Data collection - Information gathering and processing steps
  • API communications - Detailed PureClarity API interactions

​
Accessing the Logs Dashboard

  1. Go to PureClarity Dashboard in Magento admin
  2. Click the logs icon to access the logging interface
Logs icon in PureClarity dashboard

​
Logs Dashboard Overview

The logging dashboard provides three main management areas: Logs dashboard showing three management boxes

​
Debug Logging Configuration

​
Debug Logging Status

The status box shows current debug logging state and provides quick access to configuration. Debug logging status box showing current state Features:
  • Current status - Shows if debug logging is enabled or disabled
  • Quick configuration - Button takes you directly to settings
  • Status indicators - Clear visual indication of logging state

​
Enable/Disable Debug Logging

Click the configuration button to access debug logging settings: Debug logging configuration page in PureClarity settings Configuration steps:
  1. Navigate to configuration via logs dashboard button
  2. Set debug logging to Yes or No
  3. Save configuration
  4. Clear configuration cache if needed
Debug logging generates significantly more log data. Only enable when troubleshooting issues to avoid filling disk space with excessive logs.

​
When to Enable Debug Logging

Recommended scenarios:
  • Feed troubleshooting - When feeds fail or contain incorrect data
  • Server-side debugging - For complex server-side mode issues
  • Performance analysis - To understand processing bottlenecks
  • Support requests - When requested by PureClarity support
  • Development work - During custom implementation development
Not recommended for:
  • Production environments (except during active troubleshooting)
  • High-traffic periods - Can impact performance
  • Extended periods - Will generate large log files
  • Regular monitoring - Standard logs sufficient for normal operation

​
Log File Management

​
Download Logs

The download section shows current log file size and provides download functionality. Download logs box showing file size and download button Download features:
  • File size indicator - Shows current log file size
  • Direct download - Downloads complete PureClarity log file
  • Support ready - Downloaded files suitable for support requests
When to download logs:
  • Support requests - Attach logs to support tickets
  • Issue analysis - Review detailed error information
  • Archive purposes - Backup logs before deletion
  • Development debugging - Analyze custom implementation issues

​
Delete Logs

Log deletion provides clean slate for focused debugging. Delete logs box with delete button Deletion features:
  • Complete file removal - Deletes entire PureClarity log file
  • Fresh start - New log file created automatically with next log entry
  • Irreversible action - Cannot undo log deletion
Log deletion cannot be undone. Download important logs before deletion if you need to retain them for analysis or support purposes.
When to delete logs:
  • Before troubleshooting - Start with clean logs for specific issue
  • Large file sizes - When logs become unwieldy
  • Periodic maintenance - Regular cleanup to manage disk space
  • Privacy concerns - Remove sensitive data from logs

​
Log Analysis and Interpretation

​
Standard Log Entries

Normal operation logs include:
  • Feed start/completion - Feed processing lifecycle
  • Configuration changes - Settings updates and saves
  • Zone requests - Server-side zone processing
  • Authentication - API connection and validation

​
Debug Log Entries

Additional debug information includes:
  • Data collection details - Product/category gathering process
  • API request/response - Complete communication logs
  • Processing steps - Detailed operation breakdown
  • Performance metrics - Timing and resource usage

​
Error Log Entries

Error conditions logged:
  • Feed failures - Transmission or generation errors
  • Authentication issues - Credential or permission problems
  • Network problems - Connectivity or timeout issues
  • Data validation - Malformed or invalid data errors

​
Log Monitoring Best Practices

​
Regular Review Schedule

Recommended monitoring frequency:
  • Daily - During initial setup or troubleshooting
  • Weekly - For active production sites
  • Monthly - For stable, established installations
  • As needed - When issues arise or changes are made

​
Key Indicators to Monitor

Watch for these patterns:
  • Repeated errors - Indicating persistent issues
  • Performance degradation - Increasing processing times
  • Authentication failures - Credential or configuration problems
  • Feed size changes - Unusual data volumes

​
Proactive Maintenance

Regular maintenance tasks:
  • Archive important logs before deletion
  • Monitor file sizes to prevent disk space issues
  • Review error patterns for systemic problems
  • Update configuration based on log insights

​
Troubleshooting with Logs

​
Common Issue Patterns

Feed Processing Issues: 
[timestamp] Feed type 'product' started processing
[timestamp] Error: Authentication failed - invalid credentials
[timestamp] Feed processing halted
Server-Side Mode Issues: 
[timestamp] Server-side request for zone 'HP-01'
[timestamp] Product data collection started
[timestamp] Error: Database connection timeout
[timestamp] Fallback content served
Configuration Problems: 
[timestamp] Configuration save attempted
[timestamp] Error: Invalid region setting
[timestamp] Configuration validation failed

​
Debugging Workflow

  1. Enable debug logging for detailed information
  2. Reproduce the issue to generate relevant logs
  3. Download logs for analysis
  4. Identify error patterns in log entries
  5. Implement fixes based on log insights
  6. Verify resolution through subsequent logs
  7. Disable debug logging after issue resolution

​
Performance Considerations

​
Debug Logging Impact

Resource usage:
  • Increased disk I/O - More frequent write operations
  • Larger log files - Faster disk space consumption
  • Processing overhead - Slight performance impact
  • Memory usage - Additional logging operations

​
Optimization Strategies

Minimize performance impact:
  • Enable only when needed - Don’t leave debug logging on permanently
  • Monitor disk space - Ensure adequate storage for logs
  • Regular cleanup - Delete old logs to manage space
  • Scheduled maintenance - Plan log management activities

​
Security and Privacy

​
Log Content Considerations

Potentially sensitive information in logs:
  • API credentials - Access keys in authentication logs
  • Customer data - User information in feed processing
  • Product details - Catalog information in debug logs
  • System paths - Server configuration details

​
Security Best Practices

Protect log files:
  • Secure file permissions - Restrict access to log directories
  • Regular cleanup - Remove old logs containing sensitive data
  • Access control - Limit admin users who can download logs
  • Transport security - Use secure methods when sharing logs

​
Integration with Support

​
Preparing Logs for Support

When contacting support:
  1. Enable debug logging before reproducing issue
  2. Reproduce the specific problem
  3. Download fresh logs with issue details
  4. Include relevant timeframes in support request
  5. Disable debug logging after capturing issue

​
Log Information to Include

Helpful details for support:
  • Magento version and edition
  • PureClarity extension version
  • Issue reproduction steps
  • Specific timestamps of problems
  • Configuration changes made recently

​
Configuration Management

​
Troubleshooting Guides

​
Advanced Features

​
Summary

PureClarity’s logging system provides:
  • Dedicated log file for isolated debugging
  • Debug logging for detailed troubleshooting
  • Management dashboard for easy log administration
  • Download and deletion tools for maintenance
  • Support integration for issue resolution
Use logging strategically to maintain system health while avoiding performance impacts from excessive debug data collection.
⌘I