gerardojbaez/php-checkup

框架无关的应用健康和需求检查。

v0.6.0 2020-08-03 00:57 UTC

This package is auto-updated.

Last update: 2024-08-29 23:11:26 UTC


README

Banner

PHP Checkup

框架无关的应用健康和需求检查。

Build Status Coverage Software License

TL;DR

use \Gerardojbaez\PhpCheckup\Checks\Php\ExtensionIsLoaded;
use \Gerardojbaez\PhpCheckup\Manager;
use \Gerardojbaez\PhpCheckup\Runner;

$manager = new Manager;

// Register checks
$manager->add(
    (new Check('Required PHP extension "mbstring" is installed', new ExtensionIsLoaded('mbstring')))
        ->group('requirements')
        ->passing('The extension is installed')
        ->failing('The extension is not installed. Please install or enable it before proceeding.')
        ->critical()
);

// Run checks
$runner = new Runner($manager);
$runner->run()->isPassing();

为什么

应用健康检查是查看应用在任何给定时间性能的一种好方法,并且可以查看哪些需要立即关注。它们还通过允许用户快速轻松地与开发者共享重要的环境特定信息来提高沟通。

PHP Checkup旨在通过为开发者提供常见检查列表、添加新自定义检查的快速方法以及运行所有或部分检查的简便方法来提供此类功能的基础。

用例

  • 应用预安装检查
    • 例如,确保服务器满足所有最低要求
  • 应用后安装检查
    • 例如,确保首页和API返回200状态码,
    • oAuth服务器配置正确,
    • 安装器被禁用
  • 应用后更新检查
  • 显示应用所有健康检查的行政系统内的网页。
  • 独立的包,用户可以在购买前检查他们的服务器是否满足特定应用的一组最低要求。
  • 应用性能检查清单和建议。
  • 执行特定环境的检查

示例健康检查

  • URL HTTP状态
  • 数据库连接
  • 数据库类型
  • 数据库版本
  • PHP版本
  • 已安装PHP扩展
  • PHP内存限制
  • PHP INI设置(更常用于建议和安全检查)
  • 队列状态
  • 最后执行的cronjob(如果最后执行的cronjob比指定的日期早,可能显示警告)
  • 可写目录或文件
  • 预期目录结构
  • 文件或目录的存在/不存在
  • 支付网关连接
  • 电子邮件服务连接
  • 确保像.env这样的私有文件不可公开访问
  • 警告生产环境中开启调试标志
  • SSL检查
  • 警告过于宽松的文件权限