体系结构
Excubius 以一小组容器的形式运行在你控制的一台 Linux 服务器上。只读的采集器和你已有的监视工具共同为同一条管道提供数据;管道把所有数据转换为资源、状态和警报,存储在一个数据库中,并提供给 Web 应用、Slack、Jira 和公共状态页。本文介绍每个组成部分、测量值如何变成警报、服务器如何布局,以及哪些数据存储在哪里。
组成部分及其连接方式
| 组成部分 | 作用 |
|---|---|
| 采集器 | 针对你的系统运行目录中的检查:对 SQL Server 使用 T-SQL,对终结点、证书和域名使用 HTTP 和 DNS,使用 Azure 和 Microsoft Graph API,以及 Wazuh 搜索。通过 WinRM 监视 Windows 和通过 SSH 监视 Linux 属于实验性功能。它还会轮询你已有的工具。它使用没有写入权限的凭据进行连接,并在服务器繁忙或重启时把结果保存在缓冲区中 |
| 数据源 | New Relic、NinjaOne 和 Azure Monitor,每个都可以通过轮询、Webhook 或两者并用来读取。它们报告的内容与采集器的结果进入同一条管道,因此它们的警报会到达同一个收件箱和同样的频道 |
| 规范化器 | 把每种输入转换为同样的三种形态:资源、检查结果或警报。系统根据 Azure 资源 ID、主机名和 FQDN 等标识符在不同数据源之间匹配资源,因此被三个工具看到的同一台服务器只算一个资源 |
| 警报引擎 | 将每个结果与其有效阈值比较,触发、升级和解决警报,对警报去重,把警报归入某个根本原因,在静默和维护时段内暂缓通知,并计算每个资源的状态 |
| 数据库 | 带有 TimescaleDB 的 PostgreSQL 16 保存所有内容:配置、资源、指标、带时间线的警报、发现和审核日志 |
| API 和 Web 应用 | API 为 Web 应用提供服务,并根据你在相关实体上的角色检查每个请求。Web 应用可在任何当前的浏览器中运行,也可安装到手机或平板电脑上。公共状态页只根据管理员选择发布的内容生成 |
| 通知 | Slack 消息在结果存储后立即发出,后台扫描每 15 秒发送一次需要等待的消息。Slack 缓慢或不可用时,不会拖延监视。Jira 问题按需创建,并持续跟踪到完成 |
测量值如何变成警报
- 采集器在检查到期时运行检查,并通过服务器的内部网络把结果发送到 API。数据源则通过轮询或 Webhook 报告。
- 先存储结果,因此即使后面的某一步失败,也不会丢失任何内容。结果的值会写入指标历史记录。
- 警报引擎把值与该检查在该资源上的有效阈值比较。当条件在整个
for持续时间内保持成立时,它会触发一条警报,或更新针对同一情况已经打开的警报。 - 重新计算资源的状态,Web 应用会在下一次刷新时显示它。
- 通知步骤判断这次变化是否值得发送消息,通过实体树找到频道,并把每条消息记录在警报的时间线上。
警报和通知详细介绍了第 3 步到第 5 步,阈值和基线介绍了有效阈值的来源。
一台服务器,六个容器
所有组件都运行在一台服务器上,该服务器使用 x86_64 上的 Rocky Linux 9 或 10,或其他 Red Hat Enterprise Linux 系列系统。最低配置为 2 个 vCPU、4 GiB 内存和 20 GiB 可用磁盘空间。这些容器以无根模式,通过 Podman 在服务账户(默认为 excubius)下运行,并随服务器启动。服务器上没有源代码:一个版本就是一组容器映像加一个部署包,由安装程序负责安装和升级。
| 容器 | 角色 |
|---|---|
proxy | 唯一开放端口(80 和 443)的容器。它终止 TLS,把请求转发到 Web 应用或 API,并对 Webhook 实施速率限制 |
frontend | 提供 Web 应用 |
backend | API、规范化器、警报引擎、通知、Jira 和公共状态页 |
collector | 采集器和数据源的轮询。它不开放任何端口,只接收自己的令牌和设置,从不接收数据库密码或加密已存储机密的密钥 |
certs | 颁发并续订 TLS 证书:Let's Encrypt、自签名证书或你自己的证书 |
db | 带有 TimescaleDB 的 PostgreSQL 16 |
采集器只通过服务器的内部网络与 API 通信:proxy 会拒绝来自外部的、指向采集器路由的请求。在出站方向,服务器需要通过 HTTPS 访问 Slack、Jira 和你的数据源的 API。更新模块还会读取公开的版本和公告源,当服务器无法访问它们时,会改用随版本发布的副本。在 Azure 中,请为服务器的托管标识授予只读角色,例如 Reader 和 Monitoring Reader,这样采集器无需存储机密即可读取 Azure。
把外部运行时间监视器指向 https://<your host>/heartbeat。服务器运行期间它会回答 ok,这样当 Excubius 本身停止运行时,你会收到通知。
数据存储在哪里
| 数据 | 位置 | 保留多久 |
|---|---|---|
| 实体、资源、检查、阈值、用户和角色 | 数据库 | 直到你更改它们 |
| 指标 | 数据库,存放在 TimescaleDB 超表中 | 90 天 |
| 警报、发现、它们的时间线、已查看者和分配记录 | 数据库 | 作为历史记录保留 |
| 来自数据源的 Webhook 有效负载 | 数据库 | 30 天 |
| 安全分数历史记录 | 数据库 | 14 天内每小时一个快照,之后 400 天内每天一个 |
| 审核日志 | 数据库 | 一直保留 |
| 凭据和数据源机密 | 数据库,使用仅存储在服务器配置文件中的密钥加密 | 直到你替换或删除它们 |
| 服务器配置:数据库密码、会话签名机密、加密密钥、采集器令牌 | 安装目录中的 .env 文件,默认为 /opt/excubius | 由安装程序一次性生成 |
| TLS 证书 | certs 容器的一个卷 | 剩余 30 天或更短时间时自动续订 |
| 数据库备份 | 安装目录的 backups 文件夹:每天服务器时间 02:30 生成一个转储 | 最近 14 个转储 |
机密是只写的:保存后,任何人都无法在 Web 应用中或通过 API 把它们读回来。仅凭数据库转储无法得到任何机密,因为密钥不在数据库中;出于同样的原因,请把 .env 文件的副本与备份保存在一起,否则恢复数据库后,必须重新输入已存储的机密。请通过你常用的服务器备份,把每日备份复制到服务器之外;升级、备份和还原介绍了如何还原它们。
设计上是只读的
Excubius 负责检测、解释和建议;它从不更改受监视的系统。
- 监视登录名和 API 凭据在创建时不具有写入或安装权限。SQL Server 登录名从不需要
sysadmin。 - 安全发现和更新公告附带以文本形式给出的建议操作,供人员在变更时段内执行。系统不会执行任何操作,也不会安装任何内容。
- 不会向 New Relic、NinjaOne、Azure、Microsoft Entra ID 或 Wazuh 写入任何内容。
- 在 Excubius 中删除资源,只会删除 Excubius 中它的检查、指标和警报。受监视的系统不受影响。
出现故障时
| 故障 | Excubius 的处理 |
|---|---|
| 数据源的 API 已关闭 | 数据源变为过时状态并显示错误。不会因为一次失败的轮询而解决任何警报,也不会凭空生成警报 |
| 采集器无法访问某个资源 | 连续三次出现连接、登录或超时失败后,该资源变为 严重,并生成一条 Cannot reach 警报,该资源的其他警报会排在它后面等待 |
| API 或数据库短暂不可用 | 采集器保留其结果,稍后再发送。重复发送的结果只会存储一次 |
| Slack 不可用 | 监视继续进行。失败的消息会记录在警报上并重试,总共三次 |
| Excubius 服务器已关闭 | 在此期间发送的 Webhook 会丢失。处于混合模式的数据源会在下一次协调时恢复它们 |