README

Yii2应用程序健康状态报告模块

安装

安装此扩展的首选方式是通过 composer.

运行以下命令之一：

php composer.phar require --prefer-dist alexeevdv/yii2-health "^1.0"

或者

"alexeevdv/yii2-health": "^1.0"

将以下内容添加到您的 composer.json 的 require 部分。

配置

//...
    'modules' => [
        'health' => [
            'class' => trafficcontrol\yii\health\Module::class,
            'components' => [
                'database' => trafficcontrol\yii\health\components\Database::class,
                'queue' => [
                    'class' => trafficcontrol\yii\health\components\Queue::class,
                    'failoverTimeout' => 600, // default is 300
                ],
            ],
        ],
    ],
    'components' => [
        // ...
            'queue' => [
                // Add this to enable last executed job timestamp logging
                'as health' => trafficcontrol\yii\health\behaviors\QueueBehavior::class,
            ],
            'urlManager' => [
                'rules' => [
                    // Add url rule to access health status report
                    'api/v1/health' => '/health',
                ],
            ],
        // ...
        
    ],
//...

用法

$ curl https:///api/v1/health
{
    "status": "warn",
    "checks": {
        "database": [
            {
                "type": "datastore",
                "status": "pass",
                "time": "2019-07-09T07:32:10+0000",
                "output": ""
            }
        ],
        "queue": [
            {
                "type": "component",
                "status": "warn",
                "time": "2019-07-09T07:32:10+0000",
                "output": "No jobs were executed yet"
            }
        ]
    }
}

支持的组件

• 数据库

  类: trafficcontrol\yii\health\components\Database

  参数

  • db - 数据库组件配置

• 队列

  类: trafficcontrol\yii\health\components\Queue

  参数

  • cache - 缓存组件配置
  • lastExecutedJobCacheKey - 最后执行作业时间戳的缓存键
  • failoverTimeout - 队列报告为失败的最后一个执行作业的时间秒数