Pub/Sub 싱크 커넥터 만들기

Pub/Sub 싱크 커넥터는 Kafka 주제에서 Pub/Sub 주제로 메시지를 스트리밍하므로 Kafka 기반 애플리케이션을 Pub/Sub와 통합할 수 있습니다.

Pub/Sub 싱크 커넥터의 사용 사례는 다음과 같습니다.

• 이벤트 기반 아키텍처 Kafka에 게시된 메시지에서 Pub/Sub 처리를 트리거합니다.

• 서비스 통합 Kafka에서 Pub/Sub에서 소비하는 다른 Google Cloud 서비스 또는 애플리케이션으로 데이터를 전송합니다.

• 처리된 데이터를 기반으로 실시간 알림 또는 작업을 트리거합니다.

시작하기 전에

Pub/Sub 싱크 커넥터를 만들기 전에 다음이 있는지 확인합니다.

• Connect 클러스터의 Managed Service for Apache Kafka 클러스터를 만듭니다. 이는 Connect 클러스터와 연결된 기본 Kafka 클러스터입니다. 커넥터 파이프라인의 한쪽 끝을 형성하는 소스 클러스터이기도 합니다.

• Pub/Sub 싱크 커넥터를 호스팅할 Connect 클러스터를 만듭니다.

• Pub/Sub 주제를 만듭니다.

• 소스 클러스터 내에서 Kafka 주제를 만들고 구성합니다. 데이터가 이 Kafka 주제에서 대상 Pub/Sub 주제로 이동합니다.

필수 역할 및 권한

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

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

필수 권한

커넥터를 만들려면 다음 권한이 필요합니다.

• 커넥터를 만듭니다. managedkafka.connectors.create

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

Pub/Sub 주제에 게시할 수 있는 권한 부여

관리형 Kafka 서비스 에이전트에는 Pub/Sub 주제에 메시지를 게시할 수 있는 권한이 있어야 합니다. Pub/Sub 주제가 포함된 프로젝트에 대한 Pub/Sub 게시자 (roles/pubsub.publisher) 역할을 서비스 에이전트에 부여합니다.

Connect 클러스터가 Managed Service for Apache Kafka 클러스터와 다른 프로젝트에 있는 경우 다른 프로젝트에서 Connect 클러스터 만들기를 참조하세요.

Pub/Sub 싱크 커넥터 작동 방식

Pub/Sub 싱크 커넥터는 하나 이상의 Kafka 주제에서 메시지를 가져와 Pub/Sub 주제에 게시합니다.

Pub/Sub 싱크 커넥터가 데이터를 복사하는 방법에 대한 자세한 설명은 다음과 같습니다.

• 커넥터는 소스 클러스터 내의 하나 이상의 Kafka 주제에서 메시지를 소비합니다.

• 커넥터는 cps.topic 구성 속성을 사용하여 지정된 대상 Pub/Sub 주제 ID에 메시지를 씁니다. 필수 속성입니다.

• 또한 커넥터에는 cps.project 구성 속성을 사용하여 지정할 Pub/Sub 주제가 포함된 Google Cloud 프로젝트가 필요합니다. 필수 속성입니다.

• 커넥터는 선택적으로 cps.endpoint 속성을 사용하여 지정된 커스텀 Pub/Sub 엔드포인트를 사용할 수도 있습니다. 기본 엔드포인트는 "pubsub.googleapis.com:443"입니다.

• 성능을 최적화하기 위해 커넥터는 Pub/Sub에 게시하기 전에 메시지를 버퍼링합니다. maxBufferSize, maxBufferBytes, maxDelayThresholdMs, maxOutstandingRequestBytes, maxOutstandingMessages를 구성하여 버퍼링을 제어할 수 있습니다.

• Kafka 레코드에는 헤더, 키, 값이라는 세 가지 구성요소가 있습니다. 커넥터는 키 및 값 변환기를 사용하여 Kafka 메시지 데이터를 Pub/Sub에서 예상하는 형식으로 변환합니다. 구조체 또는 맵 값 스키마를 사용할 때 messageBodyName 속성은 Pub/Sub 메시지 본문으로 사용할 필드 또는 키를 지정합니다.

• 커넥터는 metadata.publish 속성을 true로 설정하여 Kafka 주제, 파티션, 오프셋, 타임스탬프를 메시지 속성으로 포함할 수 있습니다.

• 커넥터는 headers.publish 속성을 true로 설정하여 Kafka 메시지 헤더를 Pub/Sub 메시지 속성으로 포함할 수 있습니다.

• 커넥터는 orderingKeySource 속성을 사용하여 Pub/Sub 메시지의 순서 키를 포함할 수 있습니다. 값의 옵션에는 "none" (기본값), "key", "partition"가 포함됩니다.

• tasks.max 속성은 커넥터의 동시 로드 수준을 제어합니다. tasks.max를 늘리면 처리량이 향상될 수 있지만 실제 동시 로드는 Kafka 주제의 파티션 수로 제한됩니다.

Pub/Sub 싱크 커넥터 속성

Pub/Sub 싱크 커넥터를 만들 때는 다음 속성을 지정해야 합니다.

커넥터 이름

Connect 클러스터 내에서 커넥터의 고유한 이름입니다. 리소스 이름 지정에 대한 가이드라인은 Managed Service for Apache Kafka 리소스 이름 지정 가이드라인을 참조하세요.

커넥터 플러그인 유형

커넥터 플러그인 유형으로 Pub/Sub 싱크를 선택합니다. 이렇게 하면 Kafka에서 Pub/Sub로의 데이터 흐름 방향과 사용되는 특정 커넥터 구현이 결정됩니다. 사용자 인터페이스를 사용하여 커넥터를 구성하지 않는 경우 커넥터 클래스도 지정해야 합니다.

Kafka 주제

커넥터가 메시지를 소비하는 Kafka 주제입니다. 하나 이상의 주제를 지정하거나 정규 표현식을 사용하여 여러 주제를 일치시킬 수 있습니다. 예를 들어 'topic'으로 시작하는 모든 주제를 일치시키려면 topic.*를 사용합니다. 이러한 주제는 Connect 클러스터와 연결된 Managed Service for Apache Kafka 클러스터 내에 있어야 합니다.

Pub/Sub 주제

커넥터가 메시지를 게시하는 기존 Pub/Sub 주제입니다. 시작하기 전에에 설명된 대로 Connect 클러스터 서비스 계정에 주제 프로젝트에 대한 roles/pubsub.publisher 역할이 있는지 확인합니다.

구성

이 섹션에서는 커넥터별 추가 구성 속성을 지정할 수 있습니다.

Kafka 주제의 데이터는 Avro, JSON 또는 원시 바이트와 같은 다양한 형식일 수 있으므로 구성의 핵심 부분은 변환기를 지정하는 것입니다. 변환기는 Kafka 주제에 사용되는 형식의 데이터를 Kafka Connect의 표준화된 내부 형식으로 변환합니다. 그런 다음 Pub/Sub 싱크 커넥터는 이 내부 데이터를 가져와 Pub/Sub에 필요한 형식으로 변환한 후 작성합니다.

Kafka Connect에서 변환기의 역할, 지원되는 변환기 유형, 일반적인 구성 옵션에 대한 자세한 내용은 변환기를 참조하세요.

다음은 Pub/Sub 싱크 커넥터와 관련된 몇 가지 구성입니다.

• cps.project: Pub/Sub 주제가 포함된 Google Cloud 프로젝트 ID를 지정합니다.

• cps.topic: 데이터가 게시되는 Pub/Sub 주제를 지정합니다.

• cps.endpoint: 사용할 Pub/Sub 엔드포인트를 지정합니다.

이 커넥터에 사용할 수 있는 구성 속성 목록은 Pub/Sub 싱크 커넥터 구성을 참조하세요.

Pub/Sub 싱크 커넥터 만들기

커넥터를 만들기 전에 Pub/Sub 싱크 커넥터 속성 문서를 검토하세요.

콘솔

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

   Connect 클러스터로 이동

2. 커넥터를 만들려는 Connect 클러스터를 클릭합니다.

   Connect 클러스터 세부정보 페이지가 표시됩니다.

3. 커넥터 만들기를 클릭합니다.

   Kafka 커넥터 만들기 페이지가 표시됩니다.

4. 커넥터 이름에 문자열을 입력합니다.

   커넥터 이름을 지정하는 방법에 대한 가이드라인은 Managed Service for Apache Kafka 리소스 이름 지정 가이드라인을 참조하세요.

5. 커넥터 플러그인에서 Pub/Sub 싱크를 선택합니다.

6. 주제에서 Kafka 주제 목록 선택 또는 주제 정규식 사용을 선택합니다. 그런 다음 이 커넥터가 메시지를 사용하는 Kafka 주제를 선택하거나 입력합니다. 이러한 주제는 연결된 Kafka 클러스터에 있습니다.

7. Cloud Pub/Sub 주제 선택에서 이 커넥터가 메시지를 게시하는 Pub/Sub 주제를 선택합니다. 주제는 전체 리소스 이름 형식(projects/{project}/topics/{topic})으로 표시됩니다.

8. (선택사항) 구성 섹션에서 추가 설정을 구성합니다. 여기에서 이전 섹션에서 설명한 tasks.max, key.converter, value.converter과 같은 속성을 지정합니다.

9. 작업 재시작 정책을 선택합니다. 자세한 내용은 태스크 다시 시작 정책을 참조하세요.

10. 만들기를 클릭합니다.

gcloud

gcloud managed-kafka connectors create 명령어를 실행합니다.

gcloud managed-kafka connectors create CONNECTOR_ID \
    --connect-cluster=CONNECT_CLUSTER_ID \
    --location=LOCATION \
    --config-file=CONFIG_FILE

다음을 바꿉니다.

• CONNECTOR_ID: 커넥터의 ID 또는 이름입니다.
• CONNECT_CLUSTER_ID: 커넥터가 생성되는 Connect 클러스터의 ID입니다.
• LOCATION: Connect 클러스터의 위치입니다.
• CONFIG_FILE: 로컬 YAML 또는 JSON 구성 파일의 경로입니다.

다음은 Pub/Sub 싱크 커넥터의 구성 파일 예시입니다.

connector.class: "com.google.pubsub.kafka.sink.CloudPubSubSinkConnector"
name: "CPS_SINK_CONNECTOR_ID"
tasks.max: "1"
topics: "GMK_TOPIC_ID"
value.converter: "org.apache.kafka.connect.storage.StringConverter"
key.converter: "org.apache.kafka.connect.storage.StringConverter"
cps.topic: "CPS_TOPIC_ID"
cps.project: "GCP_PROJECT_ID"

다음을 바꿉니다.

• CPS_SINK_CONNECTOR_ID: Pub/Sub 싱크 커넥터의 ID 또는 이름입니다. 커넥터 이름을 지정하는 방법에 대한 가이드라인은 Apache Kafka용 관리형 서비스 리소스 이름 지정 가이드라인을 참조하세요. 커넥터 이름은 변경할 수 없습니다.

• GMK_TOPIC_ID: Pub/Sub 싱크 커넥터가 데이터를 읽는 Managed Service for Apache Kafka 주제의 ID입니다.

• CPS_TOPIC_ID: 데이터가 게시되는 Pub/Sub 주제의 ID입니다.

• GCP_PROJECT_ID: Pub/Sub 주제가 있는 Google Cloud프로젝트의 ID입니다.

Terraform

커넥터를 만들기 위해 Terraform 리소스를 사용할 수 있습니다.

resource "google_managed_kafka_connector" "example-pubsub-sink-connector" {
  project         = data.google_project.default.project_id
  connector_id    = "my-pubsub-sink-connector"
  connect_cluster = google_managed_kafka_connect_cluster.default.connect_cluster_id
  location        = "us-central1"

  configs = {
    "connector.class" = "com.google.pubsub.kafka.sink.CloudPubSubSinkConnector"
    "name"            = "my-pubsub-sink-connector"
    "tasks.max"       = "3"
    "topics"          = "TOPIC_NAME"
    "cps.topic"       = "CPS_TOPIC_NAME"
    "cps.project"     = "CPS_PROJECT_NAME"
    "value.converter" = "org.apache.kafka.connect.storage.StringConverter"
    "key.converter"   = "org.apache.kafka.connect.storage.StringConverter"
  }

  provider = google-beta
}

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요.

Go

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 설치의 Go 설정 안내를 따르세요. 자세한 내용은 Managed Service for Apache Kafka Go API 참조 문서를 확인하세요.

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

import (
	"context"
	"fmt"
	"io"

	managedkafka "cloud.google.com/go/managedkafka/apiv1"
	"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
	"google.golang.org/api/option"
)

// createPubSubSinkConnector creates a Pub/Sub Sink connector.
func createPubSubSinkConnector(w io.Writer, projectID, region, connectClusterID, connectorID, topics, valueConverter, keyConverter, cpsTopic, cpsProject, tasksMax string, opts ...option.ClientOption) error {
	// TODO(developer): Update with your config values. Here is a sample configuration:
	// projectID := "my-project-id"
	// region := "us-central1"
	// connectClusterID := "my-connect-cluster"
	// connectorID := "CPS_SINK_CONNECTOR_ID"
	// topics := "GMK_TOPIC_ID"
	// valueConverter := "org.apache.kafka.connect.storage.StringConverter"
	// keyConverter := "org.apache.kafka.connect.storage.StringConverter"
	// cpsTopic := "CPS_TOPIC_ID"
	// cpsProject := "GCP_PROJECT_ID"
	// tasksMax := "3"
	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)

	// Pub/Sub Sink sample connector configuration
	config := map[string]string{
		"connector.class": "com.google.pubsub.kafka.sink.CloudPubSubSinkConnector",
		"name":            connectorID,
		"tasks.max":       tasksMax,
		"topics":          topics,
		"value.converter": valueConverter,
		"key.converter":   keyConverter,
		"cps.topic":       cpsTopic,
		"cps.project":     cpsProject,
	}

	connector := &managedkafkapb.Connector{
		Name:    fmt.Sprintf("%s/connectors/%s", parent, connectorID),
		Configs: config,
	}

	req := &managedkafkapb.CreateConnectorRequest{
		Parent:      parent,
		ConnectorId: connectorID,
		Connector:   connector,
	}

	resp, err := client.CreateConnector(ctx, req)
	if err != nil {
		return fmt.Errorf("client.CreateConnector got err: %w", err)
	}
	fmt.Fprintf(w, "Created Pub/Sub sink connector: %s\n", resp.Name)
	return nil
}

자바

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 설치의 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.ConnectClusterName;
import com.google.cloud.managedkafka.v1.Connector;
import com.google.cloud.managedkafka.v1.ConnectorName;
import com.google.cloud.managedkafka.v1.CreateConnectorRequest;
import com.google.cloud.managedkafka.v1.ManagedKafkaConnectClient;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

public class CreatePubSubSinkConnector {

  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 connectClusterId = "my-connect-cluster";
    String connectorId = "my-pubsub-sink-connector";
    String pubsubProjectId = "my-pubsub-project-id";
    String pubsubTopicName = "my-pubsub-topic";
    String kafkaTopicName = "kafka-topic";
    String connectorClass = "com.google.pubsub.kafka.sink.CloudPubSubSinkConnector";
    String maxTasks = "3";
    String valueConverter = "org.apache.kafka.connect.storage.StringConverter";
    String keyConverter = "org.apache.kafka.connect.storage.StringConverter";
    createPubSubSinkConnector(
        projectId,
        region,
        connectClusterId,
        connectorId,
        pubsubProjectId,
        pubsubTopicName,
        kafkaTopicName,
        connectorClass,
        maxTasks,
        valueConverter,
        keyConverter);
  }

  public static void createPubSubSinkConnector(
      String projectId,
      String region,
      String connectClusterId,
      String connectorId,
      String pubsubProjectId,
      String pubsubTopicName,
      String kafkaTopicName,
      String connectorClass,
      String maxTasks,
      String valueConverter,
      String keyConverter)
      throws Exception {

    // Build the connector configuration
    Map<String, String> configMap = new HashMap<>();
    configMap.put("connector.class", connectorClass);
    configMap.put("name", connectorId);
    configMap.put("tasks.max", maxTasks);
    configMap.put("topics", kafkaTopicName);
    configMap.put("value.converter", valueConverter);
    configMap.put("key.converter", keyConverter);
    configMap.put("cps.topic", pubsubTopicName);
    configMap.put("cps.project", pubsubProjectId);

    Connector connector = Connector.newBuilder()
        .setName(
            ConnectorName.of(projectId, region, connectClusterId, connectorId).toString())
        .putAllConfigs(configMap)
        .build();

    try (ManagedKafkaConnectClient managedKafkaConnectClient = ManagedKafkaConnectClient.create()) {
      CreateConnectorRequest request = CreateConnectorRequest.newBuilder()
          .setParent(ConnectClusterName.of(projectId, region, connectClusterId).toString())
          .setConnectorId(connectorId)
          .setConnector(connector)
          .build();

      // This operation is being handled synchronously.
      Connector response = managedKafkaConnectClient.createConnector(request);
      System.out.printf("Created Pub/Sub Sink connector: %s\n", response.getName());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaConnectClient.createConnector got err: %s\n", e.getMessage());
    }
  }
}

Python

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 설치의 Python 설정 안내를 따르세요. 자세한 내용은 Managed Service for Apache Kafka Python API 참고 문서를 참조하세요.

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

from google.api_core.exceptions import GoogleAPICallError
from google.cloud.managedkafka_v1.services.managed_kafka_connect import (
    ManagedKafkaConnectClient,
)
from google.cloud.managedkafka_v1.types import Connector, CreateConnectorRequest

connect_client = ManagedKafkaConnectClient()
parent = connect_client.connect_cluster_path(project_id, region, connect_cluster_id)

configs = {
    "connector.class": "com.google.pubsub.kafka.sink.CloudPubSubSinkConnector",
    "name": connector_id,
    "tasks.max": tasks_max,
    "topics": topics,
    "value.converter": value_converter,
    "key.converter": key_converter,
    "cps.topic": cps_topic,
    "cps.project": cps_project,
}

connector = Connector()
connector.name = connector_id
connector.configs = configs

request = CreateConnectorRequest(
    parent=parent,
    connector_id=connector_id,
    connector=connector,
)

try:
    operation = connect_client.create_connector(request=request)
    print(f"Waiting for operation {operation.operation.name} to complete...")
    response = operation.result()
    print("Created Connector:", response)
except GoogleAPICallError as e:
    print(f"The operation failed with error: {e}")

커넥터를 만든 후 커넥터를 수정, 삭제, 일시중지, 중지 또는 다시 시작할 수 있습니다.

다음 단계

• Pub/Sub 커넥터 문제 해결

• 커넥터 일시중지, 재개, 중지, 다시 시작

• 모든 커넥터 나열

• 커넥터 세부정보 보기

• 커넥터 업데이트

Apache Kafka®는 미국 및/또는 다른 국가에서 사용되는 Apache Software Foundation 또는 해당 계열사의 등록 상표입니다.