VS Code debugging

This document describes how to set up Rails debugging in VS Code.

Setup

  1. Install the debug gem by running gem install debug inside your gitlab folder.

  2. Add the following configuration to your .vscode/tasks.json file:

     {
   "version": "2.0.0",
   "tasks": [
       {
         "label": "start rdbg",
         "type": "shell",
         "command": "gdk stop rails-web && GITLAB_RAILS_RACK_TIMEOUT_ENABLE_LOGGING=false PUMA_SINGLE_MODE=true rdbg --open -c -- bin/rails s",
         "isBackground": true,
         "problemMatcher": {
           "owner": "rails",
           "pattern": {
             "regexp": "^.*$",
           },
           "background": {
             "activeOnStart": false,
             "beginsPattern": "^(ok: down:).*$",
             "endsPattern": "^(DEBUGGER: wait for debugger connection\\.\\.\\.)$"
           }
         }
       }
   ]
 }

  3. Add the following configuration to your .vscode/launch.json file:

     {
     // Use IntelliSense to learn about possible attributes.
     // Hover to view descriptions of existing attributes.
     // For more information, see https://go.microsoft.com/fwlink/?linkid=830387.
     "version": "0.2.0",
     "configurations": [
       {
         "type": "rdbg",
         "name": "Attach with rdbg",
         "request": "attach",
         "preLaunchTask": "start rdbg"
       }
     ]
 }

Debugging

Prerequisite:

  • You must have a running GDK instance.

To start debugging, do one of the following:

  • Press F5.
  • Run the Debug: Start Debugging command.