dbg: debug applications remotely🔗ℹ

This package provides a server, client and UI for remotely debugging Racket applications.

1 Usage🔗ℹ

Call serve before starting your app and use the returned function to stop the server when your app shuts down.

(require (prefix-in dbg: debugging/server))

(define dbg:stop (dbg:serve))

Then use the UI to interact with the server (raco dbg from the dbg-ui package). If you’re feeling particularly adventurous, you can use the programmatic API (Client) instead.

1.1 Port Forwarding🔗ℹ

The server listens on the loopback interface by default, so it’s not exposed to the internet. While you can tell it to listen on a different interface, that would likely be insecure. Instead, when you need to debug a remote server, you should use port forwarding. Here’s how you would forward port 9011 using the ssh command:

2 Reference🔗ℹ

The dbg package provides two top-level modules, representing the Server and Client APIs.

2.1 Server🔗ℹ

The server replaces the current-custodian in order to aid with profiling, so the earlier you start the server during your app’s boot process, the better.

2.2 Client🔗ℹ

The client API may change between versions without warning.

The errortrace? argument controls whether or not errortrace is used to construct call stacks. If errortrace was not enabled before starting the process, setting this value to #t will produce empty profiles.