从 Elastic Synthetics 集成迁移

编辑

从 Elastic Synthetics 集成迁移编辑

Elastic Synthetics 集成是一种不再推荐的创建综合监视器的方法。

不应使用 Elastic Synthetics 集成来设置新的监视器,而应制定计划将现有监视器迁移到使用项目监视器Synthetics 应用

  • 使用 Elastic 项目监视器,您可以在外部版本控制的项目中编写测试,并使用 CLI 工具将监视器推送到 Elastic Stack。
  • Synthetics 应用是 Kibana 中的一个应用程序,您可以使用它通过用户界面配置和创建监视器。

比较方法编辑

以下是您如何使用 Elastic Agent 集成创建监视器以及如何使用 Synthetics 应用或项目创建监视器的比较

Elastic Agent 集成 项目或 Synthetics 应用

支持的监视器

支持轻量级和浏览器监视器

支持轻量级和浏览器监视器

监视器运行位置 (阅读更多)

您必须在您的基础架构上运行监视器。

您可以在以下两种情况下运行监视器

  • 使用私有位置的您的基础架构
  • Elastic 的全球托管基础架构

您配置监视器的位置

您可以使用以下方法配置监视器

  • Kibana 中的用户界面(所有监视器类型)
  • 外部版本控制项目中的代码(仅限浏览器监视器)

您可以使用以下方法配置监视器

  • Kibana 中的用户界面(所有轻量级监视器,仅通过内联脚本的浏览器监视器)
  • 外部版本控制项目中的代码(所有监视器类型)

如何使用项目 (阅读更多)

  1. 创建了一个使用 @elastic/synthetics 的项目。
  2. 在 JavaScript 或 TypeScript 文件中编写旅程。
  3. 压缩整个项目。
  4. 通过添加指向项目位置的 ZIP URL,在 Integrations UI 中配置和创建监视器。
  1. 创建一个使用 @elastic/synthetics 的项目。
  2. 在 YAML 文件中配置轻量级监视器。
  3. 在 JavaScript 或 TypeScript 文件中编写旅程,并使用 monitor.use 在旅程代码中配置单个监视器,或使用 synthetics.config.ts 文件配置所有监视器。
  4. 使用 elastic/synthetics push 命令创建监视器。

使用项目监视器中查找更多详细信息。

如何使用 UI (阅读更多)

  1. 转到 Kibana 中的Integrations 页面。
  2. 搜索并添加Elastic Synthetics 集成。
  3. 配置监视器。
  4. 创建监视器。
  1. 转到 Kibana 中的Synthetics
  2. 转到管理
  3. 单击创建监视器
  4. 配置监视器。
  5. 创建监视器。

使用 Synthetics 应用中查找更多详细信息。

监视器运行位置编辑

如果您想继续在您的基础架构上托管,则需要在创建监视器之前创建一个私有位置。如果您已经有一个使用 elastic-agent-complete 运行的 Elastic Agent,则可以在 Synthetics 应用中将其添加为新的私有位置。要从头开始创建新的私有位置,请遵循监控私有网络上的资源中的所有说明。

或者,您也可以开始在 Elastic 的全球托管基础架构上托管。借助 Elastic 的全球托管测试基础架构,您可以在多个位置创建和运行监视器,而无需管理自己的基础架构。Elastic 会为您处理软件更新和容量规划。

在 Elastic 的全球托管测试基础架构上执行综合测试会产生额外费用。根据监视器类型,测试将根据两个新的计费维度之一收费。对于浏览器监视器的使用,每次测试运行都会收费。对于轻量级监视器的使用,无论测试运行次数如何,您运行任何监视器的每个区域都会收费。有关更多详细信息,请参阅完整详细信息和当前价格

如何使用项目编辑

如果您已经有一个通过 ZIP URL 添加的外部项目,您可以使用同一个项目,但您必须进行一些更改。

首先,升级现有项目以使用最新版本的 @elastic/synthetics

  1. 运行 npm install -g @elastic/synthetics@latest 以安装最新版本的 CLI。
  2. 升级您的现有项目以使用新的项目设置

    1. 运行 npm @elastic/synthetics init <现有项目的路径>
    2. 响应 CLI 提供的所有提示。

      为了确保您的项目可以使用最新版本的 Elastic Synthetics,CLI 将在 init 上创建一个新的配置文件,但在覆盖现有配置文件之前,您会看到一个询问您是否要继续的提示。

  3. 查看更新的文件和目录,包括

    1. journeys/ 将包含示例旅程代码。将现有的旅程文件移动到此目录。
    2. synthetics.config.ts 将包含升级项目所需的更新后的默认设置。
    3. package.json 将包含项目的更新后的 NPM 设置。

      如果在运行 init 时目录中已经有一个 package.json 文件,则 Synthetics 代理不会创建新的 package.json 文件。相反,它会修改现有的 package.json 文件以

      • 如果依赖项中还没有 @elastic/synthetics 库,则将其添加到依赖项中。
      • 如果还没有 testpush 脚本,则添加它们。
    4. .github/ 将包含与 GitHub Actions 一起使用的示例工作流文件。

然后,您可以根据需要进一步配置监视器。在升级后的项目中,您将使用代码(而不是 Integrations UI)来定义设置,例如监视器的名称和运行频率。您可以使用代码配置监视器的两种方法

  • 对于单个监视器,直接在旅程代码中使用 monitor.use。在配置单个监视器中阅读更多信息。
  • 要一次配置所有监视器,请使用 Synthetics 配置文件。在配置项目中阅读更多信息。

最后,您将使用 push 创建监视器,而不是通过在 Integrations UI 中添加 ZIP URL 来创建监视器。这将需要一个 API 令牌。在@elastic/synthetics push中阅读更多信息。

(可选)您还可以在 YAML 文件中将轻量级监视器添加到项目中。在配置轻量级监视器中阅读有关将轻量级监视器添加到项目的更多信息。

有关项目入门的更多信息,请参阅使用项目监视器

如何使用 UI编辑

如果您仅通过 Elastic Synthetics 集成 UI 创建了监视器,则可以在 Synthetics 应用中重新创建监视器。

Synthetics 应用中的配置选项看起来与 Elastic Synthetics 集成 UI 非常相似,但有一些例外。在 Synthetics 应用中

  1. 您将为每个监视器选择一个或多个位置。
  2. 您不能对浏览器监视器使用 ZIP URL。请改用项目。
  3. 您可以在创建监视器之前使用运行测试测试配置(包括浏览器监视器的旅程)。

有关 Synthetics 应用入门的更多信息,请参阅使用 Synthetics 应用