Troubleshooting

Common Issues

Panel Not Showing

Symptom: No usage metrics panel appears on the site overview.

Causes & Solutions:

1. Site not connected to WP Engine
   • The panel only shows for WP Engine-connected sites
   • Solution: Connect your site via Local’s Connect feature
2. Addon not enabled
   • Solution: Go to Local > Add-ons > WPE Usage Metrics > Toggle ON
3. Local needs restart
   • Solution: Fully quit and restart Local

“Configure API credentials”

Symptom: Panel shows but asks you to configure credentials.

Solution:

1. Go to Local Preferences (Cmd+, on Mac, Ctrl+, on Windows)
2. Select WP Engine Usage Metrics from the sidebar
3. Get your API credentials from my.wpengine.com/api_access
4. Enter your API Username and API Password
5. Click Test Connection to verify
6. Click Apply to save

“API Access is not enabled for this account”

Symptom: Error message about API access.

Solution:

1. Go to my.wpengine.com/api_access
2. Generate API credentials if you haven’t already
3. Configure them in Local Preferences → WP Engine Usage Metrics
4. Click Refresh in the metrics panel

“Install not found on WP Engine”

Symptom: Error saying install not found.

Causes & Solutions:

1. Site disconnected from WP Engine
   • The site may have been deleted or disconnected
   • Solution: Reconnect the site
2. API access permissions
   • Your WP Engine user may not have access to this install
   • Solution: Contact your account admin

Metrics Show Zero

Symptom: All metrics display as 0 or 0 B.

Causes & Solutions:

1. No traffic in date range
   • New sites or low-traffic sites may show zeros
   • Solution: Try a longer date range (60 days)
2. Storage metrics delayed
   • Storage data updates less frequently
   • Solution: Wait 24 hours for new sites
3. API issue
   • Solution: Click Refresh, check console for errors

“Authentication expired” or “Invalid credentials”

Symptom: Error about authentication.

Solution:

1. Go to Local Preferences → WP Engine Usage Metrics
2. Verify your API credentials are correct
3. Click Test Connection to validate
4. If invalid, regenerate credentials at my.wpengine.com/api_access

Date Range Error

Symptom: Error about date range being too long.

Cause: WP Engine API has a 60-day maximum.

Solution: Select “Last 60 days” or shorter range.

Debugging

View Logs

1. Open Local
2. Go to Help > Toggle Developer Tools
3. Click Console tab
4. Filter by [WPE Usage]

Check API Response

In Developer Tools Console:

// Check if auth works
window.electron.ipcRenderer.invoke('wpe-usage-metrics:check-auth')
  .then(console.log);

Verify Site Connection

In Developer Tools Console:

// Check current site's host connections
// (Replace SITE_ID with actual site ID from URL)

Getting Help

If issues persist:

1. Check the GitHub Issues
2. Open a new issue with:
   • Local version
   • Operating system
   • Error messages from console
   • Steps to reproduce