如何在Symfony中添加应用健康状态监控接口

夏辰君_2890

夏辰君_2890

2026-05-19

129人浏览

原创

应使用 symfony/health-check-bundle,它轻量、活跃维护、兼容 Symfony 5.4+ 及 6.x/7.x,自动启用,默认路由 /health 返回 200 OK + {"status": "ok"}。

如何在symfony中添加应用健康状态监控接口

健康检查接口该用哪个Bundle

Symfony官方不提供开箱即用的健康检查端点,symfony/health-check-bundle 是目前最轻量、维护活跃且兼容 Symfony 5.4+ 和 6.x/7.x 的选择。它不依赖 Doctrine 或其他重型组件,适合只检查 HTTP 可达性、Redis 连通性或自定义逻辑的场景。

避免使用已归档的 liip/monitor-bundle(PHP 8+ 兼容性差)或过度复杂的 spatie/laravel-health(Laravel 专用,非 Symfony)。

  • 执行 composer require symfony/health-check-bundle
  • Bundle 会自动启用(Symfony Flex ≥1.4),无需手动注册
  • 默认路由为 /health,返回 200 OK + JSON {"status": "ok"}

如何添加数据库连通性检测

单纯返回 200 没意义,真实环境需验证关键依赖是否就绪。Bundle 提供 DatabaseHealthCheck,但默认不启用 —— 它需要你显式配置并注入 Doctrine\DBAL\Connection 实例。

在 config/packages/health_check.yaml 中添加:

health_check:
    checks:
        database:
            type: 'database'
            options:
                connection: 'doctrine.dbal.default_connection'

注意:connection 值必须与你的 Doctrine 配置中定义的连接名一致(常见为 default_connection,而非 default)。若用多数据库,此处填具体连接 ID。

  • 失败时返回 503 Service Unavailable,响应体含 "error": "Connection failed"
  • 该检查仅执行 PDO::query("SELECT 1"),不触发任何 ORM 逻辑,开销极低
  • 若 Doctrine 未启用或连接配置错误,启动时会抛出 InvalidArgumentException

怎么加入自定义健康逻辑(如外部API可达性)

用 AbstractHealthCheck 写一个服务类,比硬编码判断更易测试和复用。例如检查第三方支付网关是否响应:

Symfony Linux版
Symfony Linux版

Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。

下载
namespace App\Health;
<p>use Symfony\Component\Health\Check\AbstractHealthCheck;
use Symfony\Contracts\HttpClient\HttpClientInterface;</p><p>class PaymentGatewayHealthCheck extends AbstractHealthCheck
{
public function __construct(private HttpClientInterface $httpClient) {}</p><pre class="brush:php;toolbar:false;">protected function doCheck(): ?string
{
    try {
        $response = $this->httpClient->request('GET', 'https://api.pay.example.com/health', [
            'timeout' => 2.0,
        ]);
        if ($response->getStatusCode() !== 200) {
            return sprintf('Bad status: %d', $response->getStatusCode());
        }
    } catch (\Exception $e) {
        return $e->getMessage();
    }

    return null; // 表示通过
}

}

然后在配置中注册:

health_check:
    checks:
        payment_gateway:
            type: 'custom'
            class: 'App\Health\PaymentGatewayHealthCheck'
  • 返回 null 表示健康;返回字符串表示不健康,内容将作为 error 字段输出
  • 不要在 doCheck() 中做耗时操作(如重试、长轮询),超时默认 5 秒,可配 timeout 参数
  • 该服务会被自动标记为 public 和 autoconfigure,无需额外设 tags

为什么 /health 接口返回 404 或权限拒绝

两个高频原因:路由未加载,或安全配置拦截了未认证访问。

检查 config/routes/health_check.yaml 是否存在且内容为:

health_check:
    resource: '@HealthCheckBundle/Resources/config/routing.yaml'

若项目启用了 security.yaml 的全局访问控制(如 access_control 中匹配 ^/),必须显式放行:

access_control:
    - { path: ^/health, roles: IS_AUTHENTICATED_ANONYMOUSLY }
  • 别用 roles: PUBLIC_ACCESS(Symfony 6.2+ 已弃用)
  • 若部署在反向代理后(如 Nginx),确保 X-Forwarded-For 头未被过滤,否则健康探针可能被误判为非法请求
  • 本地开发用 bin/console debug:router | grep health 确认路由是否注册成功

健康检查不是“加个接口就完事”,真正难的是判断哪些依赖值得检查、超时设多长、失败后是否要降级响应——这些都得贴着你的部署拓扑和 SLO 来调。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

symfony

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9984

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5941

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2075

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3708

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4414

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3471

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4937

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3862

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11842

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15.4万人学习