验证响应数据

本文档介绍了如何配置拨测来验证 HTTP 响应代码和受检资源发送的响应数据。默认情况下，HTTP 拨测会验证响应代码是否为 2xx。此外，默认情况下，响应数据未经过验证。不过，您可以修改这些设置。例如，您可以将 HTTP 拨测配置为接受 2xx 和 3xx 响应代码。对于所有拨测，您都可以指定一个值，为确保拨测成功，响应数据必须包含或不必须包含该值。

如何验证响应数据

您可以将 Cloud Monitoring 配置为在创建或修改拨测时验证来自已检查资源的响应数据。

Google Cloud 控制台

如需创建正常运行时间检查以验证响应数据，请执行以下操作：

1. 在 Google Cloud 控制台中，转到  拨测页面：

   前往拨测

   如果您使用搜索栏查找此页面，请选择子标题为监控的结果。

2. 点击 Create Uptime check。
3. 输入标题，然后点击下一步。
4. 输入目标，然后点击下一步。

5. 配置响应验证：

   • 如需验证响应数据，请确保显示已启用内容匹配，然后填写与响应验证相关的字段。如需了解这些选项，请参阅本文档的下一部分。
   • 对于 HTTP 拨测，请配置可接受的响应代码。默认情况下，HTTP 拨测会将任何 2xx 响应标记为成功响应。

6. 点击 Next，然后完成拨测配置。

Cloud Monitoring API

如需配置拨测以验证响应数据，请填充 UptimeCheckConfig 对象的 contentMatchers 数组。

ContentMatcher 对象包含以下字段：

• matcher：描述如何执行比较。如需查看值列表，请参阅 ContentMatcherOption。

  请勿使用 CONTENT_MATCHER_OPTION_UNSPECIFIED 值。

• content：存储要在响应数据中搜索的值。该值是字符串字面量或正则表达式。

• jsonPathMatcher：存储 JsonPathMatcher 对象，描述要搜索的 JSONpath 以及如何执行比较。

  除非拨测正在验证特定的 JSONpath，否则请省略此字段。

本文档的其余部分介绍了如何使用内容匹配选项。

用于验证响应数据的选项

本部分介绍了可用于验证已检查资源所发送响应的字符串匹配策略。对于每个策略，您需要指定一个值，并确定在响应数据中找到该值是导致拨测通过还是失败。

系统可能不会搜索已检查的资源的完整响应：

• HTTP 和 HTTPS 拨测：搜索前 4 MB。
• TCP 拨测：搜索前 1 MB。

搜索字面量子字符串

Google Cloud 控制台

如需将拨测配置为在响应数据包含字面量子字符串时通过，请使用以下设置：

1. 在响应内容匹配类型菜单中选择包含。
2. 在响应内容字段中输入字面量子字符串。
3. 如需验证配置，请点击 Test。

如需将正常运行时间检查配置为在响应数据包含文字子字符串时失败，请使用以下设置：

1. 在响应内容匹配类型菜单中选择不包含。
2. 在响应内容字段中输入字面量子字符串。
3. 如需验证配置，请点击 Test。

Cloud Monitoring API

如需将拨测配置为在响应数据包含字面量子字符串时通过，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the string to be matched.",
      "matcher": "CONTAINS_STRING"
    }
],
...

如需将正常运行时间检查配置为在响应数据包含字面量子字符串时失败，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the string to be matched.",
      "matcher": "NOT_CONTAINS_STRING"
    }
],
...

下表显示了不同响应数据、测试字符串和测试类型的正常运行时间检查状态：

		拨测状态
响应数据	测试字符串	包含	不包含
abcd	abcd	通过	未通过
abc	abcd	未通过	通过
abc	a	通过	未通过
Uptime Checks	Uptime	通过	未通过
Uptime Checks	uptime	未通过	通过

在上表中，响应数据列描述了已检查的资源返回的数据，而测试字符串列则列出了字符串字面量。接下来的两列指定测试的类型和拨测的结果。

使用正则表达式进行搜索

Google Cloud 控制台

如需将正常运行时间检查配置为在响应数据与正则表达式匹配时通过，请使用以下设置：

1. 在响应内容匹配类型菜单中选择匹配正则表达式。
2. 在响应内容字段中输入正则表达式。
3. 如需验证配置，请点击 Test。

如需将正常运行时间检查配置为在响应数据与正则表达式匹配时失败，请使用以下设置：

1. 在响应内容匹配类型菜单中选择与正则表达式不匹配。
2. 在响应内容字段中输入正则表达式。
3. 如需验证配置，请点击 Test。

Cloud Monitoring API

如需将正常运行时间检查配置为在响应数据与正则表达式匹配时通过，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the regular expression to be matched.",
      "matcher": "MATCHES_REGEX"
    }
],
...

如需将正常运行时间检查配置为在响应数据与正则表达式匹配时失败，请使用以下值：

...
"contentMatchers": [
    {
      "content": "Set to the regular expression to be matched.",
      "matcher": "NOT_MATCHES_REGEX"
    }
],
...

下表显示了不同响应数据、正则表达式和测试类型的正常运行时间检查状态：

		拨测状态
响应数据	正则表达式	匹配正则表达式	与正则表达式不匹配
abcd	abcd	通过	未通过
Uptime Checks	[uU]ptime	通过	未通过
Uptime Checks	[a-z]{6}	未通过	通过
Uptime Checks	[a-zA-Z]{6}	通过	未通过

在上表中，响应数据列描述了已检查的资源返回的数据，而正则表达式列列出了正则表达式。接下来的两列指定测试的类型和拨测的结果。

搜索 JSON 响应中的特定字段

您可以配置拨测来验证 JSONpath。选择 JSONpath 测试时，该测试会将路径值与数字、字符串字面量或正则表达式进行比较：

• 将 JSONpath 与数字或字符串字面量进行比较
• 将 JSONpath 与正则表达式进行比较

指定 JSONpath 时，必须使用 $. 指定根对象，然后在该对象后面使用特定的字段标识符。当 JSON 响应包含元素数组时，请使用英文括号 [] 来确定要匹配的特定数组元素。以下示例说明了路径语法：

• $.type 匹配根对象的 type 字段。
• $.[0].address.city 与存储在 JSON 响应的第一个数组元素中的 address 对象中的 city 字段匹配。
• $.content[0].phone 匹配 content 字段的第一个数组元素的 phone 字段。content 字段是根对象的子项。

您可以将正常运行时间测试配置为匹配多个字段。请考虑以下 JSON：

[
  {
    ...
    "address": {
      ...
      "city": "Gwenborough",
      "geo": {
        "lat": "-37.3159",
        "lng": "81.1496"
      }
    },
  },
  ...
]

如需匹配第一个数组元素中 geo 字段的整个路径，请将 JSONpath 设置为 $.[0].address.geo，并在内容字段中输入完整值：

{
  "lat": "-37.3159",
  "lng": "81.1496"
}

如果您有兴趣试用这些选项，请查找一个会返回 JSON 响应的公开网站。如需查看示例，请参阅 JSON 测试。

将 JSONpath 与数字或字符串字面量进行比较

Google Cloud 控制台

注意 ：在响应内容字段中，您可以输入数字、布尔值 true 和 false 以及字符串。要匹配，您输入的值必须与拨测收到的响应一致。例如，您可以输入布尔值 true、数字 5 或字符串，如 "true"、"5" 或 "hello"。

如需将正常运行时间检查配置为在响应数据中的特定 JSONpath 与字符串字面量匹配时通过，请使用以下设置：

1. 在响应内容匹配类型菜单中选择 Matches at JSONPath。
2. 在 JSONPath 字段中输入路径。
3. 在响应内容字段中输入数字或字符串字面量。
4. 如需验证配置，请点击 Test。

如需将正常运行时间检查配置为在响应数据中的特定 JSONpath 与字符串字面量匹配时失败，请使用以下设置：

1. 在响应内容匹配类型菜单中选择与 JSONPath 不匹配。
2. 在 JSONPath 字段中输入路径。
3. 在响应内容字段中输入数字或字符串字面量。
4. 如需验证配置，请点击 Test。

Cloud Monitoring API

注意 ：由于 "content" 字段的值必须是字符串，因此必须使用英文引号将值引起来。当值是字符串时，您必须对内部引号进行转义。例如，如需匹配布尔值 true，请将值设置为 "true"。同样，如要匹配数字 5，请将值设置为 "5"。最后，如需匹配字符串 "5"，请输入 "\"5\""。

如需将拨测配置为在 JSON 格式的响应中的特定字段与数字或字符串字面量匹配时通过，请对 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to a number, a boolean, or the string to be matched.",
       "matcher" : "MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "EXACT_MATCH"
    }
],
...

如需将拨测配置为在 JSON 格式的响应中的特定字段与数字或字符串字面量匹配时失败，请对 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to a number, a boolean, or the string to be matched.",
       "matcher" : "NOT_MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "EXACT_MATCH"
    }
],
...

为了说明 JSONpath 字符串匹配测试的运行方式，请考虑以下 JSON 响应数据：

{
    "name": "Sample Uptime Check",
    "type": "JSONpath",
    "content": [
        {
            "id": 1,
            "phone": "1234567890",
            "alias": "Exact",
            "enabled": true,
        },
        {
            "id": 2,
            "phone": "1234512345",
            "alias": "Regex",
            "enabled": false,
        }
    ]
}

下表显示了上一个响应的拨测状态，但不同路径、测试值和测试类型有所不同：

		拨测状态
JSONpath	测试值	JSONpath 匹配	JSONpath 不匹配
$.type	"JSONpath"	通过	未通过
$.name	"Sample"	未通过	通过
$.name	"Sample Uptime Check"	通过	未通过
$.content[0].id	1	通过	未通过
$.content[0].alias	"Exact"	通过	未通过
$.content[0].enabled	true	通过	未通过

在上表中，JSONpath 列标识了要测试的元素，Test value 列列出了该值。接下来的两列指定测试的类型和拨测的结果。

将 JSONpath 与正则表达式进行比较

正则表达式匹配支持匹配字符串、数字、布尔值和 null JSON 值。

注意 ：您输入的表达式必须与 JSONpath 的整个值匹配。例如，如果某个字段的值为 "North Pole"，则 .*North.* 和 ^North.* 与该字段匹配，而 North 和 "North" 不匹配。

Google Cloud 控制台

如需将正常运行时间检查配置为在响应数据中的特定 JSONpath 与正则表达式匹配时通过，请使用以下设置：

1. 在响应内容匹配类型菜单中选择 Matches at JSONPath。
2. 在 JSONPath 字段中输入路径。
3. 在响应内容字段中输入正则表达式。
4. 如需验证配置，请点击 Test。

如需将正常运行时间检查配置为在响应数据中的特定 JSONpath 与正则表达式匹配时失败，请使用以下设置：

1. 在响应内容匹配类型菜单中选择与 JSONPath 不匹配。
2. 在 JSONPath 字段中输入路径。
3. 在响应内容字段中输入正则表达式。
4. 如需验证配置，请点击 Test。

Cloud Monitoring API

如需将拨测配置为在 JSON 格式的响应中的特定字段与正则表达式匹配时通过，请为 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to the regular expression to be matched."
       "matcher" : "MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "REGEX_MATCH"
    }
],
...

如需将正常运行时间检查配置为在 JSON 格式的响应中的特定字段与正则表达式匹配时失败，请对 ContentMatcher 对象使用以下值：

...
"contentMatchers": [
    {
       "content" : "Set to the regular expression to be matched.",
       "matcher" : "NOT_MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "REGEX_MATCH"
    }
],
...

为了说明 JSONpath 正则表达式测试的运行方式，请考虑以下 JSON 响应数据：

{
    "name": "Sample Uptime Check",
    "type": "JSONpath",
    "content": [
        {
            "id": 1,
            "phone": "1234567890",
            "alias": "Exact",
            "enabled": true,
        },
        {
            "id": 2,
            "phone": "1234512345",
            "alias": "Regex",
            "enabled": false,
        }
    ]
}

下表显示了上一个响应（但针对不同路径、正则表达式和测试类型的）拨测状态：

		拨测状态
JSONpath	正则表达式	JSONpath 与正则表达式匹配	JSONpath 与正则表达式不匹配
$.type	[A-Z]{4}Path	通过	未通过
$.name	Sample	未通过	通过
$.name	.*Sample.*	通过	未通过
$.content[1].id	2	通过	未通过
$.content[1].phone	"[12345]{2}"	通过	未通过
$.content[1].enabled	f.*	通过	未通过

在上表中，JSONpath 列确定要测试的元素，Regex 列列出了正则表达式。接下来的两列指定测试的类型和拨测的结果。

后续步骤

• 创建拨测
• 管理拨测
• 为拨测创建提醒政策