管理监控项
Elastic Stack Serverless
在您创建 Synthetic 监控项后,您需要随着时间的推移来管理该监控项。 这可能包括更新或永久删除现有的监控项。
如果您使用的是项目监控项,您还应该设置一个工作流程,该工作流程使用有效管理生产环境中的监控项的最佳实践。
您可以更新监控项的配置,例如,更改监控项运行测试的间隔。
您还可以更新浏览器监控项中使用的 Journey。 例如,如果您更新了应用程序中使用的 UI,您可能想要更新 Journey 的选择器和断言。
如果您使用 Synthetic 项目设置监控项,您将在 Synthetic 项目源中更新监控项,然后 push
更改。
对于轻量级监控项,请更改 YAML 文件。
对于浏览器监控项,您可以更新一个或多个监控项的配置
- 要更新单个监控项的配置,请直接在 JavaScript 或 TypeScript 文件中编辑 Journey,特别是
monitor.use
中的选项。 - 要更新 Synthetic 项目中所有监控项的配置,请编辑全局 Synthetics 配置文件。
要更新浏览器监控项运行的 Journey,请直接编辑 Journey 代码并在本地测试更新后的 Journey,以确保其有效。
更改监控项后,运行push
命令,以使用更新后的配置或 Journey 代码替换现有的监控项。
更新与监控项的 id
相关联。 要更新监控项,您必须保持其 id
不变。
如果您使用 Synthetics UI 设置监控项,您可以在 Synthetics 应用中更新轻量级和浏览器监控项的监控项配置
转到管理。
单击您要编辑的监控项旁边的铅笔图标。
根据需要更新监控项设置。
- 要更新浏览器监控项中使用的 Journey,请编辑内联脚本。
- 请务必单击运行测试,以在更新监控项之前验证新的 Journey。
单击更新监控项。
最终您可能想要完全删除一个监控项。 例如,如果您要验证的用户 Journey 不再存在。
如果您使用 Synthetic 项目设置监控项,您将从项目源中删除监控项并推送更改。
对于轻量级监控项,请从 YAML 文件中删除监控项。
对于浏览器监控项,请从 JavaScript 或 TypeScript 文件中删除完整的 Journey。
然后,运行push
命令。 与该 Journey 关联的现有监控项将被删除。
如果您使用 Synthetics UI 设置监控项,您可以在 Synthetics UI 中删除轻量级或浏览器监控项
- 转到管理。
- 单击您要删除的监控项旁边的垃圾桶图标。
或者,您可以使用已启用切换开关,通过更新 Journey 代码中的监控项配置或在 Synthetics UI 中暂时禁用监控项。
这仅与使用项目创建的监控项相关。
在您设置项目后,您可以实施一些最佳实践来有效地管理 Synthetics 项目。
首先,建议您在 Git 中对所有文件进行版本控制。 如果您的 Synthetics 项目尚未在版本控制目录中,请添加它并将其推送到您的 Git 主机。
虽然直接从您的工作站运行 push
命令可能很方便,尤其是在设置新的 Synthetics 项目时,但不建议用于生产环境。
相反,我们建议您
在本地开发和测试更改。
为所有配置更改创建一个 pull request。
让您的 CI 服务通过运行
npx @elastic/synthetics .
自动验证 PR。Elastic 的 synthetics 运行器可以以几种不同的格式输出结果,包括 JSON 和 JUnit(大多数 CI 平台支持的标准格式)。
如果您的任何 Journey 失败,它将产生一个非零退出代码,大多数 CI 系统默认将其视为失败。
让人工批准 pull request。
合并 pull request。
让您的 CI 服务在更改合并后自动部署更改,方法是运行
npx @elastic/synthetics push
。
确切的实施细节将取决于您使用的 CI 系统和 Git 主机。 您可以参考在创建新的 Synthetics 项目时包含在 .github
目录中的示例 GitHub 配置文件。