查看连接器的详细信息可让您检查其配置、运行状态、任务重启政策,并监控其性能指标。
如需查看 Connect 集群中连接器的详细信息,您可以使用 Google Cloud 控制台、gcloud CLI、Managed Service for Apache Kafka 客户端库或 Managed Kafka API。您无法使用开源 Apache Kafka API 查看连接器。
查看连接器所需的角色和权限
如需获得查看连接器所需的权限,请让您的管理员为您授予项目的 Managed Kafka Viewer (roles/managedkafka.viewer) IAM 角色。
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
此预定义角色包含查看连接器所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
如需查看连接器,您需要具备以下权限:
-
在父级 Connect 集群上授予 list connectors 权限:
managedkafka.connectors.list -
在父级 Connect 集群上授予“获取连接器详细信息”权限:
managedkafka.connectors.get
查看连接器详细信息
控制台
在 Google Cloud 控制台中,前往连接集群页面。
点击要查看的连接器所在的 Connect 集群。
系统会显示连接集群详情页面。
在资源标签页中,找到列表中的连接器,然后点击其名称。系统会将您重定向到连接器详情页面。
连接器详情页面会显示以下标签页:
- 配置:显示连接器的配置,包括:
- 名称:连接器的名称。
- 状态:连接器的运行状态。例如,跑步。
- 任务重启政策:用于重启失败任务的政策。 例如,是否重启失败的任务,以及使用哪些退避设置。
- 配置属性:定义连接器配置的键值对列表。
- 监控:提供用于监控连接器的图表,例如:
- 任务错误数:遇到错误的任务数。
- 有效任务数:当前有效任务的数量。
此页面还包含用于修改、删除、暂停、停止和重新启动连接器的按钮。
- 配置:显示连接器的配置,包括:
gcloud
-
在 Google Cloud 控制台中,激活 Cloud Shell。
Cloud Shell 会话随即会在 Google Cloud 控制台的底部启动,并显示命令行提示符。Cloud Shell 是一个已安装 Google Cloud CLI 且已为当前项目设置值的 Shell 环境。该会话可能需要几秒钟时间来完成初始化。
使用
gcloud managed-kafka connectors describe命令描述连接器:gcloud managed-kafka connectors describe CONNECTOR_ID \ --location=LOCATION \ --connect-cluster=CONNECT_CLUSTER_ID替换以下内容:
- CONNECTOR_ID:必填。要描述的连接器的 ID。
- LOCATION:必填。包含连接器的 Connect 集群的位置。
- CONNECT_CLUSTER_ID:必填。包含连接器的 Connect 集群的 ID。
示例命令:
gcloud managed-kafka connectors describe test-connector \
--location=us-central1 \
--connect-cluster=test-connect-cluster
输出示例:
config:
connector.class: com.google.cloud.kafka.connect.pubsub.PubsubSinkConnector
kafka.topic.regex: .*
key.converter: org.apache.kafka.connect.storage.StringConverter
project: test-project
tasks.max: '1'
topic: test-pubsub-topic
value.converter: org.apache.kafka.connect.json.JsonConverter
value.converter.schemas.enable: 'false'
createTime: '2024-03-13T05:17:34.123456Z'
labels:
test-label-key: test-label-value
name: projects/test-project/locations/us-central1/connectClusters/test-connect-cluster/connectors/test-connector
state: RUNNING
taskRestartPolicy: RESTART_WITH_EXPONENTIAL_BACKOFF
updateTime: '2024-03-13T05:18:15.987654Z'
Go
在尝试此示例之前,请按照 安装客户端库中的 Go 设置说明进行操作。如需了解详情,请参阅 Managed Service for Apache Kafka Go API 参考文档。
如需向 Managed Service for Apache Kafka 进行身份验证,请设置应用默认凭据(ADC)。 如需了解详情,请参阅为本地开发环境设置 ADC。
Java
在尝试此示例之前,请按照 安装客户端库中的 Java 设置说明进行操作。如需了解详情,请参阅 Managed Service for Apache Kafka Java API 参考文档。
如需向 Managed Service for Apache Kafka 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅 为本地开发环境设置 ADC。
Python
在尝试此示例之前,请按照 安装客户端库中的 Python 设置说明进行操作。如需了解详情,请参阅 Managed Service for Apache Kafka Python API 参考文档。
如需向 Managed Service for Apache Kafka 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置 ADC。