Debugger an einen Kubernetes-Pod anhängen

Die Cloud Code-Erweiterung für VS unterstützt das Anhängen eines Debuggers an einen Kubernetes-Pod. Sie benötigen lediglich einen debugfähigen Container und eine Anhang-Konfiguration vom Typ cloudcode.kubernetes.

Einen Container einrichten

Sie müssen sicherstellen, dass der Container, für den Sie Fehler beheben möchten, Debug-fähig ist. Im Folgenden finden Sie die sprachspezifischen Anweisungen zum Einrichten von Containern.

Node.js

  • Starten Sie die Node.js-Anwendung mit --inspect=<debugPort>, wobei debugPort aus der Anhang-Konfiguration stammt. Beispiel: CMD ["node", "--inspect=9229", "index.js"]

Python

  • Stellen Sie sicher, dass das Modul ptvsd auf Ihrem Computer und in Ihrem Container installiert ist.
  • Starten Sie die Python-Anwendung über ptvsd. Ordnen Sie den angegebenen Port dem Feld debugPort in der Anhang-Konfiguration zu. Beispiel: 
    CMD ["python", "-m", "ptvsd", "--port", "", "app.py"]

Go

  • Achten Sie darauf, dass das Paket dlv auf Ihrem Computer und in Ihrem Go-Container installiert ist.

  • Starten Sie Ihre Go-Anwendung über dlv debug.

    Der im Startbefehl angegebene Port sollte mit dem Attributwert debugPort in der Anhang-Konfiguration übereinstimmen. Beispiel: 

    CMD ["dlv", "debug", "--headless", "--listen=:<debugPort>", "--log"]

    Tipp zur Fehlerbehebung: Beim Beheben von Fehlern in einer Go-Anwendung hält die Anwendung an und wartet auf das Hinzufügen eines Debuggers. Fügen Sie einen Debugger hinzu, damit der Dienst gestartet werden kann.

Java

  • Stellen Sie sicher, dass JVM auf Ihrem Computer installiert ist.

  • Starten Sie die Java-Anwendung mit -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<debugPort>,quiet=y, wobei debugPort aus der Anhang-Konfiguration stammt.

    So starten Sie beispielsweise die Java-Anwendung im Fehlerbehebungsmodus und beobachten Port debugPort auf eine Verbindung:

    ENTRYPOINT ["java","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<debugPort>,quiet=y", "-jar", "my-app-1.0.jar"]

.NET Core

  • Achten Sie darauf, dass auf Ihrem Kubernetes-Container vsdbg installiert ist, der .NET Core-Befehlszeilendebugger von Microsoft.

    Beispiel:

    RUN apt-get update 
    
  && apt-get install -y --no-install-recommends unzip 
    
  && apt-get install -y procps 
    
  && rm -rf /var/lib/apt/lists/* 
    
  && curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l /vsdbg

Eine Anhang-Konfiguration einrichten

Wenn Sie aus VS Code einen debugfähigen Container hinzufügen möchten, benötigen Sie eine Anhang-Konfiguration vom Typ cloudcode.kubernetes.

Projekte, die nicht die Datei ".vscode/launch.json" haben

Wenn Ihr Projekt keine Datei "launch.json" im Ordner .vscode hat, können Sie über das Debug-Feld eine Datei hinzufügen.

  1. Navigieren Sie zum Debug-Feld (über das Symbol Debug-Feld Fehlerbehebungssymbol in der linken Taskleiste) und wählen Sie im Drop-down-Menü Add Configuration aus.

    Konfiguration über den Bereich

  2. Wählen Sie Cloud Code: Kubernetes als Umgebung aus.

    Cloud Code Kubernetes als Umgebung festlegen

  3. Option Attach to Kubernetes Pod auswählen. Kubernetes-Konfigurationsoption auswählen

  4. Wählen Sie die entsprechende Programmiersprache aus.

    Bevorzugte Programmiersprache auswählen

  5. Dadurch wird eine Datei launch.json für Ihr Projekt erstellt und geöffnet sowie eine Anhangskonfiguration erstellt. Sie können jetzt die Konfigurationsattribute in dieser Datei aktualisieren, um sie an die Ihres Projekts anzupassen. Weitere Informationen zu Konfigurationsattributen finden Sie in dieser Tabelle.

    In einer geöffneten launch.json-Datei angezeigte Konfigurationsattribute

Projekte mit der Datei ".vscode/launch.json"

So fügen Sie einer vorhandenen .vscode/launch.json-Datei eine neue Anhang-Konfiguration hinzu:

  1. Öffnen Sie die Datei launch.json.
  2. Klicken Sie auf die Schaltfläche Add Configuration, um das Snippet Intellisense aufzurufen.
  3. Wählen Sie eines der Cloud Code: Attach to Kubernetes Pod-Snippets für die gewünschte Sprache aus.

  4. Dadurch wird eine Konfiguration hinzugefügt. Sie können jetzt die Attribute in dieser Konfiguration aktualisieren, um sie an die Ihres Projekts anzupassen. Weitere Informationen zu Konfigurationsattributen finden Sie in dieser Tabelle.

    Fügen Sie eine Kubernetes-Anhang-Konfiguration hinzu

Konfigurationsattribute

Attribut Beschreibung
debugPort Im Container verwendeter Fehlerbehebungsport.
podSelector Satz von Schlüssel/Wert-Paaren, die zum Auswählen des Pods für die Fehlerbehebung verwendet werden (weitere Informationen zum Selektor). Beispiel für einen typischen podSelector:

"podSelector": { "app": <deployment-name> }

localRoot Pfad zum lokalen Verzeichnis, in dem das Programm enthalten ist, für das Sie die Fehlerbehebung durchführen. Die Standardeinstellung ist ${workspaceFolder}.
remoteRoot Absoluter Pfad zum Remote-Verzeichnis (im Kubernetes-Container) mit dem Programm, in dem Sie die Fehlerbehebung ausführen.

Debugger an einen Kubernetes-Pod anhängen

Nachdem Sie die Konfiguration und den Container eingerichtet haben:

  1. Öffnen Sie über Fehlerbehebungssymbol die Fehlerbehebungsansicht in VS Code.
  2. Verwenden Sie F5, um die Konfiguration auszuwählen und zu starten.
    • localhost:${debugPort} wird während der Fehlerbehebung an den Container debugPort weitergeleitet.
  3. Die Fehlerbehebungssitzung wurde erfolgreich eingerichtet.
  4. Sie können jetzt alle Aufgaben ausführen, die normalerweise beim Debuggen von lokalem Code anfallen, z. B. das Festlegen von Haltepunkten und das Durchlaufen von Code.

  5. In der Debugging-Seitenleiste können Sie Variablen und Stack-Informationen prüfen. Verwenden Sie die Debug Console im Debugger im unteren Bereich, um mit der Debugging-Sitzung zu interagieren.

    Eine Anwendung, die am Haltepunkt angehalten wurde und deren Variablen und Aufrufstapel mit Werten im entsprechenden Bereich gefüllt wurden

  6. Um die Debugging-Sitzung zu beenden, klicken Sie in der Debug-Toolbar auf das Stoppsymbol.

Anhängen an einen Kubernetes-Pod im Vergleich zum Debuggen einer Kubernetes-Anwendung

An einen Kubernetes-Pod anhängen Kubernetes-Anwendung debuggen
Fehler in einem einzelnen Kubernetes-Pod beheben Debugging aller Debug-Container in der Anwendung
Vor der Fehlerbehebung müssen Sie sicherstellen, dass die Anwendung im Kubernetes-Pod ausgeführt wird. Führt die Anwendung auf dem Kubernetes-Cluster aus und hängt den Debugger an.
Verwendet die Konfiguration (.vscode/launch.json) vom Typ "cloudcode.kubernetes" und fordert "anhängen" an. Verwendet die Konfiguration (.vscode/launch.json) vom Typ "cloudcode.kubernetes" und fordert "starten" an.
Start versus Anhang-Konfigurationen.
Beispielkonfiguration: 

{
  "name": "Attach to Kubernetes Pod (NodeJS)",
  "type": "cloudcode.kubernetes",
  "request": "attach",
  "language": "Node",
  "debugPort": 9229,
  "podSelector": {
     "app": "hello-world"
  },
  "localRoot": "${workspaceFolder}",
  "remoteRoot": "/app"
}
Beispielkonfiguration: 

{
  "name": "Run/Debug on Kubernetes",
  "type": "cloudcode.kubernetes",
  "request": "launch",
  "skaffoldConfig": "${workspaceFolder}/skaffold.yaml",
  "watch": true,
  "cleanUp": true,
  "portForward": true
}
Diese Konfiguration kann nicht zum Ausführen der Anwendung verwendet werden Diese Konfiguration kann sowohl zum Ausführen als auch zur Fehlerbehebung der Anwendung verwendet werden.
Diese Konfiguration ist sprachspezifisch Diese Konfiguration ist sprachunabhängig
Kein dedizierter Befehl Befehl "Debug on Kubernetes" (Fehlerbehebung auf Kubernetes)

Support

Wenn Sie uns Feedback geben möchten, können Sie Probleme auf GitHub melden oder eine Frage in Stack Overflow stellen.