Troubleshooting¶
Common Issues¶
1. "Error: Not authenticated with Terminus"¶
Problem: Commands fail because Terminus is not authenticated.
Solution:
Follow the prompts to authenticate with your Pantheon account.
2. "Failed to fetch sites from organization"¶
Problem: Unable to retrieve sites from the specified organization.
Possible Causes & Solutions:
Verify organization name:
Check permissions: - Ensure you have access to the organization in the Pantheon dashboard - Verify you're logged in with the correct account - Confirm your account has organization-level permissions
Re-authenticate:
3. "No sites found using upstream"¶
Problem: When using --upstream flag, no sites are found.
Possible Causes & Solutions:
Verify upstream ID:
Make sure you're using the complete UUID from the output.
Check for custom sites: - Some sites might not have an upstream (custom builds) - These sites won't appear when filtering by upstream
Try without filtering:
4. Commands not found after installation¶
Problem: After installing the add-on, commands are not available.
Solution:
If issue persists:
5. "Permission denied" errors¶
Problem: Script execution fails with permission errors.
Solution:
# Enter the DDEV container
ddev ssh
# Check script permissions
ls -la /usr/local/bin/
# If scripts aren't executable, reinstall
exit
ddev get kanopi/ddev-pantheon-toolkit
ddev restart
6. Slow performance with large organizations¶
Problem: Commands take a very long time to complete.
This is expected behavior for large organizations.
Optimization tips:
Use upstream filtering:
# Instead of processing all sites
ddev add-org \
--upstream abc-123 \
my-organization \
supporting-agency
Use verbose mode to monitor progress:
Run during off-hours: - API rate limits may affect performance during peak hours - Consider running large operations during off-peak times
Expected timings: - Small orgs (10-50 sites): 1-5 minutes - Medium orgs (50-100 sites): 5-15 minutes - Large orgs (100+ sites): 15+ minutes
7. CSV export file is empty or corrupted¶
Problem: Generated CSV files are empty or can't be opened.
Solutions:
Check file path:
Check file contents:
Verify write permissions:
Try explicit path:
8. "API rate limit exceeded"¶
Problem: Commands fail due to Pantheon API rate limits.
Solutions:
Wait and retry: - API rate limits reset after a period - Wait 5-10 minutes and try again
Process in smaller batches:
# Use upstream filtering to process fewer sites
ddev add-org --upstream abc-123 my-organization supporting-agency
Spread operations over time: - Don't run multiple heavy operations simultaneously - Schedule large operations with time between them
Logging and Debugging¶
Log File Locations¶
Commands create detailed log files for troubleshooting:
add-org logs:
site-inventory logs:
Viewing Log Files¶
# View entire log
cat pantheon_org_update_20240115_143022.log
# View last 50 lines
tail -50 pantheon_org_update_20240115_143022.log
# Search for errors
grep -i error pantheon_org_update_20240115_143022.log
# Search for specific site
grep "my-site" pantheon_org_update_20240115_143022.log
Enable Verbose Mode¶
For real-time debugging, use the --verbose flag:
This provides: - Real-time progress updates - Detailed API response information - Error messages with context - Timing information
Getting Help¶
Before Opening an Issue¶
- Check log files - Review the timestamped log file for your operation
- Try verbose mode - Run the command with
--verboseflag - Verify authentication - Re-authenticate with Terminus
- Check permissions - Verify access in Pantheon dashboard
- Review CSV exports - Look for patterns in the output
Opening an Issue¶
When reporting issues, include:
- Command used - Exact command with flags (redact sensitive info)
- Error message - Complete error output
- Log file excerpt - Relevant portions of the log file
- Environment details:
- DDEV version:
ddev version - Terminus version:
ddev exec terminus --version - Organization size (approximate number of sites)
- Expected vs actual behavior
GitHub Issues: https://github.com/kanopi/ddev-pantheon-toolkit/issues
Additional Resources¶
- DDEV Documentation: https://ddev.readthedocs.io
- Terminus Documentation: https://docs.pantheon.io/terminus
- Pantheon API Documentation: https://docs.pantheon.io/api
- Pantheon Support: https://docs.pantheon.io