无数整数/laravel健康检查

可自定义的健康检查Laravel应用程序

3.0.0 2024-04-15 15:30 UTC

README

build

安装

需要PHP 8.0+。

$ composer require countless-integers/laravel-health-check
$ php artisan vendor:publish

配置

包将其配置发布到您的项目中,您可以在 config/health-check.php 中找到。

注意事项

  • 尽管所有检查类都是可选的,但它们依赖的所有库都不是
  • 没有检查的别名,而是使用检查类名

配置键

检查器

应在服务检查上运行的检查类列表。默认情况下,所有可用的检查器都包含在导出的配置中。您可以通过从该数组中删除其键来禁用您不想要的检查器。

一些检查器可以或需要配置。可用配置选项列表

extended_checks

checkers 具有相同格式,但这些检查仅在端点使用 extended 选项(见下文)调用时运行。

其他选项

贡献指南

PR需要

  • 包含一个描述问题的描述和解决方案的描述
  • 通过静态分析(使用psalm,在CI上运行)
  • 通过测试(使用codeception,在CI上运行)

运行测试

您可以使用composer脚本来

  • 运行所有测试

      $ composer test
    
  • 仅运行单元测试

      $ composer unit-test
    
  • 仅运行具有测试覆盖率的单元测试

      $ composer unit-test-coverage
    
  • 查看覆盖率报告(仅限mac)

      $ composer coverage-report
    
  • 运行静态分析

      $ composer static-analysis
    
  • 运行所有

      $ composer qa