README

TYPO3 OhDear 健康检查扩展允许您使用 Oh Dear 监控您的 TYPO3 应用程序和服务器健康和性能。使用此扩展，您可以收到关键问题的警报和通知，确保您的 TYPO3 应用程序平稳运行。

功能

• 磁盘空间：监控服务器的磁盘空间使用情况。
• PHP 错误日志大小：检查 PHP 错误日志的大小。
• TYPO3 错误日志大小：检查 TYPO3 错误日志的大小。
• MySQL 数据库大小：检查 MySQL 数据库的大小。
• 服务器上的遗忘文件：扫描文档根目录中的遗忘文件。
• TYPO3 数据库日志：检索 TYPO3 数据库日志。
• TYPO3 版本：检索已安装的 TYPO3 版本。

要求

• TYPO3 版本 11.5.0 或更高。
• 一个有效的 Oh Dear 账户和必要的 API 凭据。

安装

1. 运行以下命令通过 Composer 安装 OhDear 健康检查扩展：composer require devskio/typo3_ohdear_health_check
2. 比较和更新数据库表和字段定义
3. 包含扩展的静态 TypoScript。 EXT:typo3_ohdear_health_check/Configuration/TypoScript/setup.typoscript
4. 安装完成后，转到扩展配置设置并提供您的 Oh Dear API 凭据以及健康报告密钥。您可以选择启用或禁用特定检查的监控以及设置警报阈值。
5. （可选）如果您想要一个漂亮的健康报告 URL，您可以在网站配置 yaml 文件中添加 OhDear 健康检查扩展的 routeEnhancer。

...
routeEnhancers:
  PageTypeSuffix:
    map:
      healthcheck: 1689678601
...

使用方法

1. 安装和配置扩展后，您可以通过 OhDear 健康检查仪表板进行访问。
2. 在应用程序健康中，您必须设置健康检查端点的 URL。URL 是 https://yourdomain.com/?type=1689678601。如果您已添加 routeEnhancer，则可以使用 https://yourdomain.com/healthcheck。
3. 仪表板显示各种监控方面的当前状态，例如磁盘空间、PHP 错误日志大小、TYPO3 错误日志大小、MySQL 数据库大小、服务器上的遗忘文件、TYPO3 数据库日志、TYPO3 版本。
4. 在 OhDear 中配置所需的警报阈值和通知设置。
5. 当检测到问题时，您将通过您选择的通信渠道（例如，电子邮件、Slack、短信）收到警报，具体取决于您的 Oh Dear 配置。

小部件

您可以将 OhDear 健康检查小部件添加到您的 TYPO3 仪表板。小部件使用 OhDear API 获取基本的 OhDear 检查和自定义应用程序健康检查。

为了使用小部件，您需要在扩展配置设置中提供 OhDear API 密钥和 OhDear 网站标识符。

定制

添加自定义检查

您可以通过扩展 AbstractCheck 并在 ext_localconf.php 文件中注册您的自定义检查来添加自定义检查。

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['typo3_ohdear_health_check']['checks'][] = \Vendor\MyExtension\HealthCheck\CustomCheck::class;

自定义检查结果数组

您可以通过监听 HealthCheckAfterRunEvent 事件来自定义所有检查的结果数组。

# EXT:my_extension/Configuration/Services.yaml
services:
  # ...
  MyVendor\MyExtension\EventListener\HealthCheckAfterRunEventListener:
    tags:
      - name: event.listener
        method: handleEvent
        identifier: 'myHealthCheckAfterRunEventListener'
        event: Devskio\Typo3OhDearHealthCheck\Events\HealthCheckAfterRunEvent

贡献

欢迎对 TYPO3 OhDear 健康检查扩展的贡献！如果您遇到任何错误、有建议或想要贡献新功能，请在 GitHub 存储库中提交拉取请求或打开一个问题。

许可

此 TYPO3 OhDear 健康检查扩展在 MIT 许可证 下发布。