CodeRabbit Debug Bundle

Overview

Collect all necessary diagnostic information for CodeRabbit support tickets.

Prerequisites

• CodeRabbit SDK installed

• Access to application logs

• Permission to collect environment info

Instructions

Step 1: Create Debug Bundle Script

#!/bin/bash

coderabbit-debug-bundle.sh

BUNDLE_DIR="coderabbit-debug-$(date +%Y%m%d-%H%M%S)" mkdir -p "$BUNDLE_DIR"

echo "=== CodeRabbit Debug Bundle ===" > "$BUNDLE_DIR/summary.txt" echo "Generated: $(date)" >> "$BUNDLE_DIR/summary.txt"

Step 2: Collect Environment Info

set -euo pipefail

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 "CODERABBIT_API_KEY: ${CODERABBIT_API_KEY:+[SET]}" >> "$BUNDLE_DIR/summary.txt"

Step 3: Gather SDK and Logs

set -euo pipefail

SDK version

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

Recent logs (redacted)

grep -i "coderabbit" ~/.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.coderabbit.com/health >> "$BUNDLE_DIR/summary.txt" echo "" >> "$BUNDLE_DIR/summary.txt"

Step 4: Package Bundle

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

Output

• coderabbit-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

• Create bundle: bash coderabbit-debug-bundle.sh

• Review for sensitive data

• Upload to CodeRabbit support portal

Resources

• CodeRabbit Support

• CodeRabbit Status

Next Steps

For rate limit issues, see coderabbit-rate-limits .