配置 BigQuery 通知

Cloud Build 可以通过向您的所需渠道（例如 Slack 或 SMTP 服务器）发送通知来通知您构建更新。本页介绍如何使用 BigQuery 通知程序配置通知。

BigQuery 通知程序允许您指定要存储在数据库中的构建的过滤条件。例如，您可以按触发器 ID、标记或替换值对构建进行分组。此外，BigQuery 通知程序还会以标准化格式将数据写入 BigQuery，包括无法在构建对象上立即访问的计算字段，例如图片大小或执行时长。如需了解如何将日志条目导出到 BigQuery 或其他目标位置，请参阅使用 Google Cloud 控制台导出日志。

准备工作

• Enable the Cloud Build, Cloud Run, Pub/Sub, and BigQuery APIs.

  Enable the APIs

• 安装 Google Cloud CLI。

配置 BigQuery 通知

以下部分介绍如何使用 BigQuery 通知程序来手动配置 HTTP 通知。如果您希望改为自动配置，请参阅自动配置通知。

如需配置 BigQuery 通知，请执行以下操作：

1. 向 Cloud Run 服务账号授予创建和写入 BigQuery 表的权限，获取与构建相关的 Artifact Registry 数据的权限，以及 Cloud Storage 存储分区的读写权限：

   1. 转到 Google Cloud 控制台中的 IAM 页面：

      打开 IAM 页面

   2. 找到与您的项目关联的 Compute Engine 默认服务账号：

      您的 Compute Engine 默认服务账号将如下所示：

      [e-mail]
      

   3. 点击您的 Compute Engine 默认服务账号所在行中的铅笔图标。您会看到修改访问权限标签页。

   4. 点击添加其他角色。

   5. 添加以下角色：

      • Artifact Registry Reader
      • BigQuery Data Editor
      • Storage Object Viewer

      借助 Artifact Registry Reader 角色，您可以针对映像提取数据。BigQuery Data Editor 为您提供数据的读写访问权限。 Storage Object Viewer 为您提供对 Cloud Storage 的读取权限 对象的操作。

      注意：如果您要在存储分区级层而不是项目级层授予权限，请在创建存储分区时向其添加 Storage Legacy Object Owner 角色。如需了解详情，请参阅项目级层角色与存储分区级层角色。

   6. 点击保存。

2. 编写通知程序配置文件以配置您的 BigQuery 通知程序并过滤构建事件：

   在以下示例通知程序配置文件中，filter 字段使用通用表达式语言和变量 build 来过滤具有指定触发器 ID 的构建事件：

   apiVersion: cloud-build-notifiers/v1
   kind: BigQueryNotifier
   metadata:
     name: example-bigquery-notifier
   spec:
     notification:
       filter: build.build_trigger_id == "123e4567-e89b-12d3-a456-426614174000"
       params:
         buildStatus: $(build.status)
       delivery:
         table: projects/project-id/datasets/dataset-name/tables/table-name
       template:
         type: golang
         uri: gs://example-gcs-bucket/bq.json
   

   其中：

   • buildStatus 是用户定义的参数。此参数采用 ${build.status} 的值，即 build 的状态。
   • project-id 是您的 Google Cloud 项目的 ID。
   • dataset-name 是您要为数据集指定的名称。
   • table-name 是您要为表指定的名称。

   • uri 字段引用 bq.json 文件。此文件引用托管在 Cloud Storage 上的 JSON 模板，表示要插入 BigQuery 表中的信息。

     实验性 — Customizing notifications using templates

     此功能须遵守服务专用条款的“通用服务条款”部分中的“非正式版产品条款”。 非正式版功能“按原样”提供，可能只能获得有限的支持。 如需了解详情，请参阅发布阶段说明。

   如需查看模板文件示例，请参阅 cloud-build-notifiers 代码库中的 bq.json 文件。

   通知程序配置文件中的 table-name 可以参考：

   • 不存在的表
   • 没有架构的空表

   • 具有与 BigQuery 通知程序中的架构规范匹配的架构的现有表

     注意：引用其架构规范与 BigQuery 通知程序不匹配的现有表会导致错误。

   建议您将构建触发器 ID 指定为过滤条件，因为通过指定构建触发器 ID，您可以关联触发器的构建数据。您还可以在列表中指定多个触发器 ID：build.build_trigger_id in ["example-id-123", "example-id-456"]。

   要获取触发器 ID，请运行以下命令，其中 trigger-name 是触发器的名称。

   gcloud builds triggers describe trigger-name

   该命令将列出与触发器关联的字段，包括触发器 ID。

   注意：系统只会存储具有终端状态（例如 SUCCESS 或 FAILURE）的构建事件的数据。

   如需查看此示例，请参阅 BigQuery 通知程序的通知程序配置文件。

   如需了解可用于过滤的其他字段，请参阅构建资源。如需了解其他过滤示例，请参阅使用 CEL 过滤构建事件。

3. 将通知程序配置文件上传到 Cloud Storage 存储分区

   1. 如果没有 Cloud Storage 存储分区，请运行以下命令创建一个存储分区，其中 bucket-name 是您想要为存储分区指定的名称（须遵循命名要求部分）。

      gcloud storage buckets create gs://bucket-name/
      

   2. 将通知程序配置文件上传到您的存储分区：

      gcloud storage cp config-file-name gs://bucket-name/config-file-name
      

      其中：

      • bucket-name 是您的存储分区的名称。
      • config-file-name 是通知程序配置文件的名称。

4. 将通知程序部署到 Cloud Run：

    gcloud run deploy service-name \
      --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/bigquery:latest \
      --no-allow-unauthenticated \
      --update-env-vars=CONFIG_PATH=config-path,PROJECT_ID=project-id
   

   其中：

   • service-name 是您要将映像部署到的 Cloud Run 服务的名称。

     注意： service-name 会引用 的内容。

   • config-path 是 SMTP 通知程序 gs://bucket-name/config-file-name 的配置文件的路径。

   • project-id 是您的 Google Cloud 项目的 ID。

   gcloud run deploy 命令会从 Artifact Registry 中拉取构建的映像的最新版本。Cloud Build 支持通知程序映像 9 个月。9 个月后，Cloud Build 会删除映像版本。如果您想使用旧的映像版本，则需要在 gcloud run deploy 命令的 image 属性中指定映像标记的完整语义版本。您可以在 Artifact Registry 中找到以前的映像版本和标记。

   注意：运行此命令时，系统可能会提示您指定其他参数，例如 --region 或 --platform。如需详细了解可传递给 gcloud run deploy 命令的参数，请参阅部署到 Cloud Run。如果您无法使用此命令部署通知程序，请参阅 Cloud Run 问题排查指南，了解有关如何解决部署错误的解决方案。

5. 授予 Pub/Sub 在项目中创建身份验证令牌的权限：

    gcloud projects add-iam-policy-binding project-id \
      --member=serviceAccount:[e-mail] \
      --role=roles/iam.serviceAccountTokenCreator
   

   其中：

   • project-id 是您的 Google Cloud 项目的 ID。
   • project-number 是您的 Google Cloud 项目编号。
   注意：如果您的项目中不存在 Pub/Sub 服务账号，请参阅创建和使用订阅。

6. 创建一个服务账号以表示您的 Pub/Sub 订阅身份：

   gcloud iam service-accounts create cloud-run-pubsub-invoker \
     --display-name "Cloud Run Pub/Sub Invoker"
   

   您可以使用 cloud-run-pubsub-invoker或使用在您的 Google Cloud 项目中唯一的名称。

7. 向 cloud-run-pubsub-invoker 服务账号授予 Cloud Run Invoker 权限：

   gcloud run services add-iam-policy-binding service-name \
      --member=serviceAccount:[e-mail] \
      --role=roles/run.invoker
   

   其中：

   • service-name 是您要将映像部署到的 Cloud Run 服务的名称。
   • project-id 是您的 Google Cloud 项目的 ID。

8. 创建 cloud-builds 主题以接收通知程序的构建更新消息：

   gcloud pubsub topics create cloud-builds
   

9. 为通知程序创建 Pub/Sub 推送订阅者：

    gcloud pubsub subscriptions create subscriber-id \
      --topic=cloud-builds \
      --push-endpoint=service-url \
      --push-auth-service-account=[e-mail]
   

   其中：

   • subscriber-id 是您要为订阅指定的名称。
   • service-url是 Cloud Run 为新服务生成的网址。
   • project-id 是您的 Google Cloud 项目的 ID。

您的 Cloud Build 项目的通知现已设置完毕。

下次您调用构建时，系统将使用与配置给 BigQuery 通知程序的过滤条件匹配的最新数据来更新表。

查看构建数据

如需在 BigQuery 中查看构建数据，请执行以下操作：

1. 打开 BigQuery 控制台页面：

   打开 BigQuery 页面

2. 在资源下，点击用于配置 BigQuery 通知程序的项目 ID。

3. 点击您的数据集名称。

4. 点击您的表名称。

现在，您可以看到与您的表相关的信息，包括数据架构和表中列出的版本数据预览。

访问构建数据

您可以使用 bq 命令行工具或 BigQuery 控制台查询表中的数据。

CLI

如需使用 bq 命令行工具查询表中的数据，请在终端中运行以下命令，其中 sql-query 是查询：

bq query sql-query

如果您打算在此页面上使用查询示例，请确保在命令中指定 --nouse_legacy_sql 标志。bq 命令行工具使用旧版 SQL，而示例查询不使用。在终端中运行以下命令，以查询不含旧版 SQL 的数据：

bq query sql-query --nouse_legacy_sql

控制台

如需使用 BigQuery 控制台查询表中的数据，请执行以下操作：

1. 打开 BigQuery 控制台页面：

   打开 BigQuery 页面

2. 在资源下，点击要查询的表名称。

3. 在查询编辑器中编写 SQL 查询。

使用查询访问构建数据

以下示例查询展示了如何按照 BigQuery 通知程序的配置访问构建事件的构建数据：

总体构建记录

SELECT * FROM `projectID.datasetName.tableName`

按状态分组的构建计数

SELECT STATUS, COUNT(*)
FROM `projectID.datasetName.tableName`
GROUP BY STATUS

本周的每日部署频率

SELECT DAY, COUNT(STATUS) AS Deployments
FROM (SELECT DATETIME_TRUNC(CreateTime, WEEK) AS WEEK,
      DATETIME_TRUNC(CreateTime, DAY) AS DAY,
      STATUS
      FROM `projectID.datasetName.tableName`
      WHERE STATUS="SUCCESS")
WHERE WEEK = DATETIME_TRUNC(CURRENT_DATETIME(), WEEK)
GROUP BY DAY

如需查看更多示例查询，请参阅 GitHub 上的 cloud-build-notifiers 代码库中的 Cloud Build BigQuery 通知程序 README。如需详细了解如何使用 BigQuery 查询数据，请参阅查询和查看数据。

使用 CEL 过滤构建事件

Cloud Build 在构建资源中列出的字段上搭配使用 CEL 与变量 build，以便访问与构建事件关联的字段，例如触发器 ID、图片列表或替换值。您可以使用 filter 字符串，通过构建资源中列出的任何字段，来过滤通构建配置文件中的构建事件。要查找与您的字段相关的确切语法，请参阅 cloudbuild.proto 文件。

按触发器 ID 过滤

要按触发器 ID 过滤，请使用 build.build_trigger_id 在 filter 字段中指定触发器 ID 的值，其中 trigger-id 是字符串形式的触发器 ID：

filter: build.build_trigger_id == trigger-id

注意：触发器 ID 不是触发器的名称。如需获取触发器 ID，请运行以下命令：gcloud beta builds triggers describe trigger-name，其中 trigger-name 是触发器的名称。该命令将列出与触发器关联的字段，包括触发器 ID。

按状态过滤

要按状态过滤，请使用 build.status 在 filter 字段中指定要过滤的构建状态。

以下示例展示了如何使用 filter 字段过滤状态为 SUCCESS 的构建事件：

filter: build.status == Build.Status.SUCCESS

您也可以过滤具有不同状态的构建。以下示例展示了如何使用 filter 字段过滤状态为 SUCCESS、FAILURE 或 TIMEOUT 的构建事件：

filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]

要查看您可以作为过滤依据的其他状态值，请参阅“构建资源参考”下的状态。

按标记过滤

要按标记过滤，请使用 build.tags 在 filter 字段中指定标记的值，其中 tag-name 是标记的名称：

filter: tag-name in build.tags

您可以使用 size 根据构建事件中指定的标记数量进行过滤。在以下示例中，filter 字段会过滤仅指定了两个标记且其中一个标记指定为 v1 的构建事件：

filter: size(build.tags) == 2 && "v1" in build.tags

按图片过滤

要按图片过滤，请在 filter 字段中指定图片的值 使用 build.images，其中 image-name 是全名 （如 Artifact Registry 中列出的） us-east1-docker.pkg.dev/my-project/docker-repo/image-one:

filter: image-name in build.images

在以下示例中，filter 会过滤将 us-east1-docker.pkg.dev/my-project/docker-repo/image-one 或 us-east1-docker.pkg.dev/my-project/docker-repo/image-two 指定为映像名称的构建事件：

filter: "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images || "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images

按时间过滤

您可以在 filter 字段中指定以下某个选项，以根据构建的创建时间、开始时间或结束时间过滤构建事件：build.create_time、build.start_time 或 build.finish_time。

在以下示例中，filter 字段会使用 timestamp 来过滤创建构建的请求时间为 2020 年 7 月 20 日上午 6:00 的构建事件。

filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")

您还可以按时间比较过滤构建事件。在以下示例中，filter 字段会使用 timestamp 过滤开始时间介于 2020 年 7 月 20 日上午 6:00 到 2020 年 7 月 30 日上午 6:00 之间的构建事件。

filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")

如需详细了解 CEL 中的时区表示方式，请参阅时区的语言定义。

要按构建的持续时间进行过滤，您可以使用 duration 比较时间戳。 在以下示例中，filter 字段会使用 duration 过滤包含至少运行了五分钟的构建的构建事件：

filter: build.finish_time - build.start_time >= duration("5m")

注意 ：时间戳采用 RFC 3339 世界协调时间 (UTC)（即“祖鲁时”）格式，分辨率为纳秒 最多九个小数位。

按替换过滤

您可以使用 build.substitutions 在 filter 字段中指定替换变量，从而按替换进行过滤。在以下示例中，filter 字段会列出包含替代变量 substitution-variable 的构建，并检查 substitution-variable 是否与指定的 substitution-value 匹配：

filter: build.substitutions[substitution-variable] == substitution-value

其中：

• substitution-variable 是替代变量的名称。
• substitution-value 是替代变量值的名称。

您还可以按默认替换变量值进行过滤。在下面的示例中，filter 字段列出分支名称为 master 的构建，以及代码库名称为 github.com/user/my-example-repo 的构建。默认替换变量 BRANCH_NAME 和 REPO_NAME 将作为密钥传递给 build.substitutions：

filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"

如果要使用正则表达式过滤字符串，则可以使用内置的 matches 函数。在以下示例中，filter 字段过滤状态为 FAILURE 或 TIMEOUT 的构建，并且有一个构建替代变量 TAG_NAME，以及一个与正则表达式 v{DIGIT}.{DIGIT}.{3 DIGITS}) 匹配的值。

filter: build.status in [Build.Status.FAILURE, Build.Status.TIMEOUT] && build.substitutions["TAG_NAME"].matches("^v\\d{1}\\.\\d{1}\\.\\d{3}$")

要查看默认替换值的列表，请参阅使用默认替换。

后续步骤

• 了解 Cloud Build 通知器。
• 了解如何订阅构建通知。
• 了解如何编写 Cloud Build 构建配置文件。