xSpeed Cache
Get Plugin
Features Pricing Reviews FAQ
Documentation Blog Support Community Free vs Pro Compare
Get Plugin

Debug Mode and Logs

4 min read

xSpeed Cache keeps logging simple. It writes diagnostic messages to WordPress’s standard debug log, keeps a short in-dashboard activity log of recent cache events, and can produce a support snapshot you paste into a ticket. This page explains each one.

What this does

There are three separate things to know about:

  • Debug log — technical messages xSpeed Cache writes to your WordPress debug log, only when WP_DEBUG is on.
  • Activity log — a short, recent history of cache events shown in the dashboard.
  • Support snapshot — a one-time system-info dump for support tickets.

They serve different purposes. The debug log is for developers chasing a specific problem. The activity log is for seeing what xSpeed Cache has been doing. The snapshot is for sharing your environment with support.

Debug log

xSpeed Cache writes its diagnostic messages using WordPress’s standard WP_DEBUG mechanism. It does not have its own log file or its own debug setting.

When WP_DEBUG is enabled, xSpeed Cache messages are written through PHP’s error log, each prefixed with [xspeed] so you can find them. When WP_DEBUG is off, xSpeed Cache writes nothing.

How to turn it on

Edit your wp-config.php and add (or change) these lines:

define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );

With WP_DEBUG_LOG on, WordPress writes the log to wp-content/debug.log. Look there for lines that start with [xspeed].

Warning: Do not leave WP_DEBUG on for a live site longer than you need to. It can expose technical details and grow the log file. Turn it off once you have what you need.

What gets logged

xSpeed Cache only logs when something is worth a developer’s attention, and only with WP_DEBUG on. Examples include module load issues, REST callbacks that threw an error, and object-cache degraded-state warnings.

Note: xSpeed Cache is WP_DEBUG aware. There is no separate “debug mode” toggle inside the plugin to switch on.

Activity log

The activity log is a short, running history of cache lifecycle events, such as a cache purge, the cache being enabled, or a conflicting plugin being detected.

You do not need to enable it. xSpeed Cache records these events on its own, and the Health module’s dashboard panel shows them. Each entry has a time, a message, and a severity of info, success, warning, or error.

The log is intentionally small. It keeps the 50 most recent events, newest first, and entries are held for up to 30 days. Older or overflowing events drop off automatically, so it never grows without bound.

Tip: You can also see recent activity from the command line with wp xspeed health, which prints diagnostic checks, cache stats, and recent activity together.

Support snapshot

The support snapshot is a read-only summary of your environment that you can paste into a support ticket. It has no settings and changes nothing on your site; it only reads and reports.

What it includes

  • xSpeed Cache version and xSpeed Cache Pro version
  • xSpeed Cache API version
  • WordPress version
  • PHP version and MySQL version
  • Server software
  • Memory limit
  • Whether the site is multisite
  • Your home URL
  • The list of active xSpeed Cache modules
  • Whether an external object cache is in use
  • Your license key, masked so only the first four and last four characters are shown

Note: The license key is always masked in the snapshot. The full key is never written into it, so it is safe to paste into a ticket.

How to get it

You can copy the snapshot from the support panel in the dashboard, or print it from the command line:

wp xspeed support

The snapshot is formatted as a Markdown block, so it pastes cleanly into most support systems.

Troubleshooting

I turned on WP_DEBUG but see no [xspeed] lines. xSpeed Cache only logs when there is something to report. A quiet log usually means nothing went wrong. Confirm WP_DEBUG_LOG is also true and check wp-content/debug.log.

The activity log is empty. The log clears entries after 30 days and only holds the 50 most recent events. On a quiet site, or right after the log was cleared, it can be empty. Trigger a cache action and check again.

Support asked for my environment. Run wp xspeed support or use the Copy button on the support panel, then paste the result into your ticket. Your license key is already masked.

  • WP-CLI Commands
  • Server Compatibility
  • Common Problems and Troubleshooting
  • Object Cache