查看 Google Cloud Managed Service for Apache Kafka 消費者群組

如要查看單一消費者群組的詳細資訊,可以使用Google Cloud 控制台、Google Cloud CLI、用戶端程式庫、Managed Kafka API 或開放原始碼 Apache Kafka API。

查看消費者群組所需的角色和權限

如要取得查看消費者群組所需的權限,請要求管理員授予您專案的代管 Kafka 檢視者 (roles/managedkafka.viewer) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

這個預先定義的角色具備查看消費者群組所需的權限。如要查看確切的必要權限,請展開「Required permissions」(必要權限) 部分:

所需權限

如要查看消費者群組,必須具備下列權限:

  • 列出消費者群組: managedkafka.consumerGroups.list
  • 取得消費者群組詳細資料: managedkafka.consumerGroups.get

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

如要進一步瞭解 Managed Kafka Viewer 角色,請參閱「Managed Service for Apache Kafka 預先定義角色」。

查看消費者群組

如要查看特定叢集的消費者群組詳細資訊,請按照下列步驟操作:

控制台

  1. 前往 Google Cloud 控制台的「Cluster」(叢集) 頁面。

    前往「Clusters」(叢集) 頁面

  2. 按一下要查看消費者群組的叢集。

    系統隨即會顯示「Cluster details」(叢集詳細資料) 頁面。在「叢集詳細資料」頁面的「資源」分頁下方,會列出消費者群組。

  3. 按一下消費者群組。

    「Consumer group details」(消費者群組詳細資料) 頁面隨即開啟。

  4. 這個頁面包含下列詳細資料:

    • 設定:這個分頁會顯示消費者群組的名稱。也會顯示消費者群組所屬的主題。
    • 監控:這個分頁會顯示依分區監控圖表劃分的偏移延遲。

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. 執行 gcloud managed-kafka consumer-groups describe 指令:

    gcloud managed-kafka consumer-groups describe CONSUMER_GROUP_ID \
        --cluster=CLUSTER \
        --location=LOCATION

    這個指令會提供特定 Managed Service for Apache Kafka 消費者群組的詳細資訊。包括消費者群組的名稱、群組 ID、建立時間和更新時間等資訊。

    更改下列內容:

    • CONSUMER_GROUP_ID:消費者群組的 ID 或名稱。

    • CLUSTER:叢集的 ID 或名稱。

    • LOCATION:叢集位置。

  3. Go

    在試用這個範例之前,請先按照「 安裝用戶端程式庫」中的 Go 設定說明操作。詳情請參閱 Managed Service for Apache Kafka Go API 參考說明文件

    如要向 Managed Service for Apache Kafka 進行驗證,請設定應用程式預設憑證(ADC)。 詳情請參閱「為本機開發環境設定 ADC」。

    import (
    	"context"
    	"fmt"
    	"io"
    
    	"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
    	"google.golang.org/api/option"
    
    	managedkafka "cloud.google.com/go/managedkafka/apiv1"
    )
    
    func getConsumerGroup(w io.Writer, projectID, region, clusterID, consumerGroupID string, opts ...option.ClientOption) error {
    	// projectID := "my-project-id"
    	// region := "us-central1"
    	// clusterID := "my-cluster"
    	// consumerGroupID := "my-consumer-group"
    	ctx := context.Background()
    	client, err := managedkafka.NewClient(ctx, opts...)
    	if err != nil {
    		return fmt.Errorf("managedkafka.NewClient got err: %w", err)
    	}
    	defer client.Close()
    
    	clusterPath := fmt.Sprintf("projects/%s/locations/%s/clusters/%s", projectID, region, clusterID)
    	consumerGroupPath := fmt.Sprintf("%s/consumerGroups/%s", clusterPath, consumerGroupID)
    	req := &managedkafkapb.GetConsumerGroupRequest{
    		Name: consumerGroupPath,
    	}
    	consumerGroup, err := client.GetConsumerGroup(ctx, req)
    	if err != nil {
    		return fmt.Errorf("client.GetConsumerGroup got err: %w", err)
    	}
    	fmt.Fprintf(w, "Got consumer group: %#v\n", consumerGroup)
    	return nil
    }
    

    Java

    在試用這個範例之前,請先按照「 安裝用戶端程式庫」中的 Java 設定操作說明進行操作。詳情請參閱 Managed Service for Apache Kafka Java API 參考說明文件

    如要向 Managed Service for Apache Kafka 進行驗證,請設定應用程式預設憑證。詳情請參閱「 為本機開發環境設定 ADC」。

    import com.google.api.gax.rpc.ApiException;
    import com.google.cloud.managedkafka.v1.ConsumerGroup;
    import com.google.cloud.managedkafka.v1.ConsumerGroupName;
    import com.google.cloud.managedkafka.v1.ManagedKafkaClient;
    import java.io.IOException;
    
    public class GetConsumerGroup {
    
      public static void main(String[] args) throws Exception {
        // TODO(developer): Replace these variables before running the example.
        String projectId = "my-project-id";
        String region = "my-region"; // e.g. us-east1
        String clusterId = "my-cluster";
        String consumerGroupId = "my-consumer-group";
        getConsumerGroup(projectId, region, clusterId, consumerGroupId);
      }
    
      public static void getConsumerGroup(
          String projectId, String region, String clusterId, String consumerGroupId) throws Exception {
        try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
          // This operation is being handled synchronously.
          ConsumerGroup consumerGroup =
              managedKafkaClient.getConsumerGroup(
                  ConsumerGroupName.of(projectId, region, clusterId, consumerGroupId));
          System.out.println(consumerGroup.getAllFields());
        } catch (IOException | ApiException e) {
          System.err.printf("managedKafkaClient.getConsumerGroup got err: %s", e.getMessage());
        }
      }
    }
    

    Python

    在試用這個範例之前,請先按照「 安裝用戶端程式庫」中的 Python 設定說明操作。詳情請參閱 Managed Service for Apache Kafka Python API 參考說明文件

    如要向 Managed Service for Apache Kafka 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定 ADC」。

    from google.api_core.exceptions import NotFound
    from google.cloud import managedkafka_v1
    
    # TODO(developer)
    # project_id = "my-project-id"
    # region = "us-central1"
    # cluster_id = "my-cluster"
    # consumer_group_id = "my-consumer-group"
    
    client = managedkafka_v1.ManagedKafkaClient()
    
    consumer_group_path = client.consumer_group_path(
        project_id, region, cluster_id, consumer_group_id
    )
    request = managedkafka_v1.GetConsumerGroupRequest(
        name=consumer_group_path,
    )
    
    try:
        consumer_group = client.get_consumer_group(request=request)
        print("Got consumer group:", consumer_group)
    except NotFound as e:
        print(f"Failed to get consumer group {consumer_group_id} with error: {e.message}")
    

後續步驟

Apache Kafka® 是 The Apache Software Foundation 或其關聯企業在美國與/或其他國家/地區的註冊商標。