创建合成监控工具

控制台

当您使用 Google Cloud 控制台创建合成监控工具时，系统会部署一个新的 Cloud Function（第 2 代），并创建该 Cloud Function 的监控工具。您无法创建监控现有 Cloud Function 的合成监控工具。

1. 请确保您已启用所需的 API，您的项目包含默认的 Compute Engine 服务帐号，并且此帐号已被授予 Editor 角色 (roles/editor)。如需了解详情，请参阅准备工作。

2. 在 Google Cloud 控制台中，前往  综合监控页面：

   前往合成监控

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

3. 选择创建合成监控工具。

4. 为您的 Cloud Function 选择模板：

   • 自定义合成监控工具：如果您要收集出站 HTTP 请求的日志数据或跟踪数据，请使用此模板。

   • Mocha 合成监控工具：在编写 Mocha 测试套件时使用此模板。

   • 损坏的链接检查工具：使用此模板测试一个 URI 以及在该 URI 中找到的可配置数量的链接。如需了解此检查工具的字段，请参阅创建损坏链接检查工具。

5. 输入显示器的名称。

6. 可选：更新响应超时和检查频率，并添加用户定义的标签。

7. 执行下列其中一项操作：

   • 如果您有权在此项目中使用 Gemini Code Assist，并且需要代码编写方面的帮助，请点击帮我编写代码。 此功能目前为公开预览版。 如需有关提示的指导，请参阅了解如何为合成监控工具编写提示。

     如果您对代码感到满意，请点击插入 Cloud Functions 函数。

   • 点击创建函数。

8. 在 Cloud Function 对话框中，执行以下操作：

   1. 输入显示名称并选择区域。名称在一个区域内必须是唯一的。

   2. 在运行时、构建、连接和安全设置部分中，执行以下操作：

      • 查看默认设置并根据需要进行更新。

      • 在运行时服务帐号字段中，选择一个服务帐号。

   3. 修改生成的代码，或为您的 Cloud Function 编写或上传代码：

      • 如需修改生成的代码，请输入您自己的代码或加载默认示例函数，请选择内嵌编辑器。示例函数（取决于您之前选择的模板）会向特定网址发送请求。您可以修改默认函数。

      • 如需从本地系统加载 ZIP 文件，请选择 ZIP 上传。

        如果您从本地系统上传 ZIP 文件，则还必须为 ZIP 文件指定 Cloud Storage 存储桶。如果您没有合适的 Cloud Storage 存储桶，请创建一个。

      • 如需从 Cloud Storage 加载 ZIP 文件，请选择 ZIP from Cloud Storage，选择存储桶，然后选择要加载的 ZIP 文件。

        您还可以使用 Google Cloud 控制台中的 Cloud Functions 页面创建 Cloud Function。如需创建用于监控该 Cloud Function 副本的合成监控工具，请转到来源标签页，然后点击下载 zip 文件。然后，您就可以上传该 ZIP 文件了。

   4. 点击应用函数。

9. 配置提醒政策：

   1. 可选：在发送通知之前更新提醒政策名称和失败时长。

   2. 添加通知渠道。

10. 点击创建。

    您定义的 Cloud Functions 函数将作为第 2 代进行构建和部署，并创建合成监控工具。

gcloud

使用 Google Cloud CLI 或 Cloud Monitoring API 创建合成监控工具时，您需要将函数名称传递给 API 调用。因此，您只能创建用于监控现有 Cloud Function 的合成监控工具。

1. 请确保您已启用所需的 API，您的项目包含默认的 Compute Engine 服务帐号，并且此帐号已被授予 Editor 角色 (roles/editor)。如需了解详情，请参阅准备工作。
2. 编写和部署您的第 2 代 Cloud Function。

   例如，如需在 Google Cloud/synthetics-sdk-nodejs 代码库中部署 synthetics-sdk-nodejs 示例，请执行以下操作：

   1. 克隆代码库并转到源代码的位置：

      git clone http://github.com/GoogleCloudPlatform/synthetics-sdk-nodejs.git
      cd synthetics-sdk-nodejs/samples/generic-synthetic-nodejs
      

   2. 使用 gcloud functions deploy 命令部署 Cloud Function：

      gcloud functions deploy FUNCTION_NAME \
      --gen2 --region="us-west2" --source="." \
      --entry-point=SyntheticFunction --trigger-http --runtime=nodejs18
      

      在 gcloud functions deploy 命令中，执行以下操作：

      • 确保 FUNCTION_NAME 字段的值在其部署区域内是唯一的。

      • 添加 --gen2 标志并设置部署区域。

      • 按如下方式设置 --entry-point 字段：

        • Mocha：SyntheticMochaSuite
        • 不是 Mocha：SyntheticFunction。

      • 将 --runtime 字段设置为 nodejs18。

      • 添加 --trigger-http 标志。

      • 如果您不想使用允许所有流量的默认设置，请设置 --ingress-settings 字段。

      Cloud Functions 函数构建并部署您的 Cloud Function。 Google Cloud CLI 命令的结果包含该函数的相关信息，其中包括其完全限定名称：

      name: projects/PROJECT_ID/locations/REGION/functions/FUNCTION_NAME
      

      如需详细了解如何部署函数，请参阅部署 Cloud Functions 函数。

   如需列出 Google Cloud 项目中的 Cloud Functions 函数，请使用 gcloud functions list 命令：

   gcloud functions list
   

   此调用的响应是一个列表条目，每个条目都列出了一个 Cloud Function：

   NAME: function-1
   STATE: ACTIVE
   TRIGGER: HTTP Trigger
   REGION: us-west2
   ENVIRONMENT: 2nd gen
   

   如需查找特定 Cloud Function 的完全限定名称，请运行 gcloud monitoring uptime describe 命令。

3. 如需创建合成监控工具，请运行 gcloud monitoring uptime create 命令：

   gcloud monitoring uptime create DISPLAY_NAME --synthetic-target=TARGET
   

   在运行上一个命令之前，请执行以下操作：

   • 将 DISPLAY_NAME 替换为您的合成监控工具的名称。
   • 将 TARGET 替换为您的 Cloud Function 的完全限定名称。

4. 创建提醒政策。

   鉴于提醒政策配置的复杂性，我们建议您前往 Google Cloud 控制台中的合成监控工具页面，并使用其中的选项创建提醒政策。使用这种方法，系统会为您填充大多数提醒政策字段。如需使用 Google Cloud 控制台创建提醒政策，请点击合成监控页面中的创建政策。

   如果您打算使用 Google Cloud CLI 或 Cloud Monitoring API，请按如下方式配置条件的过滤条件：

   "filter": "resource.type = \"cloud_run_revision\" AND
               metric.type = \"monitoring.googleapis.com/uptime_check/check_passed\" AND
               metric.labels.check_id = \"CHECK_ID\"",
   

   该条件会监控合成监控工具写入的 uptime_check/check_passed 时序。请务必将 CHECK_ID 替换为合成监控工具的标识符，并且该标识符包含在 create 命令的响应数据中。

   如需了解如何创建提醒政策，请参阅使用 API 创建提醒政策。

API

使用 Google Cloud CLI 或 Cloud Monitoring API 创建合成监控工具时，您需要将函数名称传递给 API 调用。因此，您只能创建用于监控现有 Cloud Function 的合成监控工具。

1. 请确保您已启用所需的 API，您的项目包含默认的 Compute Engine 服务帐号，并且此帐号已被授予 Editor 角色 (roles/editor)。如需了解详情，请参阅准备工作。
2. 编写和部署您的第 2 代 Cloud Function。

   例如，如需在 Google Cloud/synthetics-sdk-nodejs 代码库中部署 synthetics-sdk-nodejs 示例，请执行以下操作：

   1. 克隆代码库并转到源代码的位置：

      git clone http://github.com/GoogleCloudPlatform/synthetics-sdk-nodejs.git
      cd synthetics-sdk-nodejs/samples/generic-synthetic-nodejs
      

   2. 使用 gcloud functions deploy 命令部署 Cloud Function：

      gcloud functions deploy FUNCTION_NAME \
      --gen2 --region="us-west2" --source="." \
      --entry-point=SyntheticFunction --trigger-http --runtime=nodejs18
      

      在 gcloud functions deploy 命令中，执行以下操作：

      • 确保 FUNCTION_NAME 字段的值在其部署区域内是唯一的。

      • 添加 --gen2 标志并设置部署区域。

      • 按如下方式设置 --entry-point 字段：

        • Mocha：SyntheticMochaSuite
        • 不是 Mocha：SyntheticFunction。

      • 将 --runtime 字段设置为 nodejs18。

      • 添加 --trigger-http 标志。

      • 如果您不想使用允许所有流量的默认设置，请设置 --ingress-settings 字段。

      Cloud Functions 函数构建并部署您的 Cloud Function。 Google Cloud CLI 命令的结果包含该函数的相关信息，其中包括其完全限定名称：

      name: projects/PROJECT_ID/locations/REGION/functions/FUNCTION_NAME
      

      如需详细了解如何部署函数，请参阅部署 Cloud Functions 函数。

   如需列出 Google Cloud 项目中的 Cloud Functions 函数，请使用 gcloud functions list 命令：

   gcloud functions list
   

   此调用的响应是一个列表条目，每个条目都列出了一个 Cloud Function：

   NAME: function-1
   STATE: ACTIVE
   TRIGGER: HTTP Trigger
   REGION: us-west2
   ENVIRONMENT: 2nd gen
   

   如需查找特定 Cloud Function 的完全限定名称，请运行 gcloud monitoring uptime describe 命令。

3. 如需创建合成监控工具，请执行以下操作：

   1. 点击 projects.uptimeCheckConfigs.create 以打开该方法的 API 参考文档页面。
   2. 点击试用以打开 API Explorer。

   3. 设置以下字段，然后运行命令。

      • 父字段：projects/PROJECT_ID。

      • 在请求正文中，指定以下内容：

        • displayName：设置为合成监控工具的显示名称。
        • syntheticMonitor：设置为 Cloud Function 的完全限定名称。

      成功后，API 调用的响应类似于以下内容：

      {
      "name": "projects/myproject/uptimeCheckConfigs/17272586127463315332",
      "displayName": "MyMonitor",
      ...
      "syntheticMonitor": {
       "cloudFunctionV2": {
          "name": "projects/myproject/locations/us-west2/functions/function-1",
          "cloudRunRevision": {
          "type": "cloud_run_revision",
          "labels": {
             "project_id": "myproject",
             "configuration_name": "",
             "location": "us-west2",
             "revision_name": "",
             "service_name": "function-1"
          }
          }
       }
      }
      }
      

4. 创建提醒政策。

   鉴于提醒政策配置的复杂性，我们建议您前往 Google Cloud 控制台中的合成监控工具页面，并使用其中的选项创建提醒政策。使用这种方法，系统会为您填充大多数提醒政策字段。如需使用 Google Cloud 控制台创建提醒政策，请点击合成监控页面中的创建政策。

   如果您打算使用 Google Cloud CLI 或 Cloud Monitoring API，请按如下方式配置条件的过滤条件：

   "filter": "resource.type = \"cloud_run_revision\" AND
               metric.type = \"monitoring.googleapis.com/uptime_check/check_passed\" AND
               metric.labels.check_id = \"CHECK_ID\"",
   

   该条件会监控合成监控工具写入的 uptime_check/check_passed 时序。请务必将 CHECK_ID 替换为合成监控工具的标识符，并且该标识符包含在 create 命令的响应数据中。

   如需了解如何创建提醒政策，请参阅使用 API 创建提醒政策。

Terraform

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。 如需了解详情，请参阅 Terraform 提供程序参考文档。

如需创建合成监控工具和提醒政策来监控该检查，请执行以下操作：

1. 请确保您已启用所需的 API，您的项目包含默认的 Compute Engine 服务帐号，并且此帐号已被授予 Editor 角色 (roles/editor)。如需了解详情，请参阅准备工作。

2. 修改 Terraform 配置文件并添加 google_storage_bucket 资源，然后应用您的更改。

   以下代码在 US 位置定义了一个 Cloud Storage 存储桶：

   resource "google_storage_bucket" "gcf_source" {
      name = "gcf-v2-source-9948673986912-us"
      location = "US"
      uniform_bucket_level_access = true
   }
   

3. 修改 Terraform 配置文件并添加 google_storage_bucket_object 资源，然后应用更改。

   该资源指定了存储桶中对象的名称，以及 ZIP 文件在本地系统上的位置。例如，当您应用以下代码时，名为 example-function.zip 的文件会添加到您的存储桶中：

   resource "google_storage_bucket_object" "object" {
      name = "example-function.zip"
      bucket = google_storage_bucket.gcf_source.name
      source = "generic-synthetic-node.js.zip"
   }
   

4. 修改 Terraform 配置文件并添加 google_cloudfunctions2_function 资源，然后应用更改。

   确保您的 google_cloudfunctions2_function 资源指定了 Node.js 运行时和合成监控工具使用的入口点。例如，当您应用以下代码时，系统会部署一个名为 sm-central1 的函数：

   resource "google_cloudfunctions2_function" "central1" {
      name = "sm-central1"
      location = "us-central1"
   
      build_config {
         runtime = "nodejs20"
         entry_point = "SyntheticFunction"
         source {
               storage_source {
                  bucket = google_storage_bucket.gcf_source.name
                  object = google_storage_bucket_object.object.name
               }
         }
      }
   
      service_config {
         max_instance_count = 1
         available_memory = "256Mi"
         timeout_seconds  = 60
      }
   }
   

5. 如需创建合成监控工具，请修改 Terraform 配置文件并添加 google_monitoring_uptime_check_config 资源，然后应用更改。

   对于此资源，请指定 synthetic_monitor 块：

   resource "google_monitoring_uptime_check_config" "synthetic" {
      display_name = "sm-central1"
      timeout = "30s"
   
      synthetic_monitor {
         cloud_function_v2 {
               name = google_cloudfunctions2_function.central1.id
         }
      }
   }
   

6. 可选：创建通知渠道和提醒政策。

   以下步骤使用 Google Cloud 控制台创建通知渠道和提醒政策。此方法可确保提醒政策仅监控合成监控工具生成的数据。

   1. 如需创建通知渠道，请执行以下操作：

      1. 在 Google Cloud 控制台中，转到 notifications 提醒页面：

         进入提醒

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

      2. 选择管理通知渠道。
      3. 转到您要添加的渠道类型，点击添加，然后完成对话框。

   2. 如需创建提醒政策，请执行以下操作：

      1. 在 Google Cloud 控制台中，前往  综合监控页面：

         前往合成监控

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

      2. 找到您的合成监控工具，选择 more_vert 更多，然后选择添加提醒政策。
      3. 在对话框中，转到通知和名称部分，展开通知渠道，然后选择相应的选项。
      4. 为提醒政策命名，然后点击创建政策。