debug.gemでDocker上のRubyをデバッグしたい

やりたいこと

ruby/debug: Debugging functionality for Ruby

を使って、Dockerコンテナ上で起動したプログラムをデバッグする

参考

• [Ruby 3.1 の debug.gem を自慢したい - クックパッド開発者ブログ] (https://techlife.cookpad.com/entry/2021/12/27/202133)

方法

各環境で下のようなコマンドを実行する。
このとき、利用したいコンテナ側のポートを公開しておく。

# コンテナ側
$ rdbg -O --host=0.0.0.0 --port={任意のポート} main.rb
# ホスト側
$ rdbg -A localhost {任意のポート}

サンプル

準備

# 構成
$ tree app
app
└── main.rb

main.rb

a = 1
b = 2
puts a
puts b
c = a + b
puts c
c += 3
puts c

検証

コンテナ側

# コンテナを起動
$ docker run -it -p 1234:1234 -v $PWD/app:/app --rm ruby:3.0.3-bullseye /bin/bash
# コンテナ内
## debugをインストール
$ gem install debug
## debugの起動
$ cd /app
$ rdbg -O --host=0.0.0.0 --port=1234 main.rb
DEBUGGER: Debugger can attach via TCP/IP (0.0.0.0:1234)
DEBUGGER: wait for debugger connection...
DEBUGGER: Connected.
1
2
3
6
DEBUGGER: Disconnected.

ホスト側

$ rdbg -A localhost 1234
[1, 8] in main.rb
=>   1| a = 1
     2| b = 2
     3| puts a
     4| puts b
     5| c = a + b
     6| puts c
     7| c += 3
     8| puts c
=>#0    <main> at main.rb:1