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.topics.list
• トピックを取得する: managedkafka.topics.get

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

Managed Kafka 閲覧者（roles/managedkafka.viewer）IAM ロールの詳細については、Managed Service for Apache Kafka の事前定義ロールをご覧ください。

コンソールのトピックのプロパティ

コンソールで、次のトピック プロパティを表示できます。

• 構成: このタブには、次のトピックに関する一般的な構成の詳細が表示されます。

  • 名前: クラスタ内のトピックの一意の識別子。

  • パーティション: トピック内のパーティションの数。パーティションは、スケーラビリティと並列処理のためにトピックのデータをセグメントに分割します。

  • レプリカ: データの冗長性と可用性を確保するために、各パーティションで維持されるコピー（レプリカ）の数。

  • クラスタ: トピックが属する Managed Service for Apache Kafka クラスタの名前。

  • リージョン: クラスタとトピックが配置されている Google Cloud リージョン。

  • デフォルト以外のトピック パラメータ: クラスタ全体のデフォルトとは異なる、トピックに設定されているトピックレベルの構成オーバーライド。

• モニタリング: このタブには、トピックのアクティビティとパフォーマンスに関連する主要な指標を表示するグラフが表示されます。これらのグラフには次のものが含まれます。

  • バイト数: バイトが生成されるレート、またはトピックに送信されるレートを示す時系列グラフ。これは、トピックにパブリッシュされたデータの量を経時的に示します。対応する指標は managedkafka.googleapis.com/byte_in_count です。

  • リクエスト数: トピックに対して行われたリクエストのレートを表す時系列グラフ。トピックの全体的なアクティビティと使用状況が反映されます。関連する指標は managedkafka.googleapis.com/topic_request_count です。

  • パーティション別のログ セグメント: このグラフには、トピック内の各パーティションのアクティブなログ セグメントの数が表示されます。ログ セグメントは、Kafka がトピックデータを保存するディスク上の物理ファイルです。関連する指標は managedkafka.googleapis.com/log_segments です。

• コンシューマー グループ: このセクションには、トピックに登録されているコンシューマー グループが一覧表示されます。コンシューマー グループは、トピックからメッセージを読み取るために連携して動作するコンシューマーのセットです。

トピックを表示する

コンソール

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

   [クラスタ] に移動

   プロジェクトで作成したクラスタが一覧表示されます。

2. トピックを表示するクラスタをクリックします。

   クラスタの詳細ページが表示されます。クラスタの詳細ページの [リソース] タブに、トピックが一覧表示されます。

3. 特定のトピックを表示するには、トピック名をクリックします。

   トピックの詳細ページが表示されます。

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 topics describe コマンドを実行します。

   gcloud managed-kafka topics describe TOPIC_ID \
     --cluster=CLUSTER_ID --location=LOCATION_ID
   

   このコマンドは、指定されたトピックに関する包括的な詳細情報を取得して表示します。この情報には、パーティションの数、レプリケーションの要素、トピック レベルの構成の上書きなど、構成設定が含まれます。

   次のように置き換えます。

   • TOPIC_ID: トピックの ID。
   • CLUSTER_ID: トピックを含むクラスタの ID。
   • LOCATION_ID: クラスタのロケーション。

gcloud managed-kafka topics describe コマンドは、パーティション数やレプリケーション係数など、トピックに関する最小限の情報を表示します。パーティションの割り当てや構成設定の完全なセットなど、より詳細な情報を取得するには、kafka-topics.sh コマンドライン ツールを使用します。

Kafka CLI

このコマンドを実行する前に、Compute Engine VM に Kafka コマンドライン ツールをインストールします。VM は、Managed Service for Apache Kafka クラスタに接続されているサブネットに到達できる必要があります。 Kafka コマンドライン ツールを使用してメッセージを生成して使用するの手順に沿って操作します。

トピックの詳細を表示するには、kafka-topics.sh --describe コマンドを実行します。

kafka-topics.sh --describe \
  --bootstrap-server=BOOTSTRAP_ADDRESS \
  --command-config client.properties \
  --topic TOPIC_ID

次のように置き換えます。

• BOOTSTRAP_ADDRESS: Managed Service for Apache Kafka クラスタのブートストラップ アドレス。
• TOPIC_ID: トピックの ID。

このコマンドは、次のものを含むトピックのプロパティのサブセットを返します。

• パーティション数
• レプリケーション係数
• パーティションの割り当て
• 動的構成（明示的に設定した設定）
• 静的構成（クラスタの起動時に適用される設定）

デフォルト値を含むトピックの構成設定の完全なセットを表示するには、kafka-configs.sh --describe コマンドを実行します。

kafka-configs.sh --describe \
--bootstrap-server=BOOTSTRAP_ADDRESS \
--command-config client.properties \
--entity-type topics \
--entity-name TOPIC_ID \
--all

出力は、Key-Value ペアとしての設定のリストです。--all フラグは、すべての構成設定を返します。動的構成設定のリストのみを取得するには、--all フラグを省略します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: 実際の Google Cloud プロジェクト ID
• LOCATION: クラスタのロケーション
• CLUSTER_ID: クラスタの ID
• TOPIC_ID: トピックの ID

HTTP メソッドと URL:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID",
  "partitionCount": PARTITION_COUNT,
  "replicationFactor": REPLICATION_FACTOR
}

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 getTopic(w io.Writer, projectID, region, clusterID, topicID string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// clusterID := "my-cluster"
	// topicID := "my-topic"
	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)
	topicPath := fmt.Sprintf("%s/topics/%s", clusterPath, topicID)
	req := &managedkafkapb.GetTopicRequest{
		Name: topicPath,
	}
	topic, err := client.GetTopic(ctx, req)
	if err != nil {
		return fmt.Errorf("client.GetTopic got err: %w", err)
	}
	fmt.Fprintf(w, "Got topic: %#v\n", topic)
	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.ManagedKafkaClient;
import com.google.cloud.managedkafka.v1.Topic;
import com.google.cloud.managedkafka.v1.TopicName;
import java.io.IOException;

public class GetTopic {

  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 topicId = "my-topic";
    getTopic(projectId, region, clusterId, topicId);
  }

  public static void getTopic(String projectId, String region, String clusterId, String topicId)
      throws Exception {
    try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
      // This operation is being handled synchronously.
      Topic topic =
          managedKafkaClient.getTopic(TopicName.of(projectId, region, clusterId, topicId));
      System.out.println(topic.getAllFields());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaClient.getTopic 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"
# topic_id = "my-topic"

client = managedkafka_v1.ManagedKafkaClient()

topic_path = client.topic_path(project_id, region, cluster_id, topic_id)
request = managedkafka_v1.GetTopicRequest(
    name=topic_path,
)

try:
    topic = client.get_topic(request=request)
    print("Got topic:", topic)
except NotFound as e:
    print(f"Failed to get topic {topic_id} with error: {e.message}")

次のステップ

• トピックを削除する

• トピックを編集する

• すべてのコンシューマー グループを一覧表示する

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