instantly-debug-bundle

# Instantly Debug Bundle ## Overview Collect all necessary diagnostic information for Instantly support tickets. ## Prerequisites - Instantly SDK installed - Access to application logs - Permission to collect environment info ## Instructions ### Step 1: Create Debug Bundle Script ```bash #!/bin/bash # instantly-debug-bundle.sh BUNDLE_DIR="instantly-debug-$(date +%Y%m%d-%H%M%S)" mkdir -p "$BUNDLE_DIR" echo "=== Instantly Debug Bundle ===" > "$BUNDLE_DIR/summary.txt" echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt" ``` ### Step 2: Collect Environment Info ```bash # Environment info echo "--- Environment ---" >> "$BUNDLE_DIR/summary.txt" node --version >> "$BUNDLE_DIR/summary.txt" 2>&1 npm --version >> "$BUNDLE_DIR/summary.txt" 2>&1 echo "INSTANTLY_API_KEY: ${INSTANTLY_API_KEY:+[SET]}" >> "$BUNDLE_DIR/summary.txt" ``` ### Step 3: Gather SDK and Logs ```bash # SDK version npm list @instantly/sdk 2>/dev/null >> "$BUNDLE_DIR/summary.txt" # Recent logs (redacted) grep -i "instantly" ~/.npm/_logs/*.log 2>/dev/null | tail -50 >> "$BUNDLE_DIR/logs.txt" # Configuration (redacted - secrets masked) echo "--- Config (redacted) ---" >> "$BUNDLE_DIR/summary.txt" cat .env 2>/dev/null | sed 's/=.*/=***REDACTED***/' >> "$BUNDLE_DIR/config-redacted.txt" # Network connectivity test echo "--- Network Test ---" >> "$BUNDLE_DIR/summary.txt" echo -n "API Health: " >> "$BUNDLE_DIR/summary.txt" curl -s -o /dev/null -w "%{http_code}" https://api.instantly.com/health >> "$BUNDLE_DIR/summary.txt" echo "" >> "$BUNDLE_DIR/summary.txt" ``` ### Step 4: Package Bundle ```bash tar -czf "$BUNDLE_DIR.tar.gz" "$BUNDLE_DIR" echo "Bundle created: $BUNDLE_DIR.tar.gz" ``` ## Output - `instantly-debug-YYYYMMDD-HHMMSS.tar.gz` archive containing: - `summary.txt` - Environment and SDK info - `logs.txt` - Recent redacted logs - `config-redacted.txt` - Configuration (secrets removed) ## Error Handling | Item | Purpose | Included | |------|---------|----------| | Environment versions | Compatibility check | ✓ | | SDK version | Version-specific bugs | ✓ | | Error logs (redacted) | Root cause analysis | ✓ | | Config (redacted) | Configuration issues | ✓ | | Network test | Connectivity issues | ✓ | ## Examples ### Sensitive Data Handling **ALWAYS REDACT:** - API keys and tokens - Passwords and secrets - PII (emails, names, IDs) **Safe to Include:** - Error messages - Stack traces (redacted) - SDK/runtime versions ### Submit to Support 1. Create bundle: `bash instantly-debug-bundle.sh` 2. Review for sensitive data 3. Upload to Instantly support portal ## Resources - [Instantly Support](https://docs.instantly.com/support) - [Instantly Status](https://status.instantly.com) ## Next Steps For rate limit issues, see `instantly-rate-limits`.