コンテナ化されたアプリのデバッグ

Container Tools 拡張機能は、コンテナ内で実行されているアプリケーションにデバッガーをアタッチするための launch.json 構成の足場（スキャフォールディング）を作成するなど、コンテナ内でのアプリケーションのデバッグを強力にサポートします。

Container Tools 拡張機能は、VS Code がどのようにアプリケーションを起動し、実行中のコンテナ内のアプリケーションにデバッガーをアタッチするかを管理する docker デバッグ構成プロバイダーを提供します。このプロバイダーは launch.json 内のエントリを介して構成され、構成内容はプロバイダーがサポートする各アプリケーションプラットフォーム固有のものとなります。

Container Tools 拡張機能は現在、コンテナ内での Node.js、Python、および .NET アプリケーションのデバッグをサポートしています。

要件

launch.json にデバッグ構成の足場を作成したり貼り付けたりするだけでは、コンテナをビルドおよびデバッグするために不十分です。コンテナの起動構成を正常に実行するには、以下が必要です。

• Dockerfile。
• tasks.json 内の docker-build および docker-run タスク。
• これらのタスクを呼び出すデバッグ構成。

これらのアセットがまだ存在しない場合は、Containers: Add Docker Files to Workspace... コマンドを使用してこれらの項目を作成することを推奨します。すでに機能する Dockerfile がある場合は、Containers: Initialize for container debugging コマンドを使用して、デバッグ構成とコンテナ関連タスクの足場を作成することを推奨します。

Node.js

コンテナ内での Node.js アプリケーションのデバッグに関する詳細情報は、コンテナ内での Node.js のデバッグを参照してください。

Node.js アプリケーションをデバッグするための launch.json 構成例

{
  "configurations": [
    {
      "name": "Containers: Node.js Launch",
      "type": "docker",
      "request": "launch",
      "preLaunchTask": "docker-run: debug",
      "platform": "node"
    }
  ]
}

Python

コンテナ内での Python アプリケーションのデバッグに関する詳細情報は、コンテナ内での Python のデバッグを参照してください。

Python アプリケーションをデバッグするための launch.json 構成例

{
  "configurations": [
    {
      "name": "Containers: Python - Django",
      "type": "docker",
      "request": "launch",
      "preLaunchTask": "docker-run: debug",
      "python": {
        "pathMappings": [
          {
            "localRoot": "${workspaceFolder}",
            "remoteRoot": "/app"
          }
        ],
        "projectType": "django"
      }
    }
  ]
}

.NET

コンテナ内でプロジェクトをビルドおよびデバッグする方法は、以下の2つから選択できます。

• .NET SDK を使用する場合: MSBuild に慣れている、または Dockerfile なしでプロジェクトをコンテナ化したい場合に推奨される選択肢です。

  注: このオプションは .NET SDK 7 以上でのみ使用可能で、dotnet publish コマンドを使用してイメージをビルドします。

• Dockerfile を使用する場合: Dockerfile を使ってプロジェクトをカスタマイズすることを好む場合は、このオプションを選択してください。

これら2つのオプションの詳細については、コンテナ内での .NET のデバッグを参照してください。

Dockerfile を使用して .NET アプリケーションをデバッグするための launch.json 構成例

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Containers: .NET Launch",
      "type": "docker",
      "request": "launch",
      "preLaunchTask": "Run Container",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

構成リファレンス

dockerServerReadyAction オブジェクトのプロパティ

node オブジェクトのプロパティ

これらのプロパティは、Node.js アプリケーションにデバッガーをアタッチするための VS Code ドキュメントで説明されているものと同じです。node オブジェクトで渡されたすべてのプロパティは、以下に明示的に記載されていない場合でも、Node.js デバッグアダプターに渡されます。

python オブジェクトのプロパティ

netCore オブジェクトのプロパティ

netCore オブジェクトで渡されたプロパティは、以下に明示的に記載されていない場合でも、通常は .NET デバッグアダプターに渡されます。デバッガープロパティの完全なリストは、OmniSharp VS Code 拡張機能のドキュメントに記載されています。

次のステップ

詳細については、以下をお読みください。

• コンテナ内での Node.js のデバッグ
• コンテナ内での Python のデバッグ
• コンテナ内での .NET のデバッグ
• Docker Compose を使用したデバッグ
• トラブルシューティング