Connect クラスタを表示する

Connect クラスタの詳細を表示して、プライマリ Google Cloud Managed Service for Apache Kafka クラスタの名前、Connect クラスタの状態、リソース割り当て、ネットワーク設定、Connect クラスタでホストされているコネクタなど、構成の詳細を確認できます。

Connect クラスタを表示するには、 Google Cloud コンソール、gcloud CLI、クライアントライブラリ、または Managed Kafka API を使用します。オープンソースの Apache Kafka API を使用して Connect クラスタを一覧表示することはできません。

Connect クラスタを表示するために必要なロールと権限

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

この事前定義ロールには、Connect クラスタのリストに必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

Connect クラスタを一覧表示するには、次の権限が必要です。

指定されたロケーションに対するクラスタのリスト権限を付与します。 managedkafka.connectClusters.list
指定されたロケーションに対するクラスタの詳細を取得する権限を付与します。 managedkafka.connectClusters.get

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

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

Connect クラスタの詳細を表示する

コンソール

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

[Connect クラスタ] に移動
表示する Connect クラスタをクリックします。
[クラスタの接続] ページに、次の 4 つのタブが表示されます。
- リソース: クラスタで実行されているコネクタのオペレーションステータスやタイプなど、コネクタに焦点を当てたビューを提供します。
- 構成: プライマリ Kafka クラスタ、状態、リソース割り当て、ネットワーク設定など、Connect クラスタの重要なプロパティと設定が表示されます。
- ログ: モニタリングとトラブルシューティングのために、Connect クラスタからログエントリのリアルタイムストリームを提供します。
- モニタリング: Connect クラスタのパフォーマンスとリソース使用率のモニタリングに役立つ指標を提供します。

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.
Connect クラスタの詳細を表示するには、gcloud managed-kafka connect-clusters describe コマンドを使用します。
```
gcloud managed-kafka connect-clusters describe CONNECT_CLUSTER \
    --location=LOCATION
```
次のように置き換えます。
- CONNECT_CLUSTER: 表示する Connect クラスタの ID。
- LOCATION: Connect クラスタのロケーション。

出力例:

capacityConfig:
memoryBytes: '3221225472'
vcpuCount: '3'
createTime: '2025-03-05T15:19:17.998009888Z'
gcpConfig:
accessConfig:
networkConfigs:
-   primarySubnet: projects/sample-project/regions/us-central1/subnetworks/default
kafkaCluster: projects/sample-project/locations/us-central1/clusters/kafka-test
name: projects/sample-project/locations/us-central1/connectClusters/my-connect-cluster
state: ACTIVE
updateTime: '2025-03-05T15:24:40.861655595Z'

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 getConnectCluster(w io.Writer, projectID, region, clusterID string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// clusterID := "my-connect-cluster"
	ctx := context.Background()
	client, err := managedkafka.NewManagedKafkaConnectClient(ctx, opts...)
	if err != nil {
		return fmt.Errorf("managedkafka.NewManagedKafkaConnectClient got err: %w", err)
	}
	defer client.Close()

	clusterPath := fmt.Sprintf("projects/%s/locations/%s/connectClusters/%s", projectID, region, clusterID)
	req := &managedkafkapb.GetConnectClusterRequest{
		Name: clusterPath,
	}
	cluster, err := client.GetConnectCluster(ctx, req)
	if err != nil {
		return fmt.Errorf("client.GetConnectCluster got err: %w", err)
	}
	fmt.Fprintf(w, "Got connect cluster: %#v\n", cluster)
	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.ConnectCluster;
import com.google.cloud.managedkafka.v1.ConnectClusterName;
import com.google.cloud.managedkafka.v1.ManagedKafkaConnectClient;
import java.io.IOException;

public class GetConnectCluster {

  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-connect-cluster";
    getConnectCluster(projectId, region, clusterId);
  }

  public static void getConnectCluster(String projectId, String region, String clusterId)
      throws Exception {
    try (ManagedKafkaConnectClient managedKafkaConnectClient = ManagedKafkaConnectClient.create()) {
      // This operation is being handled synchronously.
      ConnectCluster connectCluster = managedKafkaConnectClient
          .getConnectCluster(ConnectClusterName.of(projectId, region, clusterId));
      System.out.println(connectCluster.getAllFields());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaConnectClient.getConnectCluster got err: %s\n", 
          e.getMessage());
    }
  }
}

Python

このサンプルを試す前に、クライアントライブラリをインストールするの Python の設定手順を行ってください。詳細については、 Managed Service for Apache Kafka Python API リファレンスドキュメントをご覧ください。

from google.api_core.exceptions import NotFound
from google.cloud.managedkafka_v1.services.managed_kafka_connect import ManagedKafkaConnectClient
from google.cloud import managedkafka_v1

# TODO(developer)
# project_id = "my-project-id"
# region = "us-central1"
# connect_cluster_id = "my-connect-cluster"

client = ManagedKafkaConnectClient()

cluster_path = client.connect_cluster_path(project_id, region, connect_cluster_id)
request = managedkafka_v1.GetConnectClusterRequest(
    name=cluster_path,
)

try:
    cluster = client.get_connect_cluster(request=request)
    print("Got Connect cluster:", cluster)
except NotFound as e:
    print(f"Failed to get Connect cluster {connect_cluster_id} with error: {e}")

Connect クラスタの詳細の概要

[Connect クラスタ] ページが表示され、[リソース]、[構成]、[モニタリング]、[ログ] の 4 つのタブが表示されます。

リソース

Connect クラスタページの [リソース] タブには、デプロイされたコネクタのタイプと運用ステータスの概要が表示されます。次の情報が表示されます。

コネクタテーブル: Connect クラスタのすべてのコネクタを一覧表示するテーブル。
- 名前: 各コネクタに割り当てられた名前。
- 状態: コネクタの現在の運用状態。
- コネクタのタイプ: コネクタのタイプ（MirrorMaker 2.0 ソース、BigQuery シンク、Cloud Storage シンク、Pub/Sub シンクなど）を示します。
フィルタ: プロパティでコネクタをフィルタリングするために使用できる検索バー。

コネクタの健全性をモニタリングするには、[リソース] タブを使用します。

構成

[構成] タブには、クラスタの状態、リソース割り当て、ネットワーク設定、DNS 構成に関する情報が表示されます。

プライマリ Kafka クラスタ: この Connect クラスタに関連付けられている Managed Service for Apache Kafka クラスタの名前が表示されます。Connect クラスタは、構成とオフセットを Managed Service for Apache Kafka クラスタに保存します。
状態: Connect クラスタの現在の状態が表示されます。可能な状態は、Active、Creating、Deleting、State_unspecified です。
リージョン: Connect クラスタのリージョンを示します。
vCPUs: Connect クラスタに割り当てられた仮想 CPU の数を表示します。vCPU 数が多いほど、クラスタの処理能力が向上します。
メモリ: Connect クラスタのプロビジョニングされたメモリの合計が表示されます。
ラベル: Connect クラスタに適用されているラベルが表示されます。
シークレットリソース: Connect クラスタに関連付けられているシークレットが一覧表示されます。
サブネットワーク: Connect クラスタに関連付けられているサブネットワークを一覧表示します。テーブルには、[名前]、[リージョン]、[プロジェクト] の列が含まれています。
DNS 名: Connect クラスタ用に構成されたカスタム DNS 名が表示されます。カスタム DNS 名が構成されていない場合、テーブルは空になります。

モニタリング

[モニタリング] タブには、コネクタのパフォーマンスとリソース使用率を把握するのに役立つ指標が表示されます。表示される指標:

ワーカーの CPU 使用率: 各ワーカーの合計 CPU 使用率（vCPU 秒単位）。この指標は、リソースの制約を特定するのに役立ちます。
ワーカーのメモリ使用量: 各ワーカーの現在のメモリ使用量（バイト単位）。この指標は、メモリ不足エラーの防止に役立ちます。
コネクタの受信バイトの割合: 各コネクタのクライアント接続からの 1 秒あたりの平均受信バイトの割合。この指標は、データ取り込み率の評価に役立ちます。
コネクタの送信バイトの割合: 各コネクタのクライアント接続からサーバーへの 1 秒あたりの送信バイト数の平均。この指標は、データ配信率のモニタリングに役立ちます。

ログ

[ログ] タブには、Connect クラスタからのログエントリのリアルタイムストリームが表示されます。このタブを使用して、コネクタの健全性、アクティビティをモニタリングし、問題をトラブルシューティングします。これらの機能は、Connect クラスタの効果的なモニタリングとデバッグに役立ちます。

重大度でフィルタ: ログエントリを重大度でフィルタして、重大な問題をすばやく特定します。
検索: 特定のキーワードやフレーズでログエントリを検索し、特定のコネクタやタスクに関連するイベントを見つけます。
タイムスタンプ: 各ログエントリのタイムスタンプは、イベントシーケンスの追跡とアクションの発生時期の特定に役立ちます。
概要: ログエントリには、コネクタの起動とシャットダウン、タスクの実行、データ処理など、さまざまなイベントの詳細が記録されます。

次のステップ

Apache Kafka® は、Apache Software Foundation または米国その他の諸国における関連会社の商標です。

Connect クラスタを表示する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。