Cloud Pub/Sub to Cloud Storage 模板

使用“无服务器 Apache Spark - Cloud Pub/Sub 到 Cloud Storage”模板将数据从 Pub/Sub 提取到 Cloud Storage。

使用模板

使用 gcloud CLI 或 Dataproc API 运行模板。

gcloud

在使用下面的命令数据之前，请先进行以下替换：

PROJECT_ID：必填。IAM 设置中列出的 Google Cloud 项目 ID。
REGION：必填。Compute Engine 区域。
SUBNET：可选。如果未指定子网，则会选择 default 网络中指定区域的子网。
示例： projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
TEMPLATE_VERSION：必填。指定 latest 以使用最新模板版本，或指定特定版本的日期，例如 2023-03-17_v0.1.0-beta（访问 gs://dataproc-templates-binaries 或运行 gcloud storage ls gs://dataproc-templates-binaries 以列出可用的模板版本）。
PUBSUB_SUBSCRIPTION_PROJECT_ID：必填。IAM 设置中列出的 Google Cloud 项目 ID，其中包含要读取的输入 Pub/Sub 订阅。
SUBSCRIPTION：必填。Pub/Sub 订阅名称。
CLOUD_STORAGE_OUTPUT_BUCKET_NAME：必填。将存储输出的 Cloud Storage 存储桶名称。
注意：输出文件将存储在存储分区内的 output/ 文件夹中。
FORMAT：必填。输出数据格式。选项：avro 或 json。
注意：如果值为 avro，您必须将“file:///usr/lib/spark/connector/spark-avro.jar”添加到 jars gcloud CLI 标志或 API 字段。

示例（file:// 前缀引用 Serverless for Apache Spark JAR 文件）：
--jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... other jars]
TIMEOUT：可选。在终止流之前的时间（以毫秒为单位）。默认值为 60000。
DURATION：可选。写入 Cloud Storage 的频率（以秒为单位）。默认值为 15 秒。
NUM_RECEIVERS：可选。从 Pub/Sub 订阅并行读取的流的数量。默认值为 5。
BATCHSIZE：可选。一次往返 Cloud Storage 中要插入的记录数。默认值为 1000。
SERVICE_ACCOUNT：可选。如果未提供，则使用默认 Compute Engine 服务账号。
PROPERTY 和 PROPERTY_VALUE：可选。以英文逗号分隔的 Spark 属性=value 对列表。
LABEL 和 LABEL_VALUE：可选。以英文逗号分隔的 label=value 对列表。
LOG_LEVEL：可选。日志记录级别。可以是 ALL、DEBUG、ERROR、FATAL、INFO、OFF、TRACE 或 WARN。默认值：INFO。
KMS_KEY：可选。用于加密的 Cloud Key Management Service 密钥。如果未指定密钥，系统会使用 Google-owned and Google-managed encryption key对静态数据进行加密。
示例： projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

执行以下命令：

Linux、macOS 或 Cloud Shell

gcloud dataproc batches submit spark \
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \
    --version="1.2" \
    --project="PROJECT_ID" \
    --region="REGION" \
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" \
    --subnet="SUBNET" \
    --kms-key="KMS_KEY" \
    --service-account="SERVICE_ACCOUNT" \
    --properties="PROPERTY=PROPERTY_VALUE" \
    --labels="LABEL=LABEL_VALUE" \
    -- --template=PUBSUBTOGCS \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" \
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" \
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" \
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" \
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" \
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" \
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" \
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

Windows (PowerShell)

gcloud dataproc batches submit spark `
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
    --version="1.2" `
    --project="PROJECT_ID" `
    --region="REGION" `
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" `
    --subnet="SUBNET" `
    --kms-key="KMS_KEY" `
    --service-account="SERVICE_ACCOUNT" `
    --properties="PROPERTY=PROPERTY_VALUE" `
    --labels="LABEL=LABEL_VALUE" `
    -- --template=PUBSUBTOGCS `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" `
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" `
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" `
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" `
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" `
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" `
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" `
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

Windows (cmd.exe)

gcloud dataproc batches submit spark ^
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
    --version="1.2" ^
    --project="PROJECT_ID" ^
    --region="REGION" ^
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" ^
    --subnet="SUBNET" ^
    --kms-key="KMS_KEY" ^
    --service-account="SERVICE_ACCOUNT" ^
    --properties="PROPERTY=PROPERTY_VALUE" ^
    --labels="LABEL=LABEL_VALUE" ^
    -- --template=PUBSUBTOGCS ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" ^
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" ^
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" ^
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" ^
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" ^
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" ^
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" ^
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

REST

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：必填。IAM 设置中列出的 Google Cloud 项目 ID。
REGION：必填。Compute Engine 区域。
SUBNET：可选。如果未指定子网，则会选择 default 网络中指定区域的子网。
示例： projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
TEMPLATE_VERSION：必填。指定 latest 以使用最新模板版本，或指定特定版本的日期，例如 2023-03-17_v0.1.0-beta（访问 gs://dataproc-templates-binaries 或运行 gcloud storage ls gs://dataproc-templates-binaries 以列出可用的模板版本）。
PUBSUB_SUBSCRIPTION_PROJECT_ID：必填。IAM 设置中列出的 Google Cloud 项目 ID，其中包含要读取的输入 Pub/Sub 订阅。
SUBSCRIPTION：必填。Pub/Sub 订阅名称。
CLOUD_STORAGE_OUTPUT_BUCKET_NAME：必填。将存储输出的 Cloud Storage 存储桶名称。
注意：输出文件将存储在存储分区内的 output/ 文件夹中。
FORMAT：必填。输出数据格式。选项：avro 或 json。
注意：如果值为 avro，您必须将“file:///usr/lib/spark/connector/spark-avro.jar”添加到 jars gcloud CLI 标志或 API 字段。

示例（file:// 前缀引用 Serverless for Apache Spark JAR 文件）：
--jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... other jars]
TIMEOUT：可选。在终止流之前的时间（以毫秒为单位）。默认值为 60000。
DURATION：可选。写入 Cloud Storage 的频率（以秒为单位）。默认值为 15 秒。
NUM_RECEIVERS：可选。从 Pub/Sub 订阅并行读取的流的数量。默认值为 5。
BATCHSIZE：可选。一次往返 Cloud Storage 中要插入的记录数。默认值为 1000。
SERVICE_ACCOUNT：可选。如果未提供，则使用默认 Compute Engine 服务账号。
PROPERTY 和 PROPERTY_VALUE：可选。以英文逗号分隔的 Spark 属性=value 对列表。
LABEL 和 LABEL_VALUE：可选。以英文逗号分隔的 label=value 对列表。
LOG_LEVEL：可选。日志记录级别。可以是 ALL、DEBUG、ERROR、FATAL、INFO、OFF、TRACE 或 WARN。默认值：INFO。
KMS_KEY：可选。用于加密的 Cloud Key Management Service 密钥。如果未指定密钥，系统会使用 Google-owned and Google-managed encryption key对静态数据进行加密。
示例： projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

HTTP 方法和网址：

POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches

请求 JSON 正文：


{
  "environmentConfig":{
    "executionConfig":{
      "subnetworkUri":"SUBNET",
      "kmsKey": "KMS_KEY",
      "serviceAccount": "SERVICE_ACCOUNT"
    }
  },
  "labels": {
    "LABEL": "LABEL_VALUE"
  },
  "runtimeConfig": {
    "version": "1.2",
    "properties": {
      "PROPERTY": "PROPERTY_VALUE"
    }
  },
  "sparkBatch":{
    "mainClass":"com.google.cloud.dataproc.templates.main.DataProcTemplate",
    "args":[
      "--template","PUBSUBTOGCS",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","pubsubtogcs.input.project.id=PUBSUB_SUBSCRIPTION_PROJECT_ID",
      "--templateProperty","pubsubtogcs.input.subscription=SUBSCRIPTION",
      "--templateProperty","pubsubtogcs.gcs.bucket.name=CLOUD_STORAGE_OUTPUT_BUCKET_NAME",
      "--templateProperty","pubsubtogcs.gcs.output.data.format=FORMAT",
      "--templateProperty","pubsubtogcs.timeout.ms=TIMEOUT",
      "--templateProperty","pubsubtogcs.streaming.duration.seconds=DURATION",
      "--templateProperty","pubsubtogcs.total.receivers=NUM_RECEIVERS",
      "--templateProperty","pubsubtogcs.batch.size=BATCHSIZE"
    ],
    "jarFileUris":[
      "file:///usr/lib/spark/connector/spark-avro.jar", "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar"
    ]
  }
}

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：


{
  "name": "projects/PROJECT_ID/regions/REGION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dataproc.v1.BatchOperationMetadata",
    "batch": "projects/PROJECT_ID/locations/REGION/batches/BATCH_ID",
    "batchUuid": "de8af8d4-3599-4a7c-915c-798201ed1583",
    "createTime": "2023-02-24T03:31:03.440329Z",
    "operationType": "BATCH",
    "description": "Batch"
  }
}