Google Cloud Managed Service for Apache Kafka コンシューマーグループを表示する

単一のコンシューマーグループの詳細情報を表示するには、Google Cloud コンソール、Google Cloud CLI、クライアントライブラリ、Managed Kafka API、オープンソースの Apache Kafka API を使用します。

コンシューマーグループを表示するために必要なロールと権限

コンシューマーグループを表示するために必要な権限を取得するには、プロジェクトに対する Managed Kafka 閲覧者（roles/managedkafka.viewer）IAM ロールを付与するように管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには、コンシューマーグループの表示に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

コンシューマーグループを表示するには、次の権限が必要です。

コンシューマーグループを一覧表示する: managedkafka.consumerGroups.list
コンシューマグループの詳細を取得します。 managedkafka.consumerGroups.get

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

Managed Kafka 閲覧者のロールの詳細については、Managed Service for Apache Kafka の事前定義ロールをご覧ください。

コンシューマーグループを表示する

特定のクラスタのコンシューマーグループの詳細情報を表示する手順は次のとおりです。

コンソール

Google Cloud コンソールで、[クラスタ] ページに移動します。

クラスタに移動
コンシューマーグループを表示するクラスタをクリックします。
[クラスタの詳細] ページが表示されます。[クラスタの詳細] ページの [リソース] タブに、コンシューマーグループが表示されます。
コンシューマーグループをクリックします。
[コンシューマーグループの詳細] ページが開きます。

このページには次の詳細情報が表示されます。

構成: このタブには、コンシューマーグループの名前が表示されます。また、コンシューマーグループが関連付けられているトピックも表示されます。
モニタリング: このタブには、パーティション別のオフセットラグのモニタリンググラフが表示されます。

gcloud

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.
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: クラスタのロケーション。

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 リファレンスドキュメントをご覧ください。

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® は、Apache Software Foundation または米国その他の諸国における関連会社の商標です。

Google Cloud Managed Service for Apache Kafka コンシューマー グループを表示する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

コンシューマー グループを表示するために必要なロールと権限