远程调试在K8S的POD中的Java应用程序

前言

现在越来越多的公司选择利用Kubernetes来部署和管理Java应用，那么当运行在k8s中的应用运行异常时，除了看日志，远程调试也是个非常实用的办法。

接下来，本文将通过实际操作带大家学习如何远程调试！

启动项目

首先我们得有一个 Java 应用程序，它提供了一些 REST 端点，并且希望使用 IDE 对其进行调试。

让我们在 Spring Boot 中创建一个简单的应用程序，它提供了一个简单的 REST 端点。

@RestController
public class WebController {
    @GetMapping("/")
    public ResponseEntity get(){
        return ResponseEntity.ok("All Works fine");
    }
}

现在，我们通过maven中使用Google的 JIB 插件来创建此应用程序的docker镜像。

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>jib-maven-plugin</artifactId>
    <version>3.2.1</version>
    <configuration>
        <from>
            <image>openjdk:17</image>
        </from>
        <to>
            <image>ghcr.io/amrutprabhu/${project.name}:${project.version}</image>
        </to>
    </configuration>
    <executions>
        <execution>
            <phase>verify</phase>
            <goals>
                <goal>build</goal>
            </goals>
        </execution>
    </executions>
</plugin>

当然，还有其它插件也可以用于创建docker镜像。

现在当我们运行mvn clean verify, 这个docker镜像会被构建出来，并推送到github 仓库中。

部署docker镜像到Kubernetes

此时需要有一个Kubernetes 集群来部署我们的应用程序。如果没有现成的，那我们可以使用 https://k3s.io 在本地运行一个轻量级Kubernetes集群。

我们将使用此 K3s 集群来部署我们的应用程序。

为了部署我们的应用程序，我们将创建一个包含部署定义的简单 helm 清单，如下所示。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: application-deployment
spec:
  selector:
    matchLabels:
      app: application
  template:
    metadata:
      labels:
        app: application
    spec:
      containers:
        - image: ghcr.io/amrutprabhu/remote-application:1.0.0-SNAPSHOT
          imagePullPolicy: Always
          ports:
            - name: http
              containerPort: 8080
              protocol: TCP
            - name: debug-port
              containerPort: 5005
              protocol: TCP
          env:
            - name: JAVA_TOOL_OPTIONS
              value: '-Xdebug -agentlib:jdwp=transport=dt_socket,address=0.0.0.0:5005,server=y,suspend=n'

对我们来说，最重要的是在部署中设置的环境变量JAVA_TOOL_OPTIONS。

由于我们使用的是 OpenJDK 映像，JVM 将选取此value环境变量以允许将调试器附加到端口 5005 .

现在可以使用 helm install <location of the helm chart> 命令来部署应用程序。

部署应用程序后，需要将 5005 端口进行转发以附加我们的调试器。

kubectl port-forward <your pod name> 5005:5005

同样，我们转发端口 8080 以调用我们的 REST 接口。

使用 Intellij 附加远程调试器

要附加调试器，请转到IDEA 右上角的运行部分并添加远程 JVM 调试运行配置。

命令行参数与我们指定为部署文件中的环境变量的值相同。

现在可以运行配置，调试器将被附加到对应应用。

使用 VSCode 附加远程调试器

要使用 VScode 附加远程调试器，我们需要添加启动配置，如下所示

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "java",
      "name": "Remote debugging RemoteApplication", // name for you your configuration
      "request": "attach",
      "hostName": "localhost",
      "projectName": "remote-application", //  your java project
      "port": "5005" // port to attach to
    }
  ]
}

要添加此启动配置，请转到左侧栏上的“运行和调试”，然后单击顶部的齿轮图标以打开launch.json。

完成此操作后，启动配置，调试器将被附加。添加断点并在终结点上发送请求，以便调试器暂停执行，如下所示。

小结

本文介绍了如何打包springboot docker镜像，如何部署到k8s集群中， 以及如何通过idea或者vscode 远程调试k8s集群中的java应用程序。后续会针对docker和k8s进行更深入的介绍。