从 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,在集成 UI 中配置和创建监控器。
  1. 创建一个使用 @elastic/synthetics 的项目。
  2. 在 YAML 文件中配置轻量级监控器。
  3. 在 JavaScript 或 TypeScript 文件中编写旅程,并使用 monitor.use 在您的旅程代码中配置各个监控器,或者使用 synthetics.config.ts 文件配置所有监控器。
  4. 使用 elastic/synthetics push 命令创建监控器。

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

如何使用 UI阅读更多

  1. 前往 Kibana 中的 集成页面。
  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 <path-to-existing-project>
    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 一起使用的示例工作流文件。

然后,您可以根据需要进一步配置监控器。在升级后的项目中,您将使用代码(而不是集成 UI)来定义诸如监控器的名称以及其运行频率之类的设置。您可以使用代码通过两种方式配置监控器

  • 对于各个监控器,直接在旅程代码中使用 monitor.use。在配置各个监控器中阅读更多内容。
  • 要一次配置所有监控器,请使用 synthetics 配置文件。在配置项目中阅读更多内容。

最后,您将使用 push 创建监控器,而不是通过在集成 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 应用程序