Membuat langganan dengan SMT

Dokumen ini menjelaskan cara membuat langganan Pub/Sub dengan Transformasi Pesan Tunggal (SMT).

SMT langganan memungkinkan modifikasi ringan pada data dan atribut pesan langsung dalam Pub/Sub. Fitur ini memungkinkan pembersihan, pemfilteran, atau konversi format data sebelum pesan dikirim ke klien subscriber.

Untuk membuat langganan dengan SMT, Anda dapat menggunakan konsol Google Cloud , Google Cloud CLI, library klien, atau Pub/Sub API.

Sebelum memulai

• Pelajari layanan Pub/Sub dan terminologinya.

• Pelajari SMT.

Peran dan izin yang diperlukan

Untuk mendapatkan izin yang diperlukan guna membuat langganan dengan SMT, minta administrator untuk memberi Anda peran IAM Pub/Sub Editor (roles/pubsub.editor) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin yang diperlukan untuk membuat langganan dengan SMT. Untuk melihat izin yang benar-benar diperlukan, perluas bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk membuat langganan dengan SMT:

• Berikan izin membuat langganan pada project: pubsub.subscriptions.create

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Bergantung pada jenis langganan, Anda mungkin memerlukan izin tambahan. Untuk mengetahui daftar izin yang tepat, lihat dokumen yang membahas cara membuat langganan tertentu. Misalnya, jika Anda membuat langganan BigQuery dengan SMT, lihat halaman Membuat langganan BigQuery.

Jika Anda membuat langganan di project yang berbeda dengan topik, Anda harus memberikan peran roles/pubsub.subscriber kepada akun utama project yang berisi langganan di project yang berisi topik.

Anda dapat mengonfigurasi kontrol akses di level project dan di level resource masing-masing.

Membuat langganan dengan SMT

Sebelum membuat langganan dengan SMT, tinjau dokumentasi untuk Properti langganan.

Catatan: Sebaiknya konfigurasi topik yang dihentikan pengirimannya untuk langganan dengan SMT. Pesan yang diteruskan ke topik pesan yang dihentikan pengirimannya karena kegagalan SMT berisi atribut CloudPubSubDeadLetterSourceSMTErrorMessage yang memiliki alasan kegagalan SMT.

Untuk membuat langganan Pub/Sub dengan satu atau beberapa SMT, lakukan langkah-langkah berikut.

Konsol

1. Di konsol Google Cloud , buka halaman Subscriptions Pub/Sub.

   Buka Langganan

2. Klik Buat langganan.

   Halaman Create subscription akan terbuka.

3. Di kolom Subscription ID, masukkan ID untuk langganan Anda. Untuk informasi selengkapnya tentang penamaan langganan, lihat panduan penamaan.

4. Di bagian Transformasi, klik Tambahkan transformasi.

5. Masukkan nama fungsi. Misalnya: redactSSN.

6. Jika Anda tidak ingin SMT aktif segera, pilih Nonaktifkan transformasi. Jika opsi ini dipilih, SMT akan dibuat dengan langganan, tetapi tidak dijalankan pada pesan masuk. Setelah langganan dibuat, Anda dapat mengedit langganan untuk mengaktifkan SMT.

7. Di area teks, masukkan kode untuk SMT. Contoh:

   function redactSSN(message, metadata) {
     const data = JSON.parse(message.data);
     delete data['ssn'];
     message.data = JSON.stringify(data);
     return message;
   }
   

8. Opsional. Untuk memvalidasi SMT, klik Validasi. Jika SMT valid, pesan "Validation passed" akan ditampilkan. Jika tidak, pesan error akan ditampilkan.

9. Untuk menambahkan transformasi lain, klik Tambahkan transformasi dan ulangi langkah-langkah sebelumnya.

   Untuk mengatur SMT dalam urutan tertentu, klik Pindahkan ke atas atau Pindahkan ke bawah. Untuk menghapus SMT, klik Hapus.

10. Opsional. Untuk menguji SMT pada contoh pesan, lakukan langkah-langkah berikut:

    1. Klik Uji transformasi.

    2. Di jendela Test transform, pilih fungsi yang ingin Anda uji.

    3. Di jendela Input pesan, masukkan contoh pesan.

    4. Untuk menambahkan atribut ke pesan, klik Tambahkan atribut dan masukkan kunci dan nilai atribut. Anda dapat menambahkan beberapa atribut.

    5. Klik Uji. Hasil penerapan SMT pada pesan ditampilkan di bagian Output message.

    6. Untuk menutup jendela Uji transformasi, klik Tutup.

    Jika membuat lebih dari satu SMT, Anda dapat menguji seluruh urutan transformasi sebagai berikut:

    1. Uji SMT pertama dalam urutan, seperti yang dijelaskan dalam langkah-langkah sebelumnya.
    2. Pilih SMT berikutnya. Pesan input diisi otomatis dengan pesan output dari pengujian sebelumnya.
    3. Lanjutkan pengujian SMT secara berurutan, untuk memastikan seluruh urutan berfungsi seperti yang diharapkan.

11. Klik Buat untuk membuat langganan.

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. Buat file YAML atau JSON yang menentukan satu atau beberapa SMT. Jika Anda memiliki lebih dari satu SMT, SMT tersebut akan dieksekusi pada pesan sesuai urutan yang Anda cantumkan.

   Berikut adalah contoh file transformasi YAML:

   - javascriptUdf:
       code: >
           function redactSSN(message, metadata) {
             const data = JSON.parse(message.data);
             delete data['ssn'];
             message.data = JSON.stringify(data);
             return message;
           }
       functionName: redactSSN
   

3. Opsional. Untuk memvalidasi SMT, jalankan perintah gcloud pubsub message-transforms validate:

   gcloud pubsub message-transforms validate \
     --message-transform-file=TRANSFORM_FILE
   

   Ganti kode berikut:

   • TRANSFORM_FILE: Jalur ke file YAML atau JSON yang menentukan satu SMT. Jika membuat beberapa SMT, Anda harus memvalidasinya satu per satu.

4. Opsional. Untuk menguji satu atau beberapa SMT pada contoh pesan Pub/Sub, jalankan perintah gcloud pubsub message-transforms test:

   gcloud pubsub message-transforms test \
     --message-transforms-file=TRANSFORMS_FILE \
     --message=MESSAGE \
     --attribute=ATTRIBUTES
   

   Ganti kode berikut:

   • TRANSFORMS_FILE: Jalur ke file YAML atau JSON yang menentukan satu atau beberapa SMT.
   • MESSAGE: Isi contoh pesan.
   • ATTRIBUTES: Opsional. Daftar atribut pesan yang dipisahkan koma. Setiap atribut adalah pasangan nilai kunci yang diformat sebagai KEY="VALUE".

   Perintah menjalankan SMT secara berurutan, menggunakan output dari setiap SMT sebagai input ke SMT berikutnya. Perintah ini akan menampilkan hasil setiap langkah.

5. Untuk membuat langganan, jalankan perintah gcloud pubsub subscriptions create:

   gcloud pubsub subscriptions create SUBSCRIPTION_ID \
       --topic=projects/PROJECT_ID/topics/TOPIC_ID \
       --message-transforms-file=TRANSFORMS_FILE
   

   Ganti kode berikut:

   • SUBSCRIPTION_ID: ID atau nama langganan yang ingin Anda buat. Untuk mengetahui panduan tentang cara memberi nama langganan, lihat Nama resource. Nama langganan tidak dapat diubah.

   • PROJECT_ID: ID project yang berisi topik.

   • TOPIC_ID: ID topik yang akan dijadikan langganan.

   • TRANSFORMS_FILE: Jalur ke file YAML atau JSON yang menentukan satu atau beberapa SMT.

Java

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Java di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Java API Pub/Sub.

import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
import com.google.pubsub.v1.JavaScriptUDF;
import com.google.pubsub.v1.MessageTransform;
import com.google.pubsub.v1.ProjectSubscriptionName;
import com.google.pubsub.v1.ProjectTopicName;
import com.google.pubsub.v1.Subscription;
import java.io.IOException;

public class CreateSubscriptionWithSmtExample {
  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";
    String topicId = "your-topic-id";
    String subscriptionId = "your-subscription-id";

    createSubscriptionWithSmtExample(projectId, topicId, subscriptionId);
  }

  public static void createSubscriptionWithSmtExample(
      String projectId, String topicId, String subscriptionId) throws IOException {

    // UDF that removes the 'ssn' field, if present
    String code =
        "function redactSSN(message, metadata) {"
            + "  const data = JSON.parse(message.data);"
            + "  delete data['ssn'];"
            + "  message.data = JSON.stringify(data);"
            + "  return message;"
            + "}";
    String functionName = "redactSSN";

    JavaScriptUDF udf =
        JavaScriptUDF.newBuilder().setCode(code).setFunctionName(functionName).build();
    MessageTransform transform = MessageTransform.newBuilder().setJavascriptUdf(udf).build();

    try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

      ProjectTopicName topicName = ProjectTopicName.of(projectId, topicId);
      ProjectSubscriptionName subscriptionName =
          ProjectSubscriptionName.of(projectId, subscriptionId);

      Subscription subscription =
          subscriptionAdminClient.createSubscription(
              Subscription.newBuilder()
                  .setName(subscriptionName.toString())
                  .setTopic(topicName.toString())
                  // Add the UDF message transform
                  .addMessageTransforms(transform)
                  .build());

      System.out.println("Created subscription with SMT: " + subscription.getAllFields());
    }
  }
}

Python

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Pub/Sub Python API.

from google.cloud import pubsub_v1
from google.pubsub_v1.types import JavaScriptUDF, MessageTransform

# TODO(developer): Choose an existing topic.
# project_id = "your-project-id"
# topic_id = "your-topic-id"
# subscription_id = "your-subscription-id"

publisher = pubsub_v1.PublisherClient()
subscriber = pubsub_v1.SubscriberClient()
topic_path = publisher.topic_path(project_id, topic_id)
subscription_path = subscriber.subscription_path(project_id, subscription_id)

code = """function redactSSN(message, metadata) {
            const data = JSON.parse(message.data);
            delete data['ssn'];
            message.data = JSON.stringify(data);
            return message;
            }"""
udf = JavaScriptUDF(code=code, function_name="redactSSN")
transforms = [MessageTransform(javascript_udf=udf)]

with subscriber:
    subscription = subscriber.create_subscription(
        request={
            "name": subscription_path,
            "topic": topic_path,
            "message_transforms": transforms,
        }
    )
    print(f"Created subscription with SMT: {subscription}")

Go

Contoh berikut menggunakan versi utama library klien Go Pub/Sub (v2). Jika Anda masih menggunakan library v1, lihat panduan migrasi ke v2. Untuk melihat daftar contoh kode v1, lihat contoh kode yang tidak digunakan lagi.

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Go di Panduan memulai: Menggunakan Library Klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi API Go Pub/Sub.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsub/v2"
	"cloud.google.com/go/pubsub/v2/apiv1/pubsubpb"
)

// createSubscriptionWithSMT creates a subscription with a single message transform function applied.
func createSubscriptionWithSMT(w io.Writer, projectID, topicID, subID string) error {
	// projectID := "my-project-id"
	// topicID := "my-topic"
	// subID := "my-sub"
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	code := `function redactSSN(message, metadata) {
			const data = JSON.parse(message.data);
			delete data['ssn'];
			message.data = JSON.stringify(data);
			return message;
		}`

	transform := &pubsubpb.MessageTransform{
		Transform: &pubsubpb.MessageTransform_JavascriptUdf{
			JavascriptUdf: &pubsubpb.JavaScriptUDF{
				FunctionName: "redactSSN",
				Code:         code,
			},
		},
	}

	sub := &pubsubpb.Subscription{
		Name:              fmt.Sprintf("projects/%s/subscriptions/%s", projectID, subID),
		Topic:             fmt.Sprintf("projects/%s/topics/%s", projectID, topicID),
		MessageTransforms: []*pubsubpb.MessageTransform{transform},
	}
	sub, err = client.SubscriptionAdminClient.CreateSubscription(ctx, sub)
	if err != nil {
		return fmt.Errorf("CreateSubscription: %w", err)
	}
	fmt.Fprintf(w, "Created subscription with message transform: %v\n", sub)
	return nil
}

Cara SMT berinteraksi dengan fitur langganan lainnya

Jika langganan Anda menggunakan SMT dan filter bawaan Pub/Sub, maka filter akan diterapkan sebelum SMT. Hal ini memiliki implikasi berikut:

• Jika SMT Anda mengubah atribut pesan, filter Pub/Sub tidak akan diterapkan ke kumpulan atribut baru.
• SMT Anda tidak akan diterapkan ke pesan apa pun yang difilter oleh filter Pub/Sub.

Jika SMT memfilter pesan, perhatikan dampaknya terhadap pemantauan backlog langganan Anda. Jika Anda memasukkan langganan ke pipeline Dataflow, jangan memfilter pesan menggunakan SMT karena akan mengganggu penskalaan otomatis Dataflow.

Langkah berikutnya

• Memecahkan masalah SMT

• Memperbarui SMT langganan

• Menghapus SMT langganan