PHPackages                             xincheng/yii2-health - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps & Deployment](/categories/devops)
4. /
5. xincheng/yii2-health

ActiveYii2-extension[DevOps & Deployment](/categories/devops)

xincheng/yii2-health
====================

Health check extension for Yii2 (HTTP + CLI + Kubernetes probes).

0.0.1(6mo ago)066MITPHPPHP >=7.4

Since Dec 19Pushed 6mo agoCompare

[ Source](https://github.com/thinksvip/yii2-health)[ Packagist](https://packagist.org/packages/xincheng/yii2-health)[ RSS](/packages/xincheng-yii2-health/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (1)Versions (2)Used By (0)

xincheng/yii2-health
====================

[](#xinchengyii2-health)

面向 Kubernetes 的 Yii2 健康检查扩展（支持 `liveness/readiness` 与 CLI 探针），可自动探测项目中已配置的中间件并输出统一的健康报告。

功能特性
----

[](#功能特性)

- **即插即用**：通过 `yiisoft/yii2-composer` 自动 bootstrap，无需手动改动路由规则。
- **两种探针模型**：
    - **HTTP 探针**（Web / php-fpm 模型）：`/livez`、`/readyz`、`/healthz`。
    - **CLI 探针**（纯 worker/脚本模型）：`php yii health/run`。
- **可选依赖友好**：默认 `enabled=auto`，未配置的组件会返回 `skipped`，不会 fatal。
- **多 DB 场景**：支持多个 `yii\db\Connection` 并存，配合 `autoDiscover` 自动发现/逐个检测。
- **已内置 checks**：MySQL/Redis/MongoDB/Elasticsearch/RabbitMQ/Queue/TDengine/Kafka。

环境要求
----

[](#环境要求)

- PHP `>= 7.4`
- Yii2 `~2.0.49`

安装
--

[](#安装)

### 方式一：Composer 安装（推荐）

[](#方式一composer-安装推荐)

在项目根目录执行：

```
composer require xincheng/yii2-health
composer dump-autoload
```

使用
--

[](#使用)

### CLI（适合 worker / cron / 脚本容器）

[](#cli适合-worker--cron--脚本容器)

```
php yii health/run --format=json
php yii health/run --format=text
```

退出码：

- overall `critical`：返回非 0（用于 k8s `exec` readinessProbe）
- 其它状态：返回 0

### HTTP（适合 Web / php-fpm 模型）

[](#http适合-web--php-fpm-模型)

业务接口：

- `GET /health.json`：JSON 明细（HTTP 200/503）
- `GET /health/summary`：只返回 `ok|warning|critical|skipped`（HTTP 200/503）
- `GET /health`：HTML 面板（HTTP 200/503）

Kubernetes 探针接口：

- `GET /livez`：liveness（永远 200，返回 `ok`，不做外部依赖检查）
- `GET /readyz`：readiness（200/503，返回 `ready`/`not-ready`）
    - 默认 `full=0`：不跑 `autoDiscover` 的检查（避免多 DB/慢依赖拖慢探针）
    - 可选：`/readyz?full=1` 包含 `autoDiscover`；`/readyz?checks=db,redis` 只跑指定 checks
- `GET /healthz`：k8s 风格 JSON（默认精简；`verbose=1`/失败时带 `checks[]`）
    - 示例：`/healthz?verbose=1&full=1`

Kubernetes 配置示例
---------------

[](#kubernetes-配置示例)

### 模型一：纯 CLI / Worker（无 Nginx、无 HTTP 入口）

[](#模型一纯-cli--worker无-nginx无-http-入口)

推荐用 **exec probe**：

```
readinessProbe:
  exec:
    command: ["sh", "-lc", "php yii health/run --format=json > /dev/null"]
  initialDelaySeconds: 10
  periodSeconds: 15
  timeoutSeconds: 10
  failureThreshold: 3

# livenessProbe 不建议做外部依赖检查（避免依赖抖动导致重启风暴）
livenessProbe:
  exec:
    command: ["sh", "-lc", "php -r \"echo 'ok';\" > /dev/null"]
  initialDelaySeconds: 30
  periodSeconds: 30
  timeoutSeconds: 3
  failureThreshold: 3
```

### 模型二：Web / PHP-FPM（有 HTTP 服务）

[](#模型二web--php-fpm有-http-服务)

推荐用 **httpGet probe**：

```
ports:
  - name: http
    containerPort: 80

livenessProbe:
  httpGet:
    path: /livez
    port: http
  initialDelaySeconds: 30
  periodSeconds: 30
  timeoutSeconds: 3
  failureThreshold: 3

readinessProbe:
  httpGet:
    path: /readyz
    port: http
  initialDelaySeconds: 10
  periodSeconds: 15
  timeoutSeconds: 10
  failureThreshold: 3
```

补充说明：

- 如果你的容器 **只有 php-fpm:9000**（没有 nginx/http server），k8s 的 `httpGet` probe 无法直接用，请改用上面的 **exec probe**。
- 如果 Pod 里有 **nginx 容器 + php-fpm 容器** 两个容器：通常把 `httpGet` probe 配在 nginx 容器上；php-fpm 容器可选用 exec probe 做兜底。

配置
--

[](#配置)

默认配置见 `config/health.php`，也可以在应用配置中覆盖（示例）：

```
'components' => [
    'health' => [
        'class' => \Xincheng\Health\HealthComponent::class,
        'autoDiscover' => false, // worker/readiness 建议关闭
        'checks' => [
            'db' => [
                'enabled' => false, // 显式关闭：请使用 bool，避免字符串歧义
            ],
            'kafka' => [
                'enabled' => 'auto',
                'brokers' => 'kafka-1:9092,kafka-2:9092',
            ],
        ],
    ],
],
```

测试
--

[](#测试)

```
./vendor/bin/phpunit -c vendor/xincheng/yii2-health/phpunit.xml.dist
```

License
-------

[](#license)

MIT

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance66

Regular maintenance activity

Popularity11

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity25

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

198d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/23026450?v=4)[thinksvip](/maintainers/thinksvip)[@thinksvip](https://github.com/thinksvip)

---

Top Contributors

[![thinksvip](https://avatars.githubusercontent.com/u/23026450?v=4)](https://github.com/thinksvip "thinksvip (1 commits)")

---

Tags

healthyii2healthcheckkubernetesreadinessliveness

### Embed Badge

![Health badge](/badges/xincheng-yii2-health/health.svg)

```
[![Health](https://phpackages.com/badges/xincheng-yii2-health/health.svg)](https://phpackages.com/packages/xincheng-yii2-health)
```

###  Alternatives

[craftcms/cms

Craft CMS

3.6k3.6M3.1k](/packages/craftcms-cms)[skeeks/cms

SkeekS CMS — control panel and tools based on php framework Yii2

13825.8k59](/packages/skeeks-cms)[mongosoft/yii2-soap-server

SOAP Server Extension for Yii 2

25272.0k](/packages/mongosoft-yii2-soap-server)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)