在OpenShift中对Spring Boot应用作健康检查

柔情只为你懂 2022-12-24 12:57 235阅读 0赞

### 文章目录 ###

*  在OpenShift中对Spring Boot应用作健康检查
 *   *  前言
     *  Spring Boot Actuator
     *  在OpenShift上配置Health Checks
     *   *  OpenShfit健康检查基本概念
         *  配置Health Checks
         *   *  Readiness Probe
             *  Liveness Probe
             *  Startup Probe
     *  命令行方式
     *  参考文档

# 在OpenShift中对Spring Boot应用作健康检查 #

## 前言 ##

本文描述了在OpenShift中使用Spring Boot Actuator来对Spring Boot应用作健康检查。

## Spring Boot Actuator ##

在项目中引入Maven依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

详情参见：

*  [Spring Boot Actuator: Production-ready Features][Spring Boot Actuator_ Production-ready Features]

在Spring Boot 2.4.0中， 只有`health`和`info`endpoint被HTTP暴露了出来，不会有安全隐患。

查看所有actuator endpoints：

http://localhost:8080/actuator

Spring Boot 2.4.0的actuator endpoints：

{ 
      "_links": { 
        "self": { 
          "href": "http://localhost:8080/actuator",
          "templated": false
        },
        "health-path": { 
          "href": "http://localhost:8080/actuator/health/{*path}",
          "templated": true
        },
        "health": { 
          "href": "http://localhost:8080/actuator/health",
          "templated": false
        },
        "info": { 
          "href": "http://localhost:8080/actuator/info",
          "templated": false
        }
      }
    }

健康检查Endpoint：

http://localhost:8080/actuator/health

访问OpenShift上Spring Boot应用的健康检查Endpoint：

`http://<router_url>/actuator/health`

## 在OpenShift上配置Health Checks ##

### OpenShfit健康检查基本概念 ###

三种探针类型：

*  **Readiness Probe 就绪探针**
    
    用来判断Pod是否已经准备好提供服务，只有Pod准备好时，kubelet才会将请求转发给该Pod。
 *  **Liveness Probe 生命探针**
    
    用来判断Pod是否还在运行，如果Liveness检查最终失败，OpenShift会杀掉该Pod并启动一个新的Pod。
 *  **Startup Probe 启动探针**
    
    用来判断Pod是否已完成启动，在完成Startup检查前不会进行Liveness检查和Readiness检查。
    
    如果Startup检查最终失败，OpenShift会根据`restartPolicy`决定是否会杀掉该Pod并启动一个新的Pod，默认`restartPolicy`为`Always`。

详情参见：

*  [https://docs.openshift.com/container-platform/4.6/applications/application-health.html][https_docs.openshift.com_container-platform_4.6_applications_application-health.html]

### 配置Health Checks ###

在OpenShift上，打开Spring Boot应用的DeploymentConfig，根据提示点击Add Health Checks。

#### Readiness Probe ####

配置：

*  `Type`: `HTTP GET`
 *  `Use HTTPS`：不勾选（如果用了HTTPS则勾选）
 *  `HTTP Headers`：不配置
 *  `Path`: `/actuator/health` （Spring Boot Actuator health endpoint）
 *  `Port`：`8080` （Spring Boot应用的端口，container port）
 *  `Failures Threshold`：3 （连续3次检查失败，将该Pod状态设置为`Unreday`）
 *  `Success Threshold`： 1 （1次检查成功就认为该Pod正常）
 *  `Initial Delay`： 5 （让kubelet等5秒后开始第一次检查）
 *  `Period`：5 （每5秒检查一次）
 *  `Timeout`：1（检查超时时间为1秒）

这里，让Readiness探针在Pod完成启动后，再等待5秒开始第一次检查，然后每5秒检查一次，如果连续3次检查失败，则将Pod状态设置为`Unready`。

#### Liveness Probe ####

配置：

*  `Type`: `HTTP GET`
 *  `Use HTTPS`：不勾选 （如果用了HTTPS则勾选）
 *  `HTTP Headers`：不配置
 *  `Path`: `/actuator/health` （Spring Boot Actuator health endpoint）
 *  `Port`：`8080` （Spring Boot应用端口，container port）
 *  `Failures Threshold`：3 （连续3次检查失败重启Pod）
 *  `Success Threshold`： 1 （1次检查成功就认为该Pod正常）
 *  `Initial Delay`： 5 （让kubelet等5秒后开始第一次检查）
 *  `Period`：5 （每5秒检查一次）
 *  `Timeout`：1（检查超时时间为1秒）

这里，让Liveness探针在Pod完成启动后，再等待5秒开始第一次检查，然后每5秒检查一次，如果连续3次检查失败，则将该Pod杀掉，再启动一个新的Pod。

#### Startup Probe ####

配置：

*  `Type`: `HTTP GET`
 *  `Use HTTPS`：不勾选 （如果用了HTTPS则勾选，container port）
 *  `HTTP Headers`：不配置
 *  `Path`: `/actuator/health` （Spring Boot Actuator health endpoint）
 *  `Port`：`8080` （Spring Boot应用端口，container port）
 *  `Failures Threshold`：30 （连续30次检查失败根据`restartPolicy`决定是否重启Pod）
 *  `Success Threshold`： 1 （1次检查成功就认为该Pod正常）
 *  `Initial Delay`： 默认为0秒 （让kubelet等待0秒后开始第一次检查）
 *  `Period`：10 （每10秒检查一次）
 *  `Timeout`：1（检查超时时间为1秒）

这里，让Startup探针立即开始第一次检查，每10秒检查一次，连续30次失败 （如果Pod 10 \* 30 = 300 秒都不能启动成功），则根据`restartPolicy`决定是否要重启Pod。

可以根据Pod实际启动用时来调节`Failures Threhod`的值，该值太小可能导致Pod还未完全启动就不断被OpenShift杀掉重启。

## 命令行方式 ##

Readiness probe示例:

# HTTP Get
    oc set probe deployment spring-petclinic --readiness \
      --get-url=http://:8080/actuator/health \
      --period-seconds=3 \
      --initial-delay-seconds=40 \
      --success-threshold=1 \
      --failure-threshold=3 \
      --timeout-seconds=1
      
    # Curl Command
    oc set probe deployment spring-petclinic --readiness \
      --period-seconds=3 \
      --initial-delay-seconds=40 \
      --success-threshold=1 \
      --failure-threshold=3 \
      --timeout-seconds=1 \
      -- curl "http://:8080/actuator/health"

Liveness probe示例:

# HTTP Get
    oc set probe deployment spring-petclinic --liveness \
      --get-url=http://:8080/actuator/health \
      --period-seconds=3 \
      --initial-delay-seconds=100 \
      --success-threshold=1 \
      --failure-threshold=3 \
      --timeout-seconds=1
    
    # Curl Command
    oc set probe deployment spring-petclinic --liveness \
      --period-seconds=3 \
      --initial-delay-seconds=100 \
      --success-threshold=1 \
      --failure-threshold=3 \
      --timeout-seconds=1 \
      -- curl "http://:8080/actuator/health"

## 参考文档 ##

**Kubernetes：**

*  [Configure Liveness, Readiness and Startup Probes][Configure Liveness_ Readiness and Startup Probes]

**OpenShfit：**

*  [https://docs.openshift.com/container-platform/4.6/applications/application-health.html][https_docs.openshift.com_container-platform_4.6_applications_application-health.html]
 *  [https://developers.redhat.com/blog/2020/07/20/best-practices-using-health-checks-in-the-openshift-4-5-web-console/][https_developers.redhat.com_blog_2020_07_20_best-practices-using-health-checks-in-the-openshift-4-5-web-console]
 *  [https://arnoldgalovics.com/smart-healthchecks-with-kubernetes-and-spring-boot-actuator/][https_arnoldgalovics.com_smart-healthchecks-with-kubernetes-and-spring-boot-actuator]

**Spring Boot Actuator:**

*  [Spring Boot Actuator: Production-ready Features][Spring Boot Actuator_ Production-ready Features]
 *  [https://www.baeldung.com/spring-boot-actuators][https_www.baeldung.com_spring-boot-actuators]
 *  [https://www.baeldung.com/openshift-health-checks][https_www.baeldung.com_openshift-health-checks]
 *  [https://www.baeldung.com/spring-boot-kubernetes-self-healing-apps][https_www.baeldung.com_spring-boot-kubernetes-self-healing-apps]
 *  [https://mobilabsolutions.com/2020/04/a-proper-kubernetes-readiness-probe-with-spring-boot-actuator/][https_mobilabsolutions.com_2020_04_a-proper-kubernetes-readiness-probe-with-spring-boot-actuator]

[Spring Boot Actuator_ Production-ready Features]: https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html
[https_docs.openshift.com_container-platform_4.6_applications_application-health.html]: https://docs.openshift.com/container-platform/4.6/applications/application-health.html
[Configure Liveness_ Readiness and Startup Probes]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
[https_developers.redhat.com_blog_2020_07_20_best-practices-using-health-checks-in-the-openshift-4-5-web-console]: https://developers.redhat.com/blog/2020/07/20/best-practices-using-health-checks-in-the-openshift-4-5-web-console/
[https_arnoldgalovics.com_smart-healthchecks-with-kubernetes-and-spring-boot-actuator]: https://arnoldgalovics.com/smart-healthchecks-with-kubernetes-and-spring-boot-actuator/
[https_www.baeldung.com_spring-boot-actuators]: https://www.baeldung.com/spring-boot-actuators
[https_www.baeldung.com_openshift-health-checks]: https://www.baeldung.com/openshift-health-checks
[https_www.baeldung.com_spring-boot-kubernetes-self-healing-apps]: https://www.baeldung.com/spring-boot-kubernetes-self-healing-apps
[https_mobilabsolutions.com_2020_04_a-proper-kubernetes-readiness-probe-with-spring-boot-actuator]: https://mobilabsolutions.com/2020/04/a-proper-kubernetes-readiness-probe-with-spring-boot-actuator/