当前位置：首页 > news >正文

终极指南：为kkFileView容器配置自定义健康检查与存活探针

news 2026/5/11 20:44:53

终极指南：为kkFileView容器配置自定义健康检查与存活探针

【免费下载链接】kkFileViewUniversal File Online Preview Project based on Spring-Boot项目地址: https://gitcode.com/GitHub_Trending/kk/kkFileView

kkFileView作为一款基于Spring-Boot的通用文件在线预览项目，提供了强大的文档预览功能，支持PDF、Office文档、图片等多种格式。为确保服务稳定运行，配置可靠的容器健康检查机制至关重要。本文将详细介绍如何为kkFileView容器实现基于自定义脚本的存活探针，保障服务持续可用。

为什么需要健康检查？

在容器化部署环境中，服务可能因内存溢出、依赖服务故障或资源耗尽等原因异常退出。健康检查能够实时监控服务状态，在检测到故障时自动重启容器，确保服务高可用性。对于文件预览服务而言，健康检查尤为重要，因为文件转换过程可能消耗大量系统资源，容易出现进程挂起等问题。

kkFileView健康检查基础配置

kkFileView已内置Spring Boot Actuator健康检查端点，通过以下配置即可启用：

# server/src/main/config/application.properties management.endpoints.web.exposure.include=health,info,metrics management.endpoint.health.show-details=always management.health.defaults.enabled=true

默认情况下，访问http://localhost:8012/actuator/health即可获取服务健康状态。但基础健康检查仅能判断Spring Boot应用是否运行，无法检测文件转换核心功能是否正常。

自定义健康检查脚本实现

为更全面地监控服务状态，我们需要创建自定义健康检查脚本，验证文件预览核心功能。以下是实现步骤：

1. 创建健康检查脚本

在项目根目录创建docker/healthcheck.sh文件：

#!/bin/bash # 验证Actuator健康端点 ACTUATOR_HEALTH=$(curl -s -o /dev/null -w "%{http_code}" http://localhost:8012/actuator/health) if [ "$ACTUATOR_HEALTH" -ne 200 ]; then echo "Actuator health check failed with status $ACTUATOR_HEALTH" exit 1 fi # 验证PDF预览功能 PREVIEW_TEST=$(curl -s -o /dev/null -w "%{http_code}" "http://localhost:8012/onlinePreview?url=http://example.com/test.pdf&officePreviewType=pdf") if [ "$PREVIEW_TEST" -ne 200 ]; then echo "PDF preview test failed with status $PREVIEW_TEST" exit 1 fi exit 0

2. 修改Dockerfile集成健康检查

编辑项目根目录的Dockerfile，添加健康检查配置：

FROM keking/kkfileview-base:4.4.0 ADD server/target/kkFileView-*.tar.gz /opt/ ENV KKFILEVIEW_BIN_FOLDER=/opt/kkFileView-4.4.0/bin # 添加健康检查脚本 COPY docker/healthcheck.sh /usr/local/bin/ RUN chmod +x /usr/local/bin/healthcheck.sh # 配置健康检查 HEALTHCHECK --interval=30s --timeout=10s --start-period=60s --retries=3 \ CMD /usr/local/bin/healthcheck.sh ENTRYPOINT ["java","-Dfile.encoding=UTF-8","-Dspring.config.location=/opt/kkFileView-4.4.0/config/application.properties","-jar","/opt/kkFileView-4.4.0/bin/kkFileView-4.4.0.jar"]

健康检查参数详解

健康检查配置包含四个关键参数：

interval: 检查间隔时间，建议设置为30s，平衡监控实时性和资源消耗
timeout: 检查超时时间，建议设置为10s，避免检查过程阻塞
start-period: 启动宽限期，建议设置为60s，给服务足够的初始化时间
retries: 失败重试次数，建议设置为3次，减少误判

Kubernetes环境下的存活探针配置

如果在Kubernetes中部署kkFileView，可通过以下配置实现存活探针：

apiVersion: apps/v1 kind: Deployment metadata: name: kkfileview spec: replicas: 1 template: spec: containers: - name: kkfileview image: your-registry/kkfileview:latest ports: - containerPort: 8012 livenessProbe: exec: command: ["/usr/local/bin/healthcheck.sh"] initialDelaySeconds: 60 periodSeconds: 30 timeoutSeconds: 10 failureThreshold: 3