docker環境でデバッグする方法を調べた
同期と所感
vscodeでデバッグできれば様々な言語、フレームワークでも同じようにデバッグ環境を構築できるのではと期待している。 そんなわけで今回はvscodeでdockerのデバッグ環境構築を調査し、やってみた。
デバッグ環境構築して感じのは、コンテナのリモートデバッグと言われるジャンルでも、特別なやり方をせず、ローカルのデバッグ方法の延長線上にあったことだった。（vscodeに拡張機能を１つ追加し、組み合わせてデバッグを実現していると感じた。） 段階を踏んで試みれば、この類のデバッグは難しい作業ではないと感じた。
採用したデバッグ方法
調べてみて分かったことは、コンテナ環境でデバッグする種類には大きく分けて２種類ある。細かく見れば4種類あることが分かった。 他の言語やフレームワークでも同じようにデバッグしたいと思うので、ソースコードをいじって言語特有のライブラリを仕込んでデバッグする方法は避けた。ライブラリを使わないで実現しようとするとvscodeの拡張機能を使う方法に絞られた。
1.拡張機能を利用しない方法（ptvsdの利用）
- https://dev.to/katsuya_9/remote-debug-django3-docker-with-vscode-3k9c
- https://testdriven.io/blog/django-debugging-vs-code/
- https://github.com/microsoft/ptvsd
- ptvsdは開発止まっている
2.拡張機能を利用しない方法（debugpyの利用）
- ptvsdの後継
- Debugging a Dockerized Django app with VSCode – London App Developer
- https://github.com/microsoft/debugpy
3.拡張機能を利用する方法(Remote Containersをの利用)
- https://qiita.com/thim/items/be2325deb65a30fac65e
- https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
- つべ：https://www.youtube.com/watch?v=t79HDLC5kQA コンポーズではなくdokcerファイルでやっているけどオススメ
- 拡張機能ダウンロード数:410万 ※ こちらの方法を採用した
4.拡張機能を利用する方法(Remote Developmentの利用)
- https://qiita.com/nokonoko_1203/items/33a05c86f359027afb33
- https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack
- 拡張機能ダウンロード数:150万
- 他の拡張機能をまとめてパッケージ化したもの？remote containersと使い方一緒？？
こんな事書いてあった。
This Remote Development extension pack includes three extensions:
- Remote - SSH
- Remote - Containers
- Remote - WSL
環境構築概要
.devcontainer/devcontainer.jsonを作成し、その後に再度remote-containersでコンテナ内部に入る。コンテナに入ったらローカルでデバッグ環境作るようにlaunch.jsonを作成し、デバッグを実行する。これだけだった。
コンテナ内に入ると拡張機能をインストールする作業があるがdevcontainer.jsonは設定ファイルで、毎回インストールする拡張機能を登録するとインストールしなくても済むようにできる。
最初のコンテナに入ることをRemote Containersは可能にしてくれてる。 Remote Containersはこのコンテナに入ることと,.devcontainerディレクトリ以下を作ってくれるのが役割だと今の所認識している。
手順
1 docker-composeで動くものを作っておく。serviceはdjangoのアプリだけではなくpostgresも合わせたdocker-compose.ymlで問題ない。
2 Remote Container拡張機能をインストールする
3 コマンドパレットを開き、でremote containers extensionを探す。選択肢として Add Development Container Configuration Filesがあるはずなのでそれを選択する。そしてFrom docker-compose.ymlを選択。そうするとdocker-compose.ymlに書かれているserviceの選択を迫られるのでdjangoアプリを選択する。
その結果.devcontainer以下が作られる。
4 次に緑部分を押すとメニューが表示されるのでRepen in Container を選択し、起動したコンテナ内に入る。
5 コンテナに入ればその後はいつもどおりローカルでデバッグする手順を踏めば良い。(launch.jsonがなければ作成してデバッグ)
注意点
コンテナで起動しているサービスにアクセスする場合はターミナルに書かれているようにhttp://127.0.0.1:8000/にアクセスすれば良いというわけではない、ポート番号はランダム？に設定されているのでcommand+クリックでブラウザを開くこと。今回のケースはポートは49114番だった。
