« 使用 Synthetics 命令行界面浏览器监控的多因素身份验证 (MFA) »

› › ›

配置 Synthetics 项目

合成测试支持配置可在项目中使用的动态参数。此外，基于 Playwright 构建的 Synthetics 代理支持配置 Playwright 特定方法中可用的浏览器和上下文选项，例如 ignoreHTTPSErrors、extraHTTPHeaders 和 viewport。

在 synthetics 项目的根目录中创建一个 synthetics.config.js 或 synthetics.config.ts 文件，并指定选项。例如：

import type { SyntheticsConfig } from '@elastic/synthetics';

export default env => {
  const config: SyntheticsConfig = {
    params: {
      url: 'https://elastic.ac.cn',
    },
    playwrightOptions: {
      ignoreHTTPSErrors: false,
    },
    /**
     * Configure global monitor settings
     */
    monitor: {
      schedule: 10,
      locations: [ 'us_east' ],
    },
    /**
     * Project monitors settings
     */
    project: {
      id: 'my-project',
      url: 'https://abc123',
      space: 'custom-space',
    },
  };
  if (env !== 'development') {
    /**
     * Override configuration specific to environment
     * For example, config.params.url = ""
     */
  }
  return config;
};

上面示例中的 env 是您推送的环境，而不是监控运行的环境。换句话说，env 对应于已配置的 NODE_ENV。

配置文件可以导出一个对象，也可以导出一个函数，该函数在被调用时应该返回生成的配置。要了解有关基于环境配置测试的更多信息，请查看动态配置文档。

`params`

编辑

一个 JSON 对象，定义测试所需的任何变量。更多信息请阅读使用参数和密钥。

`playwrightOptions`

编辑

有关所有可用选项，请参考 Playwright 文档。

通过 Elastic 的全局托管测试基础设施或私有位置运行时，不要尝试以 headful 模式运行（使用 headless:false），因为这不受支持。

以下是与 Elastic Synthetics 特别相关的几个 Playwright 选项的详细信息，包括 TLS 客户端身份验证、超时、时区和设备模拟。

TLS 客户端身份验证

编辑

要启用 TLS 客户端身份验证，请在配置文件中设置 clientCertificates 选项。

基于路径的选项 {certPath, keyPath, pfxPath} 仅在私有位置受支持，在 Elastic 托管的位置运行时，请使用内存中的替代方案 {cert, key, pfx}。

playwrightOptions: {
  clientCertificates: [
    {
      origin: 'https://example.com',
      certPath: './cert.pem',
      keyPath: './key.pem',
      passphrase: 'mysecretpassword',
    },
    {
      origin: 'https://example.com',
      cert: Buffer.from("-----BEGIN CERTIFICATE-----\n..."),
      key: Buffer.from("-----BEGIN RSA PRIVATE KEY-----\n..."),
      passphrase: 'mysecretpassword',
    }
  ],
}

使用 Synthetics 监控 UI 时，cert、key 和 pfx 可以简单地使用字符串文字指定。

clientCertificates: [
  {
    cert: "-----BEGIN CERTIFICATE-----\n...",
    // Not cert: Buffer.from("-----BEGIN CERTIFICATE-----\n..."),
  }
],

超时

编辑

Playwright 有两种在 Elastic Synthetics 中使用的超时类型：操作和导航超时。

Elastic Synthetics 使用 50 秒的默认操作和导航超时。您可以使用 playwrightOptions 中的 actionTimeout 和 navigationTimeout 覆盖此默认值。

时区和区域设置

编辑

Elastic 全局托管测试基础设施目前未设置时区。对于私有位置，监控将使用运行 Elastic 代理的主机的时区。如果您想测试 Web 应用程序在不同时区中的行为，这并不总是理想的。要指定监控运行时要使用的时区，可以在每个监控或全局范围内使用 playwrightOptions。

要为项目中的所有监控使用时区和/或区域设置，请在配置文件中设置 locale 和/或 timezoneId。

playwrightOptions: {
  locale: 'en-AU',
  timezoneId: 'Australia/Brisbane',
}

要为特定监控使用时区和/或区域设置，请使用 monitor.use 将这些选项添加到旅程中。

设备模拟

编辑

用户可以使用配置文件模拟移动设备。以下示例配置在“Pixel 5”模拟模式下运行测试。

import { SyntheticsConfig } from "@elastic/synthetics"
import { devices } from "playwright-chromium"

const config: SyntheticsConfig = {
  playwrightOptions: {
    ...devices['Pixel 5']
  }
}

export default config;

`project`

编辑

关于项目的信息。

id (string)

与您的项目关联的唯一 ID。它将用于逻辑上对监控进行分组。

如果您使用 init 创建项目，这就是您指定的 <name-of-project>。

url (string)

要将监控上传到的部署的 Kibana URL。

space (string)

目标 Kibana 空间的标识符，用于推送监控。空间有助于您组织推送的监控。如果未指定，则推送至“default”空间。

`monitor`

编辑

使用 @elastic/synthetics push 命令时应用于所有监控的默认值。

id (string)

此监控的唯一标识符。

name (string)

监控的可读名称。

tags (Array<string>)

将与监控事件一起发送的标签列表。标签显示在 Synthetics 应用程序中，并允许您按标签搜索监控。

schedule (number)

监控应运行的间隔（以分钟为单位）。

enabled (boolean)

启用或禁用监控运行，无需删除和重新创建。

locations (Array<SyntheticsLocationsType>)

监控的部署位置。监控可以部署在多个位置，以便您可以检测这些位置的可用性和响应时间差异。

要列出可用位置，您可以：

运行 elastic-synthetics locations 命令。
在全局搜索字段中查找 Synthetics 并单击 创建监控。位置将列在位置中。

privateLocations (Array<string>)

将部署监控的私有位置。这些私有位置是指您托管和管理的位置，而 locations 是由 Elastic 托管的。您可以使用位置的名称指定私有位置。

要列出可用的私有位置，您可以：

运行 elastic-synthetics locations 命令，并使用要从中获取可用位置的部署的 Kibana URL。
在全局搜索字段中查找 Synthetics 并单击 创建监控。私有位置将列在位置中。

throttling (boolean | ThrottlingOptions)

控制监控的下载速度、上传速度和延迟，以模拟您的应用程序在速度较慢或延迟较高的网络上的行为。设置为 false 可完全禁用节流。

screenshot (ScreenshotOptions)

控制是否捕获屏幕截图。选项包括 'on'、'off' 或 'only-on-failure'。

alert.status.enabled (boolean)

启用或禁用监控状态警报。有关警报的更多信息，请阅读警报。

retestOnFailure (boolean)

启用或禁用监控失败时的重新测试。默认值为 true。

默认情况下，如果监控从“正常”变为“异常”，则会自动重新测试监控。如果重新测试的结果也是“异常”，则会创建一个错误，如果已配置，则会发送警报。然后，监控将根据定义的计划恢复运行。retestOnFailure 可减少与瞬态问题相关的噪音。

fields (object)

将与每个监控事件一起发送的键值对列表。fields 附加到 Elasticsearch 文档作为 labels，这些标签显示在 Kibana 中的单个监控的概述选项卡的监控详细信息面板中。

例如：

fields: {
  foo: 'bar',
  team: 'synthetics',
}

有关单独配置监控的信息，请参考：

配置单个浏览器监控（适用于浏览器监控）
配置轻量级监控（适用于轻量级监控）

« 使用 Synthetics 命令行界面浏览器监控的多因素身份验证 (MFA) »