Skip to main content

Monitor Windsurf and Windsurf Next resource usage and diagnose problems

Project description

Surfmon

surfmon header

ci release documentation pypi version Python 3.14+ coverage

Surface Monitor for Windsurf IDE — a performance monitoring and diagnostics tool for Windsurf (Stable and Next).

Table of Contents

Installation

pip install surfmon

Or with uv:

uv tool install surfmon

Or run directly without installing:

uvx surfmon check    # Using uvx
pipx run surfmon check    # Using pipx

For development:

git clone https://github.com/detailobsessed/surfmon.git
cd surfmon
uv sync

Quick Start

# One-shot health check
surfmon check

# Verbose output with all process details
surfmon check -v

# Save reports (auto-named with timestamp, enables verbose output)
surfmon check -s

# Target a specific Windsurf installation
surfmon check -t next

Basic Check

Why Use Surfmon?

  • 🔍 Debug Performance Issues — Identify memory leaks, CPU spikes, and resource bottlenecks
  • 📊 Monitor Over Time — Track resource usage trends with watch sessions and historical analysis
  • 🧹 Clean Up Resources — Remove orphaned processes and duplicate reports
  • 🔧 Troubleshoot Crashes — Detect extension host crashes, language server issues, and PTY leaks
  • 📈 Visualize Trends — Generate matplotlib plots showing resource usage over time

Commands

check — Quick Performance Snapshot

The main command. Shows system resources, Windsurf memory/CPU, active workspaces, top processes, and language servers in consistent fixed-width tables.

surfmon check                        # Basic check
surfmon check -v                     # Verbose (all processes)
surfmon check -s                     # Auto-save JSON + Markdown reports (enables verbose)
surfmon check --json report.json     # Save JSON to specific path
surfmon check --md report.md         # Save Markdown to specific path
surfmon check --json r.json --md r.md  # Save both formats with custom names

watch — Live Monitoring Dashboard

Continuously monitors Windsurf with a live-updating terminal dashboard. Saves periodic JSON snapshots for historical analysis.

surfmon watch                          # Default: 5s interval, save every 5min to ../reports/watch
surfmon watch -i 10 -s 600             # Check every 10s, save every 10min
surfmon watch -i 10 -n 720             # 720 checks = 2 hours
surfmon watch -o ~/windsurf-reports    # Custom output directory

Watch Dashboard

analyze — Historical Trend Analysis

Analyzes JSON reports from watch sessions (or any directory containing JSON reports) to detect memory leaks, process growth, and performance degradation. Optionally generates a 9-panel matplotlib visualization.

surfmon analyze reports/watch/20260204-134518/
surfmon analyze reports/watch/20260204-134518/ --plot
surfmon analyze reports/watch/20260204-134518/ --plot --output analysis.png

Terminal Output:

Analyze Report

Generated Matplotlib Visualization:

Analysis Plot

compare — Before/After Diff

surfmon check --json before.json
# ... make changes ...
surfmon check --json after.json
surfmon compare before.json after.json

Compare Reports

cleanup — Remove Orphaned Processes

Detects and kills orphaned chrome_crashpad_handler processes left behind after Windsurf exits. Windsurf must be closed for this command to work.

surfmon cleanup             # Interactive (asks for confirmation)
surfmon cleanup --force     # No confirmation

prune — Deduplicate Watch Reports

Removes duplicate/identical JSON reports that accumulate during watch sessions when nothing changes.

surfmon prune reports/watch/20260204-134518/ --dry-run
surfmon prune reports/watch/20260204-134518/

What It Monitors

System — Total/available memory, memory %, swap, CPU cores

Windsurf Processes — Process count, total memory & CPU, top 10 by memory, thread counts

Language Servers — Detects and tracks basedpyright, JDT.LS, Codeium language servers, YAML/JSON servers

MCP Servers — Lists enabled MCP servers from Codeium config

Workspaces — Active workspace paths and load times

PTY Usage — Windsurf PTY allocation vs system limits

Issues — Orphaned crash handlers, extension host crashes, update service timeouts (NextDNS), telemetry failures, logs directory in extensions folder

Auto-Detection

Surfmon auto-detects whether Windsurf Stable or Windsurf Next is running and targets the active installation. Override with -t stable or -t next, or set SURFMON_TARGET in your environment.

Exit Codes

  • 0 — No issues detected
  • 1 — Issues detected (see output)
  • 130 — Interrupted (Ctrl+C)

Common Issues

Issue Cause Fix
Orphaned crash handlers Crash reporters not cleaned up on exit surfmon cleanup --force
logs directory error Marimo extension creates logs in wrong place Move ~/.windsurf/extensions/logs
Update service timeouts NextDNS blocking *.codeium.com Whitelist in NextDNS
High memory usage Too many language servers or extensions Disable unused extensions

Development

Package Structure

src/surfmon/
    __init__.py        # Version
    cli.py             # Typer CLI — check, watch, compare, cleanup, prune, analyze
    config.py          # Target detection, paths, environment config
    monitor.py         # Core data collection — processes, language servers, MCP, PTYs
    output.py          # Rich terminal display and Markdown export
    compare.py         # Report comparison with colored diffs
tests/
    conftest.py        # Shared fixtures
    test_bugfixes.py   # Regression tests
    test_cli.py        # CLI command tests
    test_compare.py    # Report comparison tests
    test_config.py     # Configuration and target detection tests
    test_monitor.py    # Core monitoring logic tests
    test_output.py     # Display and formatting tests

Running Tests

poe test              # Run tests
poe test-cov          # Run with coverage
poe lint              # Ruff check
poe typecheck         # ty check

Dependencies

  • psutil — Cross-platform process and system monitoring
  • typer — CLI framework
  • rich — Terminal output with tables and colors
  • python-decouple — Environment configuration
  • matplotlib — Visualization for analyze plots

Requirements

  • Python 3.14+
  • macOS (tested), Linux (untested), Windows (untested) though it should work
  • Windsurf IDE installed

Creating Screenshots

Screenshots in this README were created using:

  • Static images (termshot) - Captures terminal output as PNG
  • Animated GIF (vhs) - Records terminal sessions as GIF

To recreate the watch GIF:

brew install vhs gifsicle

# Create tape file
cat > watch-demo.tape << 'EOF'
Output docs/screenshots/watch.gif
Set FontSize 13
Set Width 900
Set Height 400
Set Theme "Catppuccin Mocha"
Set BorderRadius 10
Set WindowBar Colorful
Set WindowBarSize 30
Type "uvx surfmon watch --interval 2 --max 15"
Enter
Sleep 32s
EOF

# Generate and optimize
vhs watch-demo.tape
gifsicle -O3 --colors 256 docs/screenshots/watch.gif -o docs/screenshots/watch.gif

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surfmon-0.3.4.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

surfmon-0.3.4-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file surfmon-0.3.4.tar.gz.

File metadata

  • Download URL: surfmon-0.3.4.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for surfmon-0.3.4.tar.gz
Algorithm Hash digest
SHA256 e0ee1c768ba2dc55a0eec03beb4cc65ca1e727b372699d81cbf6d6f9d8fc5a9b
MD5 346f8556bc0d2dc7c6f7e13d5af8a6fa
BLAKE2b-256 c864ac2aca06f51984c04877efd3035353dd80e91bca45d489bceee2a6ae7ce2

See more details on using hashes here.

File details

Details for the file surfmon-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: surfmon-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for surfmon-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 91b8c8889e16f187c6c3f4e5888067acfde12a09c6e6a9e6bf7e0e6d698d3962
MD5 a1259251d4947a0e557f5ff3605892d1
BLAKE2b-256 f465b8627b40aeab2c8ffd5c37b52c0499484dee2c9df793ff60dbbe36d8b194

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page