本文档介绍了如何集成 Apache Kafka 和 Pub/Sub Lite,具体方法为: 使用 Pub/Sub Group Kafka Connector
Pub/Sub Group Kafka Connector 简介
Apache Kafka 是一个用于流式处理事件的开源平台。通常 用于在分布式架构中实现松散通信 耦合的组件。Pub/Sub Lite 是一种代管式服务, 异步接收消息与 Kafka 一样,您可以使用 使用 Pub/Sub Lite 在云中的组件之间通信 架构。
借助 Pub/Sub Group Kafka Connector,您可以集成这两个系统。 以下连接器打包在连接器 JAR 中:
- 接收器连接器从一个或多个 Kafka 主题中读取记录,并且 将其发布到 Pub/Sub Lite
- 源连接器从 Pub/Sub 精简版主题中读取消息 并发布到 Kafka
以下是您可能会使用 Pub/Sub Group Kafka Connector 的一些场景:
- 您正在将基于 Kafka 的架构迁移到 Google Cloud。
- 您有一个前端系统,用于将事件存储在 Kafka 之外的 还可使用 Google Cloud 来运行一些后端。 服务,这些服务需要接收 Kafka 事件。
- 您从本地 Kafka 解决方案收集日志并将其发送到 使用 Google Cloud 进行数据分析。
- 您有一个使用 Google Cloud 的前端系统,但您还需要存储数据 使用 Kafka
该连接器要求 Kafka Connect 它是在 Kafka 与其他系统之间流式传输数据的框架。要使用 您必须运行 Kafka Connect 和 Kafka 集群。
本文档假定您熟悉 Kafka 和 Pub/Sub Lite。如需开始使用 Pub/Sub Lite,请参阅 使用 Google Cloud 控制台在 Pub/Sub Lite 中发布和接收消息。
Pub/Sub Group Kafka Connector 使用入门
本部分将引导您完成以下任务:- 配置 Pub/Sub Group Kafka Connector。
- 将事件从 Kafka 发送到 Pub/Sub Lite。
- 将消息从 Pub/Sub Lite 发送到 Kafka。
前提条件
安装 Kafka
按照 Apache Kafka 快速入门 在本地机器上安装单节点 Kafka。完成下列步骤 快速入门:
- 下载最新的 Kafka 版本并将其解压缩。
- 启动 Kafka 环境。
- 创建 Kafka 主题。
身份验证
Pub/Sub Group Kafka Connector 必须通过 Pub/Sub 进行身份验证, 发送和接收 Pub/Sub 消息。如需设置身份验证,请执行以下操作: 请执行以下步骤:
- 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手,请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
- 安装 Google Cloud CLI。
-
如需初始化 gcloud CLI,请运行以下命令:
gcloud init
-
Create or select a Google Cloud project.
-
Create a Google Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Google Cloud project you are creating. -
Select the Google Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Google Cloud project name.
-
-
为您的 Google 账号创建本地身份验证凭据:
gcloud auth application-default login
-
向您的 Google 账号授予角色。对以下每个 IAM 角色运行以下命令一次:
roles/pubsublite.admin
gcloud projects add-iam-policy-binding PROJECT_ID --member="user:EMAIL_ADDRESS" --role=ROLE
- 将
PROJECT_ID
替换为您的项目 ID。 - 将
EMAIL_ADDRESS
替换为您的电子邮件地址。 - 将
ROLE
替换为每个角色。
- 将
- 安装 Google Cloud CLI。
-
如需初始化 gcloud CLI,请运行以下命令:
gcloud init
-
Create or select a Google Cloud project.
-
Create a Google Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Google Cloud project you are creating. -
Select the Google Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Google Cloud project name.
-
-
为您的 Google 账号创建本地身份验证凭据:
gcloud auth application-default login
-
向您的 Google 账号授予角色。对以下每个 IAM 角色运行以下命令一次:
roles/pubsublite.admin
gcloud projects add-iam-policy-binding PROJECT_ID --member="user:EMAIL_ADDRESS" --role=ROLE
- 将
PROJECT_ID
替换为您的项目 ID。 - 将
EMAIL_ADDRESS
替换为您的电子邮件地址。 - 将
ROLE
替换为每个角色。
- 将
下载连接器 JAR
将连接器 JAR 文件下载到本地计算机。如需了解详情,请参阅 获取连接器 。
复制连接器配置文件
克隆或下载 GitHub 代码库 。
git clone https://github.com/googleapis/java-pubsub-group-kafka-connector.git cd java-pubsub-group-kafka-connector
将
config
目录的内容复制到config
您的 Kafka 安装。cp config/* [path to Kafka installation]/config/
这些文件包含连接器的配置设置。
更新您的 Kafka Connect 配置
- 导航到包含您要创建的 Kafka Connect 二进制文件的目录 已下载。
- 在 Kafka Connect 二进制目录中,打开名为
文本编辑器中支持
config/connect-standalone.properties
。 - 如果
plugin.path property
已被注释掉,请取消注释。 更新
plugin.path property
以包含连接器 JAR 的路径。示例:
plugin.path=/home/PubSubKafkaConnector/pubsub-group-kafka-connector-1.0.0.jar
将
offset.storage.file.filename
属性设置为本地文件名。在 独立模式下,Kafka 使用此文件存储偏移数据。示例:
offset.storage.file.filename=/tmp/connect.offsets
将事件从 Kafka 转发到 Pub/Sub Lite
本部分介绍如何启动接收器连接器、将事件发布到 Kafka、 然后从 Pub/Sub Lite 读取转发的消息。
使用 Google Cloud CLI 创建 Pub/Sub Lite 预留。
gcloud pubsub lite-reservations create RESERVATION_NAME \ --location=LOCATION \ --throughput-capacity=4
替换以下内容:
- RESERVATION_NAME:Pub/Sub Lite 的名称 预留。
- LOCATION:位置 预留。
使用 Google Cloud CLI 创建一个具有 订阅。
gcloud pubsub lite-topics create LITE_TOPIC \ --location=LOCATION \ --partitions=2 \ --per-partition-bytes=30GiB \ --throughput-reservation=RESERVATION_NAME gcloud pubsub lite-subscriptions create LITE_SUBSCRIPTION \ --location=LOCATION \ --topic=LITE_TOPIC
替换以下内容:
- LITE_TOPIC:Cloud Pub/Sub 精简版主题的名称 从 Kafka 接收消息
- LOCATION:主题的位置。该值必须与 预留的位置
- RESERVATION_NAME:Pub/Sub Lite 的名称 预留。
- LITE_SUBSCRIPTION:Pub/Sub 精简版的名称 订阅该主题。
在文本编辑器中打开
/config/pubsub-lite-sink-connector.properties
文件。将 这些值在"TODO"
评论:topics=KAFKA_TOPICS pubsublite.project=PROJECT_ID pubsublite.location=LOCATION pubsublite.topic=LITE_TOPIC
替换以下内容:
- KAFKA_TOPICS:要读取的 Kafka 主题的逗号分隔列表 。
- PROJECT_ID:包含您的 Pub/Sub 精简版主题。
- LOCATION:Pub/Sub 精简版主题的位置。
- LITE_TOPIC:要接收的 Pub/Sub 精简版主题 从 Kafka 读取消息。
从 Kafka 目录运行以下命令:
bin/connect-standalone.sh \ config/connect-standalone.properties \ config/pubsub-lite-sink-connector.properties
请按照 Apache Kafka 快速入门 将一些事件写入您的 Kafka 主题。
使用以下任意一项来订阅 Pub/Sub Lite 订阅 显示的方法 从精简版订阅接收消息。
将消息从 Pub/Sub Lite 转发到 Kafka
本部分介绍如何启动源连接器,以及如何将消息发布到 Pub/Sub Lite,并从 Kafka 读取转发的消息。
使用 Google Cloud CLI 创建 Pub/Sub Lite 预留。
gcloud pubsub lite-reservations create RESERVATION_NAME \ --location=LOCATION \ --throughput-capacity=4
替换以下内容:
- RESERVATION_NAME:Pub/Sub Lite 的名称 预留。
- LOCATION:位置 预留。
使用 Google Cloud CLI 创建一个具有 订阅。
gcloud pubsub lite-topics create LITE_TOPIC \ --location=LOCATION \ --partitions=2 \ --per-partition-bytes=30GiB \ --throughput-reservation=RESERVATION_NAME gcloud pubsub lite-subscriptions create LITE_SUBSCRIPTION \ --location=LOCATION \ --topic=LITE_TOPIC
替换以下内容:
- LITE_TOPIC:Pub/Sub 精简版主题的名称。
- LOCATION:主题的位置。该值必须与 预留的位置
- RESERVATION_NAME:Pub/Sub Lite 的名称 预留。
- LITE_SUBSCRIPTION:Pub/Sub 精简版的名称 订阅该主题。
在以下位置打开名为
/config/pubsub-lite-source-connector.properties
的文件: 文本编辑器。为以下属性添加值,这些属性值会被标记为"TODO"
:topic=KAFKA_TOPIC pubsublite.project=PROJECT_ID pubsublite.location=LOCATION pubsublite.subscription=LITE_SUBSCRIPTION
替换以下内容:
- KAFKA_TOPIC:要接收 Pub/Sub 消息。
- PROJECT_ID:包含您的 Pub/Sub 主题。
- LOCATION:Pub/Sub 精简版主题的位置。
- LITE_SUBSCRIPTION:Pub/Sub 精简版主题。
从 Kafka 目录运行以下命令:
bin/connect-standalone.sh \ config/connect-standalone.properties \ config/pubsub-lite-source-connector.properties
使用 方法 向精简版主题发布消息。
从 Kafka 读取消息。请按照 Apache Kafka 快速入门 从 Kafka 主题读取消息。
短信转化
Kafka 记录 包含一个键和一个值,它们是可变长度的字节数组。(可选) Kafka 记录还可以具有标头,标头是键值对。答 Pub/Sub Lite 消息 包含以下字段:
key
:消息键 (bytes
)data
:消息数据 (bytes
)attributes
:零个或多个属性。每个属性都是一个(key,values[])
地图。一个属性可以有多个值。event_time
:用户提供的可选事件时间戳。
Kafka Connect 使用转换器对传入和传出 Kafka 的键和值进行序列化。 如需控制序列化,请在连接器中设置以下属性 配置文件:
key.converter
:用于对记录键进行序列化的转换器。value.converter
:用于对记录值进行序列化的转换器。
从 Kafka 转换为 Pub/Sub Lite
接收器连接器将 Kafka 记录转换为 Pub/Sub Lite 消息 ,如下所示。
Kafka 记录
(SinkRecord ) |
Pub/Sub Lite 消息 |
---|---|
键 | key |
值 | data |
标头 | attributes |
时间戳 | eventTime |
时间戳类型 | attributes["x-goog-pubsublite-source-kafka-event-time-type"] |
主题 | attributes["x-goog-pubsublite-source-kafka-topic"] |
分区 | attributes["x-goog-pubsublite-source-kafka-offset"] |
偏移值 | attributes["x-goog-pubsublite-source-kafka-partition"] |
键、值和标头按如下方式编码:
- null 架构被视为字符串架构。
- 字节载荷直接写入,不进行转换。
- 字符串、整数和浮点有效负载会编码为 UTF-8 字节。
- 所有其他载荷都会编码到协议缓冲区中
Value
然后转换为字节字符串。- 嵌套字符串字段会编码为 protobuf
Value
。 - 嵌套字节字段编码成一个 protobuf
Value
,用于保存 base64 编码的字节。 - 嵌套数字字段会作为双精度型值编码到 protobuf
Value
中。 - 不支持使用数组、映射或结构体键的映射。
- 嵌套字符串字段会编码为 protobuf
从 Pub/Sub Lite 到 Kafka 的转换
源连接器将 Pub/Sub Lite 消息转换为 Kafka 记录 如下所示:
Pub/Sub Lite 消息 | Kafka 记录
(SourceRecord )
|
---|---|
key |
键 |
data |
值 |
attributes |
标头 |
event_time |
时间戳。如果 event_time 不存在,则发布
所用的时间。 |
配置选项
除了 Kafka Connect API 提供的配置外, 连接器支持以下 Pub/Sub Lite 配置。
接收器连接器配置选项
接收器连接器支持以下配置选项。
设置 | 数据类型 | 说明 |
---|---|---|
connector.class |
String |
必填。连接器的 Java 类。对于
Pub/Sub Lite 接收器连接器,则该值必须为
com.google.pubsublite.kafka.sink.PubSubLiteSinkConnector .
|
gcp.credentials.file.path |
String |
可选。存储 Google Cloud 凭据的文件的路径 用于对 Pub/Sub Lite 进行身份验证。 |
gcp.credentials.json |
String |
可选。一个包含 Google Cloud 的 JSON blob, Pub/Sub Lite 进行身份验证。 |
pubsublite.location |
String |
必需。该 Pub/Sub 精简版主题。 |
pubsublite.project |
String |
必需。包含 Pub/Sub 精简版主题。 |
pubsublite.topic |
String |
必需。要发布的 Pub/Sub Lite 主题 Kafka 记录至。 |
topics |
String |
必需。以英文逗号分隔的 Kafka 主题列表, 读取内容。 |
来源连接器配置选项
源连接器支持以下配置选项。
设置 | 数据类型 | 说明 |
---|---|---|
connector.class |
String |
必填。连接器的 Java 类。对于
Pub/Sub Lite 源连接器,则值必须为
com.google.pubsublite.kafka.source.PubSubLiteSourceConnector .
|
gcp.credentials.file.path |
String |
可选。存储 Google Cloud 凭据的文件的路径 用于对 Pub/Sub Lite 进行身份验证。 |
gcp.credentials.json |
String |
可选。一个包含 Google Cloud 的 JSON blob, Pub/Sub Lite 进行身份验证。 |
kafka.topic |
String |
必需。从以下来源接收消息的 Kafka 主题: Pub/Sub Lite。 |
pubsublite.location |
String |
必需。该 Pub/Sub 精简版主题。 |
pubsublite.partition_flow_control.bytes |
Long |
每个 Pub/Sub Lite 分区的最大未完成字节数。 默认值:20000000 |
pubsublite.partition_flow_control.messages |
Long |
每个 Pub/Sub Lite 分区的未完成消息数量上限。 默认值: |
pubsublite.project |
String |
必填。包含 Pub/Sub 精简版主题。 |
pubsublite.subscription |
String |
必需。Pub/Sub Lite 的名称 从哪个订阅拉取消息。 |
后续步骤
- 了解 Kafka 和 Pub/Sub 之间的差异。
- 详细了解 Pub/Sub Group Kafka Connector。
- 查看 Pub/Sub Group Kafka Connector GitHub 代码库。