添加资源
资源是 Excubius 监视的一个对象:SQL Server 实例、Web 终结点、报表服务器或主机。添加资源时,Excubius 会立即设置其类型的默认检查。本指南说明如何使用 Add resource 向导添加资源、测试其连接、发现其上运行的内容,以及编辑或删除它。
开始之前
- 你需要在将容纳该资源的实体上拥有 Entity admin(实体管理员)角色。
- 资源所需的凭据已存储,或者你准备在向导中创建它。请参阅为采集器存储凭据。
- Excubius 服务器可以通过正确的端口访问该系统。请参阅网络路径。
数据源报告的资源(例如来自 Azure Monitor 的 Azure 资源或来自 NinjaOne 的设备)会自动出现。你只需要添加原生采集器可以访问的内容。数据库和链接服务器也不需要手动添加:请从它们所在的实例中发现它们。
添加资源
- 控制台
- API
- 打开 Resources 并选择 Add resource。
- Type:选择它是什么。每种类型都会显示默认获得多少检查以及所需的详细信息。
- Place and name:选择 Entity(它决定资源继承的内容:阈值、频道、凭据),并输入到处显示的 Name,例如
sql-ventas-01。 - Connection:输入该类型的详细信息,必填项在前。在继续之前会对它们进行检查。
- Tags:添加
key:value对,至少包含env、role和client,并设置从 1(低)到 5(严重)的 Criticality。 - Credential:选择一个可用的合适凭据,选择 None 使用父资源的凭据,或选择 New credential 在此处创建一个。
- Review 你输入的内容,然后选择 Create resource。
curl -s "${H[@]}" -X POST "$BASE/resources" -d "{
\"entity_id\": \"$PROD\", \"type\": \"web_endpoint\", \"name\": \"portal-ventas\",
\"attributes\": {\"url\": \"https://ventas.ciguapa.example/\", \"domain\": \"ciguapa.example\"},
\"tags\": {\"env\": \"prod\", \"role\": \"web\", \"client\": \"ciguapa\"}, \"criticality\": 4
}" | jq '{id, name, checks_provisioned}'
$BASE 是 https://<your server>/api/v1,H 保存你的持有者令牌;请参阅 API 参考。
默认检查会立即设置,第一批值会在一两分钟内到达。最后一个界面提供 Test connection、针对 SQL Server 实例的 Discover、Open the resource 和 Add another。
各类型的详细信息
| 类型 | 必填 | 其他详细信息 |
|---|---|---|
| SQL Server 实例 | host | port(默认为 1433);对于没有固定端口的命名实例,使用 instance,通过 UDP 1434 上的 SQL Server Browser 访问 |
| Always On 可用性组 | ag_name | 通常由发现创建,连同其侦听器、副本和数据库 |
| SQL Server Reporting Services | portal_url | test_report_path 用于呈现一个报表;host、port、instance 和 report_server_db(默认为 ReportServer)用于执行日志检查 |
| Web 终结点 / 门户 | url | expect_status、expect_text;domain(可注册域)用于域名到期检查 |
| Windows 主机 | — | ip;没有它时,采集器连接到资源名称 |
| Linux 主机 | — | ip 和 ssh_port(默认为 22);没有 ip 时,采集器连接到资源名称 |
| PostgreSQL 服务器 | — | host、port |
| Entra ID 租户 / 域服务 | — | tenant_id、domain;包含身份检查 |
| 监视平台本身 | — | heartbeat_url;包含平台级检查,例如更新源和云态势 |
| Azure 资源 | — | resource_id;通常由 Azure Monitor 数据源添加 |
测试连接
在资源页面上,选择 Test connection。采集器会在大约 10 秒内获取该测试,并使用资源的凭据进行连接。
| 类型 | 成功的测试会显示 |
|---|---|
| SQL Server 实例、可用性组 | 服务器名称、版本号、版本类型和延迟,登录名的权限(并列出缺少的权限),以及当登录名是 sysadmin 时的警告 |
| 报表服务器、Web 终结点 | 地址、HTTP 状态和版本,以及延迟 |
失败的测试会显示错误类型和提示:
| 错误类型 | 检查内容 |
|---|---|
auth | 登录名和密码,以及实例是否接受 SQL 登录名 |
unreachable | 主机名、端口,以及 Excubius 服务器与该系统之间的防火墙 |
timeout | 网络路径;系统没有及时响应 |
query | 登录名缺少的权限 |
config | 需要在 Excubius 中修复的内容:主机、凭据或已存储的机密 |
如果测试一直停留在 waiting for the collector,并以 No collector picked it up 结束,则表示采集器没有运行、没有令牌,或者不提供该传输方式。请参阅采集器错误。
发现实例上运行的内容
在 SQL Server 实例上,选择 Discover。发现会读取服务器、其可用性组(包括副本、角色和侦听器)、其数据库、其链接服务器,以及 SQL Agent 摘要。它会把这些内容作为子资源添加或更新,并带有各自的检查,然后报告创建了多少、更新了多少,以及有多少不再被发现。
- 拓扑每次发生变化时,请再次运行发现。
- 不再被发现的子资源会标记为 missing,并保留其历史记录。发现从不删除它;确认它已永久消失后,请自行删除。
- 对于可用性组,请将每个副本添加为实例,并在其中一个副本上运行发现。请参阅快速入门:添加可用性组。
编辑或删除资源
- Edit 会更改名称、重要性、标记和凭据。连接详细信息和实体通过 API 更改:
PATCH /api/v1/resources/{id},包含attributes或entity_id。 - Delete 会删除资源及其已发现的子资源、检查、指标和警报。被监视的系统本身绝不会被触碰。
编辑者可以在资源的 Checks 选项卡上,针对单个资源打开或关闭检查,并更改其间隔和阈值;请参阅资源及资源页面。