모든 커넥터 나열

Connect 클러스터에서 실행되는 모든 커넥터를 나열하면 구성된 데이터 통합을 개략적으로 파악할 수 있습니다. 커넥터의 상태를 모니터링하고, 잠재적 문제를 식별하고, 데이터 흐름을 효과적으로 관리할 수 있습니다.

Connect 클러스터의 모든 커넥터를 나열하려면 Google Cloud 콘솔, gcloud CLI, Apache Kafka용 관리형 서비스 클라이언트 라이브러리 또는 관리형 Kafka API를 사용하면 됩니다. 오픈소스 Apache Kafka API를 사용하여 커넥터를 나열할 수는 없습니다.

모든 커넥터를 나열하는 데 필요한 역할 및 권한

모든 커넥터를 나열하는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 관리형 Kafka 뷰어 (roles/managedkafka.viewer) IAM 역할을 부여해 달라고 요청하세요. 역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

이 사전 정의된 역할에는 모든 커넥터를 나열하는 데 필요한 권한이 포함되어 있습니다. 필요한 정확한 권한을 보려면 필수 권한 섹션을 펼치세요.

필수 권한

모든 커넥터를 나열하려면 다음 권한이 필요합니다.

상위 연결 클러스터에 목록 커넥터 권한을 부여합니다. managedkafka.connectors.list
상위 연결 클러스터에 커넥터 세부정보 가져오기 권한을 부여합니다. managedkafka.connectors.get

커스텀 역할이나 다른 사전 정의된 역할을 사용하여 이 권한을 부여받을 수도 있습니다.

관리형 Kafka 뷰어 역할에 대한 자세한 내용은 Apache Kafka용 관리형 서비스 사전 정의된 역할을 참고하세요.

모든 커넥터 보기

이 뷰를 사용하면 커넥터의 상태를 빠르게 모니터링하고 주의가 필요한 커넥터를 식별할 수 있습니다. 그런 다음 필요한 경우 개별 커넥터로 드릴다운하여 세부정보와 구성을 확인할 수 있습니다.

콘솔

Google Cloud 콘솔에서 클러스터 연결 페이지로 이동합니다.

클러스터 연결로 이동
커넥터를 나열할 클러스터의 '클러스터 연결'을 클릭합니다.

클러스터 연결 세부정보 페이지가 표시됩니다.
리소스 탭에는 클러스터에서 실행되는 모든 커넥터의 목록이 표시됩니다. 목록에는 각 커넥터에 대한 다음 정보가 포함됩니다.
- 이름: 커넥터의 이름입니다.
- 상태: 커넥터의 작동 상태입니다. 예를 들어 Running, Failed입니다.
- 커넥터 유형: 커넥터 플러그인의 유형입니다.
필터 옵션을 사용하여 이름으로 특정 커넥터를 검색할 수 있습니다.

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 connectors list 명령어를 사용하여 커넥터를 나열합니다.

gcloud managed-kafka connectors list CONNECT_CLUSTER_ID \
    --location=LOCATION

커넥터 목록을 더 구체화하려면 다음 추가 플래그를 사용하세요.
```
gcloud managed-kafka connectors list CONNECT_CLUSTER_ID \
    --location=LOCATION \
    [--filter=EXPRESSION] \
    [--limit=LIMIT] \
    [--page-size=PAGE_SIZE] \
    [--sort-by=SORT_BY]
```
다음을 바꿉니다.
- CONNECT_CLUSTER_ID: (필수사항) 나열할 커넥터가 포함된 Connect 클러스터의 ID입니다.
- LOCATION: (필수사항) 나열하려는 커넥터가 포함된 Connect 클러스터의 위치입니다.
- EXPRESSION: (선택사항) 목록에 적용할 불리언 필터 표현식입니다. 표현식이 True로 평가되면 항목이 목록에 포함됩니다. 자세한 내용과 예시를 보려면 gcloud topic filters를 실행하세요.
  
  예:
  - 'RUNNING' 상태의 커넥터만 나열하려면 다음을 실행합니다.
```
--filter="state=RUNNING"
```
  - 'Pub/Sub 싱크' 커넥터만 나열하려면 다음을 실행합니다.
```
--filter="connector_plugin='Pub/Sub Sink'"
```
  - 이름에 'prod'가 포함된 커넥터를 나열하려면 다음을 실행합니다.
```
--filter="name ~ 'prod'"
```
  - 'FAILED' 상태이거나 'Pub/Sub Source' 플러그인인 커넥터를 나열하려면 다음을 실행합니다.
```
--filter="state=FAILED OR connector_plugin='Pub/Sub Source'"
```
- LIMIT: (선택사항) 표시할 최대 커넥터 수입니다. 지정하지 않으면 모든 커넥터가 표시됩니다.
- PAGE_SIZE: (선택사항) 페이지당 표시할 결과 수입니다. 지정하지 않으면 서비스에서 적절한 페이지 크기를 결정합니다.
- SORT_BY: (선택사항) 정렬 기준으로 사용할 쉼표로 구분된 필드 목록입니다. 기본 정렬 순서는 오름차순입니다. 내림차순으로 정렬하려면 필드 앞에 ~를 붙입니다. 지원되는 필드는 name 및 state일 가능성이 높습니다.

정렬이 포함된 명령어의 예:

gcloud managed-kafka connectors list test-connect-cluster \
    --location=us-central1 \
    --sort-by=~state,name

필터링 및 제한이 포함된 명령어의 예:

gcloud managed-kafka connectors list test-connect-cluster \
    --location=us-central1 \
    --filter="state=RUNNING AND connector_plugin='Pub/Sub Sink'" \
    --limit=5

출력 예시:

NAME                                    STATE     CONNECTOR_PLUGIN
pubsub-sink-connector                   RUNNING   Pub/Sub Sink
another-pubsub-sink                     RUNNING   Pub/Sub Sink
prod-pubsub-sink                        RUNNING   Pub/Sub Sink

Go

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 설치의 Go 설정 안내를 따르세요. 자세한 내용은 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/iterator"
	"google.golang.org/api/option"

	managedkafka "cloud.google.com/go/managedkafka/apiv1"
)

func listConnectors(w io.Writer, projectID, region, connectClusterID string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// connectClusterID := "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()

	parent := fmt.Sprintf("projects/%s/locations/%s/connectClusters/%s", projectID, region, connectClusterID)
	req := &managedkafkapb.ListConnectorsRequest{
		Parent: parent,
	}
	connectorIter := client.ListConnectors(ctx, req)
	for {
		connector, err := connectorIter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("connectorIter.Next() got err: %w", err)
		}
		fmt.Fprintf(w, "Got connector: %v", connector)
	}
	return nil
}

자바

이 샘플을 시도하기 전에 클라이언트 라이브러리 설치의 Java 설정 안내를 따르세요. 자세한 내용은 Apache Kafka용 관리형 서비스 Java API 참조 문서를 참고하세요.

Managed Service for Apache Kafka에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 ADC 설정을 참고하세요.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.managedkafka.v1.ConnectClusterName;
import com.google.cloud.managedkafka.v1.Connector;
import com.google.cloud.managedkafka.v1.ManagedKafkaConnectClient;
import java.io.IOException;

public class ListConnectors {

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

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

Python

이 샘플을 시도하기 전에 클라이언트 라이브러리 설치의 Python 설정 안내를 따르세요. 자세한 내용은 Apache Kafka용 관리형 서비스 Python API 참조 문서를 참고하세요.