Back to Details

exa-debug-bundle

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Exa Debug Bundle

Exa调试包

Overview

概述

Collect all necessary diagnostic information for Exa support tickets.
收集Exa支持工单所需的全部诊断信息。

Prerequisites

前提条件

  • Exa SDK installed
  • Access to application logs
  • Permission to collect environment info
  • 已安装Exa SDK
  • 可访问应用日志
  • 具备收集环境信息的权限

Instructions

操作步骤

Step 1: Create Debug Bundle Script

步骤1：创建调试包脚本

bash
#!/bin/bash
bash
#!/bin/bash

exa-debug-bundle.sh

exa-debug-bundle.sh

BUNDLE_DIR="exa-debug-$(date +%Y%m%d-%H%M%S)" mkdir -p "$BUNDLE_DIR"
echo "=== Exa Debug Bundle ===" > "$BUNDLE_DIR/summary.txt" echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt"
undefined
BUNDLE_DIR="exa-debug-$(date +%Y%m%d-%H%M%S)" mkdir -p "$BUNDLE_DIR"
echo "=== Exa Debug Bundle ===" > "$BUNDLE_DIR/summary.txt" echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt"
undefined

Step 2: Collect Environment Info

步骤2：收集环境信息

bash
undefined
bash
undefined

Environment info

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 "EXA_API_KEY: ${EXA_API_KEY:+[SET]}" >> "$BUNDLE_DIR/summary.txt"
undefined
echo "--- Environment ---" >> "$BUNDLE_DIR/summary.txt" node --version >> "$BUNDLE_DIR/summary.txt" 2>&1 npm --version >> "$BUNDLE_DIR/summary.txt" 2>&1 echo "EXA_API_KEY: ${EXA_API_KEY:+[SET]}" >> "$BUNDLE_DIR/summary.txt"
undefined

Step 3: Gather SDK and Logs

步骤3：收集SDK与日志

bash
undefined
bash
undefined

SDK version

SDK version

npm list @exa/sdk 2>/dev/null >> "$BUNDLE_DIR/summary.txt"
npm list @exa/sdk 2>/dev/null >> "$BUNDLE_DIR/summary.txt"

Recent logs (redacted)

Recent logs (redacted)

grep -i "exa" ~/.npm/_logs/*.log 2>/dev/null | tail -50 >> "$BUNDLE_DIR/logs.txt"
grep -i "exa" ~/.npm/_logs/*.log 2>/dev/null | tail -50 >> "$BUNDLE_DIR/logs.txt"

Configuration (redacted - secrets masked)

Configuration (redacted - secrets masked)

echo "--- Config (redacted) ---" >> "$BUNDLE_DIR/summary.txt" cat .env 2>/dev/null | sed 's/=.*/=REDACTED/' >> "$BUNDLE_DIR/config-redacted.txt"
echo "--- Config (redacted) ---" >> "$BUNDLE_DIR/summary.txt" cat .env 2>/dev/null | sed 's/=.*/=REDACTED/' >> "$BUNDLE_DIR/config-redacted.txt"

Network connectivity test

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.exa.com/health >> "$BUNDLE_DIR/summary.txt" echo "" >> "$BUNDLE_DIR/summary.txt"
undefined
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.exa.com/health >> "$BUNDLE_DIR/summary.txt" echo "" >> "$BUNDLE_DIR/summary.txt"
undefined

Step 4: Package Bundle

步骤4：打包调试包

bash
tar -czf "$BUNDLE_DIR.tar.gz" "$BUNDLE_DIR"
echo "Bundle created: $BUNDLE_DIR.tar.gz"
bash
tar -czf "$BUNDLE_DIR.tar.gz" "$BUNDLE_DIR"
echo "Bundle created: $BUNDLE_DIR.tar.gz"

Output

输出结果

  • exa-debug-YYYYMMDD-HHMMSS.tar.gz
    archive containing: 
    • summary.txt
      - Environment and SDK info
    • logs.txt
      - Recent redacted logs
    • config-redacted.txt
      - Configuration (secrets removed)
  • exa-debug-YYYYMMDD-HHMMSS.tar.gz
    归档包包含： 
    • summary.txt
      - 环境与SDK信息
    • logs.txt
      - 近期已脱敏的日志
    • config-redacted.txt
      - 配置信息（已移除敏感内容）

Error Handling

错误处理

ItemPurposeIncluded
Environment versionsCompatibility check✓
SDK versionVersion-specific bugs✓
Error logs (redacted)Root cause analysis✓
Config (redacted)Configuration issues✓
Network testConnectivity issues✓
项用途是否包含
环境版本兼容性检查✓
SDK版本特定版本的bug排查✓
错误日志（已脱敏）根因分析✓
配置信息（已脱敏）配置问题排查✓
网络测试连接性问题排查✓

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
务必脱敏：
  • API密钥与令牌
  • 密码与机密信息
  • 个人身份信息（邮箱、姓名、ID等）
可安全包含：
  • 错误信息
  • 堆栈跟踪（已脱敏）
  • SDK/运行时版本

Submit to Support

提交至支持团队

  1. Create bundle: 
    bash exa-debug-bundle.sh
  2. Review for sensitive data
  3. Upload to Exa support portal
  1. 创建调试包：
    bash exa-debug-bundle.sh
  2. 检查是否包含敏感数据
  3. 上传至Exa支持门户

Resources

参考资源

Next Steps

后续步骤

For rate limit issues, see 
exa-rate-limits
.
若遇到速率限制问题，请查看
exa-rate-limits
。