scrutiny

smartd S.M.A.R.T 监控的 WebUI

[!NOTE] Scrutiny 仍在开发中，尚有一些不完善之处。

[!NOTE] Scrutiny 仍在开发中，尚有一些不完善之处。

简介

如果您运行的服务器带有多个硬盘，您可能已经熟悉 S.M.A.R.T 和 smartd 守护进程。如果不熟悉，以下是对这个出色开源项目的描述：

smartd 是一个守护进程，用于监控许多 ATA、IDE 和 SCSI-3 硬盘中内置的自我监控、分析和报告技术（S.M.A.R.T）系统。S.M.A.R.T 的目的是监控硬盘的可靠性、预测硬盘故障，并执行不同类型的硬盘自检。

这些 S.M.A.R.T 硬盘自检可以帮助您在硬盘导致永久性数据丢失之前检测并更换故障硬盘。然而，smartd 存在一些问题：

• 存在超过一百种 S.M.A.R.T 属性，但 smartd 无法区分关键指标和信息性指标
• smartd 不记录 S.M.A.R.T 属性历史，因此难以确定某个属性是否在随时间缓慢退化
• S.M.A.R.T 属性阈值由制造商设置。在某些情况下，这些阈值未设置，或者设置得过高，以至于只能用于确认已故障的硬盘，而无法检测即将发生故障的硬盘
• smartd 是纯命令行工具。对于无桌面服务器，Web UI 会更有价值

Scrutiny 是一个硬盘健康仪表盘与监控解决方案，将制造商提供的 S.M.A.R.T 指标与实际故障率相结合。

功能特性

Scrutiny 是一个简单但专注的应用程序，具有以下几个核心功能：

• Web UI 仪表盘 - 专注于关键指标
• smartd 集成（无需重复造轮子）
• 自动检测所有连接的硬盘
• S.M.A.R.T 指标跟踪以显示历史趋势
• 使用实际故障率的自定义阈值
• 温度跟踪
• 提供一体化 Docker 镜像（也可手动安装）
• 通过 Webhooks 进行可配置的告警/通知
• （未来计划）硬盘性能测试与跟踪

使用方法

Scrutiny 运行后，你可以在浏览器中打开 http://localhost:8080 查看仪表板。

http://localhost:8080如果你使用的是 omnibus 镜像，收集器应该已经运行，仪表板会填充 Scrutiny 检测到的所有驱动器信息。收集器配置为每天运行一次，但你可以通过运行以下命令手动触发。

对于使用 Docker Hub/Spoke 部署或手动安装的用户：初始状态下仪表板为空。首次运行收集器后，你将看到所有硬盘及其当前 SMART 状态的列表。

docker exec scrutiny /opt/scrutiny/bin/scrutiny-collector-metrics run

RAID/虚拟驱动器

Scrutiny 使用 smartctl --scan 检测设备/驱动器。

• 所有受 smartctl 支持的 RAID 控制器均会被 Scrutiny 自动支持。
• 部分 RAID 控制器支持将底层 SMART 数据传递给 smartctl，但其他控制器不支持。
• 在某些情况下，--scan 无法正确检测设备类型，会返回https://github.com/AnalogJ/scrutiny/issues/45%E3%80%82Scrutiny 支持通过配置文件覆盖检测到的设备类型：参见 https://github.com/AnalogJ/scrutiny/blob/master/example.collector.yaml
• 如果使用 Docker，必须通过 --device 将 RAID 虚拟磁盘传递到容器中（见下文）
• 该设备可能位于 /dev/* 或 /dev/bus/* 目录下。
• 若不确定，请在主机上运行 smartctl --scan，并将所有列出的设备传递给容器。

有关帮助，请参见 docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md

Docker

[!IMPORTANT] 使用 latest- 标签存在风险，因为它可能在未经警告的情况下更新您的镜像。最佳实践是固定特定版本。Scrutiny 使用语义化版本标签发布版本，因此您可以使用诸如 v0.8.2-omnibus、v0.8-web、v0-collector 等标签。有关所有镜像标签的列表，请参见 https://github.com/AnalogJ/scrutiny/pkgs/container/scrutiny/versions?filters%5Bversion_type%5D=tagged

如果使用 Docker，只需运行以下命令即可快速开始：

有关 docker-compose 文件，请参见 https://github.com/AnalogJ/scrutiny/blob/master/docker/example.omnibus.docker-compose.yml

docker run -p 8080:8080 -p 8086:8086 --restart unless-stopped \
-v `pwd`/scrutiny:/opt/scrutiny/config \
-v `pwd`/influxdb2:/opt/scrutiny/influxdb \
-v /run/udev:/run/udev:ro \
--cap-add SYS_RAWIO \
--device=/dev/sda \
--device=/dev/sdb \
--name scrutiny \
ghcr.io/analogj/scrutiny:latest-omnibus

• /run/udev 是必要的，以提供 Scrutiny 收集器访问您的设备元数据
• --cap-add SYS_RAWIO 是必要的，以允许 smartctl 有权限查询设备的 SMART 数据

[!NOTE] 如果您有 NVMe 驱动器，还必须添加 --cap-add SYS_ADMIN。参见 issue https://github.com/AnalogJ/scrutiny/issues/26#issuecomment-696817130

• --device 条目是必需的，以确保硬盘设备可在容器内访问。
• ghcr.io/analogj/scrutiny:latest-omnibus 是一个全能镜像，包含 Web 应用服务器（前端和 API）以及 SMART 指标收集器（见下文）

中心/分支部署

除了全能镜像（在 latest 标签下可用）外，您还可以以中心/分支模式部署，这需要另外 3 个 Docker 镜像：

• ghcr.io/analogj/scrutiny:latest-collector - 包含 Scrutiny 数据收集器、smartctl 二进制文件和类 cron 调度器。您可以在每台服务器上运行一个收集器。
• ghcr.io/analogj/scrutiny:latest-web - 包含 Web UI 和 API。只需一个容器。
• influxdb:2.8 - InfluxDB 镜像，供 Web 容器用于持久化 SMART 数据。只需一个容器。参见 docs/TROUBLESHOOTING_INFLUXDB.md

有关 docker-compose 文件，请参见 https://github.com/AnalogJ/scrutiny/blob/master/docker/example.hubspoke.docker-compose.yml

docker run -p 8086:8086 --restart unless-stopped \
-v `pwd`/influxdb2:/var/lib/influxdb2 \
--name scrutiny-influxdb \
influxdb:2.8

docker run -p 8080:8080 --restart unless-stopped \
-v `pwd`/scrutiny:/opt/scrutiny/config \
--name scrutiny-web \
ghcr.io/analogj/scrutiny:latest-web

docker run --restart unless-stopped \
-v /run/udev:/run/udev:ro \
--cap-add SYS_RAWIO \
--device=/dev/sda \
--device=/dev/sdb \
-e COLLECTOR_API_ENDPOINT=http://SCRUTINY_WEB_IPADDRESS:8080 \
--name scrutiny-collector \
ghcr.io/analogj/scrutiny:latest-collector

使用 Podman Quadlets 进行无 root 中心安装

有关说明，请参见 docs/INSTALL_ROOTLESS_PODMAN.md

有关示例，请查看 example.scrutiny.yml 中的 notify.urls 部分。

有关更多信息和故障排除，请参阅 TROUBLESHOOTING_NOTIFICATIONS.md 文件。

测试通知

您可以通过向通知健康检查 API 发送空负载来测试通知配置是否正确。

curl -X POST http://localhost:8080/api/health/notify

调试模式与日志文件

Scrutiny 提供了多种方法来将日志级别更改为调试模式并生成日志文件。

Web 服务器/API

您可以使用环境变量为 Web 服务器启用调试日志和/或日志文件：

DEBUG=true
SCRUTINY_LOG_FILE=/tmp/web.log

您可以在配置文件中配置日志级别和日志文件：

log:
file: '/tmp/web.log'
level: DEBUG

如果您不使用 docker，可在启动时向 Web 服务器传递 CLI 参数：

scrutiny start --debug --log-file /tmp/web.log

收集器

您可以使用环境变量为收集器启用调试日志和/或日志文件：

DEBUG=true
COLLECTOR_LOG_FILE=/tmp/collector.log

如果您不使用 docker，可在启动时向收集器传递 CLI 参数：

scrutiny-collector-metrics run --debug --log-file /tmp/collector.log

支持的架构

贡献

有关如何开发和贡献至 Scrutiny 代码库的说明，请参阅 CONTRIBUTING.md。

发挥您的能力，然后提交拉取请求。我们欢迎拉取请求！

如果您发现文档有不足之处，请帮助我们更新此 README.md。如果您没有时间参与 Scrutiny 的开发，但发现了我们应该了解的问题，请提交 issue。

版本控制

我们使用 SemVer 进行版本控制。有关可用版本，请参阅此仓库的标签。

作者

• Jason Kulatunga - 初始开发 - https://github.com/AnalogJ/
• Aram Akhavan - 维护 - https://github.com/kaysond/

许可证

• MIT
• 徽标：Glasses by matias porta lezcano

赞助商

Scrutiny 的实现离不开我的 https://github.com/***/AnalogJ/ 的帮助。

他们阅读了一篇简单的 https://github.com/***/AnalogJ/%EF%BC%8C%E5%B9%B6%E5%86%B3%E5%AE%9A%E4%BF%A1%E4%BB%BB%E5%B9%B6%E8%B5%84%E5%8A%A9%E4%B8%80%E4%BD%8D%E7%B4%A0%E6%9C%AA%E8%B0%8B%E9%9D%A2%E7%9A%84%E5%BC%80%E5%8F%91%E8%80%85%E3%80%82%E8%BF%99%E6%98%AF%E4%B8%80%E6%AC%A1%E4%BB%A4%E4%BA%BA%E5%85%B4%E5%A5%8B%E4%B8%94%E6%97%A0%E6%AF%94%E8%B0%A6%E5%8D%91%E7%9A%84%E7%BB%8F%E5%8E%86%E3%80%82

如果您认为 Scrutiny 有价值，请考虑 https://github.com/***/AnalogJ/