Connettere Pub/Sub ad Apache Kafka

Questo documento descrive come integrare Apache Kafka e Pub/Sub utilizzando il connettore Kafka per gruppi Pub/Sub.

Nota: puoi utilizzare questo connettore anche con Pub/Sub Lite. Consulta Connetti Pub/Sub Lite ad Apache Kafka.

Informazioni sul connettore Kafka per gruppi Pub/Sub

Apache Kafka è una piattaforma open source per lo streaming di eventi. Di solito utilizzata in architetture distribuite per consentire la comunicazione componenti accoppiati. Pub/Sub è un servizio gestito per l'invio ricevere i messaggi in modo asincrono. Come con Kafka, puoi utilizzare Pub/Sub per comunicare tra i componenti nel cloud dell'architettura.

Il connettore Kafka del gruppo Pub/Sub consente di integrare questi due sistemi. I seguenti connettori sono pacchettizzati nel JAR del connettore:

• Il connettore sink legge i record da uno o più argomenti Kafka e le pubblica in Pub/Sub.
• Il connettore di origine legge i messaggi da un argomento Pub/Sub e li pubblica in Kafka.

Di seguito sono riportati alcuni scenari in cui potresti utilizzare il connettore Pub/Sub Group Kafka:

• Stai eseguendo la migrazione di un'architettura basata su Kafka a Google Cloud.
• Hai un sistema di frontend che archivia gli eventi in Kafka all'esterno Google Cloud, ma utilizzi anche Google Cloud per eseguire parte del tuo backend che devono ricevere gli eventi Kafka.
• Puoi raccogliere i log da una soluzione Kafka on-premise e inviarli a Google Cloud per l'analisi dei dati.
• Hai un sistema frontend che utilizza Google Cloud, ma archivi anche i dati on-premise utilizzando Kafka.

Il connettore richiede Kafka Connect che è un framework per trasmettere dati in modalità flusso tra Kafka e altri sistemi. Per utilizzare devi eseguire Kafka Connect insieme al tuo cluster Kafka.

Questo documento presuppone che tu conosca sia Kafka sia Pub/Sub. Prima di leggere questo documento, ti consigliamo di completare una delle guide rapide di Pub/Sub.

Il connettore Pub/Sub non supporta alcuna integrazione tra le ACL di Google Cloud IAM e Kafka Connect.

Inizia a utilizzare il connettore

In questa sezione vengono illustrate le seguenti attività:

1. Configurare il connettore Kafka del gruppo Pub/Sub.
2. Inviare eventi da Kafka a Pub/Sub.
3. Invia messaggi da Pub/Sub a Kafka.

Nota: in questa sezione viene utilizzato Kafka Connect in modalità autonoma, che è adatta per i test. Per i sistemi di produzione è consigliata la modalità distribuita. Per informazioni sull'esecuzione di Kafka Connect in modalità distribuita, consulta Eseguire Kafka Connect nella documentazione di Apache Kafka.

Prerequisiti

Installa Kafka

Segui la guida rapida di Apache Kafka per installare un singolo nodo Kafka sulla tua macchina locale. Completa i seguenti passaggi nella guida introduttiva:

1. Scarica l'ultima release di Kafka ed estraila.
2. Avvia l'ambiente Kafka.
3. Creare un argomento Kafka.

Autentica

Il connettore Kafka per gruppi Pub/Sub deve autenticarsi con Pub/Sub per poter inviare e ricevere messaggi Pub/Sub. Per configurare l'autenticazione, segui questi passaggi:

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
2. Install the Google Cloud CLI.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

5. Create local authentication credentials for your user account:

   gcloud auth application-default login

6. Grant roles to your user account. Run the following command once for each of the following IAM roles: roles/pubsub.admin

   gcloud projects add-iam-policy-binding PROJECT_ID --member="USER_IDENTIFIER" --role=ROLE

   • Replace PROJECT_ID with your project ID.

   • Replace USER_IDENTIFIER with the identifier for your user account. For example, user:[e-mail].

   • Replace ROLE with each individual role.
7. Install the Google Cloud CLI.

8. To initialize the gcloud CLI, run the following command:

   gcloud init

9. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

10. Create local authentication credentials for your user account:

    gcloud auth application-default login

11. Grant roles to your user account. Run the following command once for each of the following IAM roles: roles/pubsub.admin

    gcloud projects add-iam-policy-binding PROJECT_ID --member="USER_IDENTIFIER" --role=ROLE

    • Replace PROJECT_ID with your project ID.

    • Replace USER_IDENTIFIER with the identifier for your user account. For example, user:[e-mail].

    • Replace ROLE with each individual role.

Nota: per i carichi di lavoro di produzione, ti consigliamo di utilizzare la federazione di Workload Identity per l'autenticazione.

Scaricare il file JAR del connettore

Scarica il file JAR del connettore nella macchina locale. Per maggiori informazioni, consulta la sezione Acquista il connettore nel file readme di GitHub.

Copia i file di configurazione del connettore

1. Clona o scarica il Repository GitHub per il connettore.

   git clone https://github.com/googleapis/java-pubsub-group-kafka-connector.git
   cd java-pubsub-group-kafka-connector
   

2. Copia il contenuto della directory config nella sottodirectory config di dell'installazione di Kafka.

   cp config/* [path to Kafka installation]/config/
   

Questi file contengono le impostazioni di configurazione per il connettore.

Aggiorna la configurazione di Kafka Connect

1. Vai alla directory che contiene il programma binario Kafka Connect che scaricato.
2. Nella directory dei file binari di Kafka Connect, apri il file config/connect-standalone.properties in un editor di testo.
3. Se plugin.path property è commentato, rimuovi il commento.

4. Aggiorna plugin.path property in modo da includere il percorso del JAR del connettore.

   Esempio:

   plugin.path=/home/PubSubKafkaConnector/pubsub-group-kafka-connector-1.0.0.jar
   

5. Imposta la proprietà offset.storage.file.filename sul nome di un file locale. In modalità autonoma, Kafka utilizza questo file per archiviare i dati sugli offset.

   Esempio:

   offset.storage.file.filename=/tmp/connect.offsets
   

Inoltra gli eventi da Kafka a Pub/Sub

Questa sezione descrive come avviare il connettore sink, pubblicare eventi in Kafka, leggere i messaggi inoltrati da Pub/Sub.

1. Utilizza Google Cloud CLI per creare un argomento Pub/Sub con una sottoscrizione.

   gcloud pubsub topics create PUBSUB_TOPIC
   gcloud pubsub subscriptions create PUBSUB_SUBSCRIPTION --topic=PUBSUB_TOPIC

   Sostituisci quanto segue:

   • PUBSUB_TOPIC: il nome di un argomento Pub/Sub in ricevono i messaggi da Kafka.
   • PUBSUB_SUBSCRIPTION: il nome di un abbonamento Pub/Sub per l'argomento.

2. Apri il file /config/cps-sink-connector.properties in un editor di testo. Aggiungi per le seguenti proprietà, contrassegnate come "TODO" nel commenti:

   topics=KAFKA_TOPICS
   cps.project=PROJECT_ID
   cps.topic=PUBSUB_TOPIC

   Sostituisci quanto segue:

   • KAFKA_TOPICS: un elenco separato da virgole di argomenti Kafka da leggere da cui proviene.
   • PROJECT_ID: il progetto Google Cloud che contiene lo argomento Pub/Sub.
   • PUBSUB_TOPIC: l'argomento Pub/Sub per ricevere i messaggi da Kafka.

3. Dalla directory Kafka, esegui questo comando:

   bin/connect-standalone.sh \
     config/connect-standalone.properties \
     config/cps-sink-connector.properties
   

4. Segui i passaggi descritti nella guida introduttiva ad Apache Kafka per scrivere alcuni eventi nell'argomento Kafka.

5. Utilizza l'interfaccia a riga di comando gcloud per leggere gli eventi da Pub/Sub.

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION --auto-ack

Inoltrare messaggi da Pub/Sub a Kafka

Questa sezione descrive come avviare il connettore di origine e pubblicare messaggi in Pub/Sub e leggere i messaggi inoltrati da Kafka.

1. Utilizza gcloud CLI per creare un argomento Pub/Sub con un abbonamento.

   gcloud pubsub topics create PUBSUB_TOPIC
   gcloud pubsub subscriptions create PUBSUB_SUBSCRIPTION --topic=PUBSUB_TOPIC

   Sostituisci quanto segue:

   • PUBSUB_TOPIC: il nome di un argomento Pub/Sub.
   • PUBSUB_SUBSCRIPTION: il nome di un Pub/Sub abbonamento.

2. Apri il file denominato /config/cps-source-connector.properties in un messaggio di testo editor. Aggiungi valori per le seguenti proprietà, contrassegnate come "TODO" in i commenti:

   kafka.topic=KAFKA_TOPIC
   cps.project=PROJECT_ID
   cps.subscription=PUBSUB_SUBSCRIPTION

   Sostituisci quanto segue:

   • KAFKA_TOPIC: gli argomenti Kafka per ricevere i messaggi Pub/Sub.
   • PROJECT_ID: il progetto Google Cloud che contiene Pub/Sub.
   • PUBSUB_TOPIC: l'argomento Pub/Sub.

3. Dalla directory Kafka, esegui questo comando:

   bin/connect-standalone.sh \
     config/connect-standalone.properties \
     config/cps-source-connector.properties
   

4. Utilizza l'interfaccia a riga di comando gcloud per pubblicare un messaggio in Pub/Sub.

   gcloud pubsub topics publish PUBSUB_TOPIC --message="message 1"

5. Leggi il messaggio da Kafka. Segui i passaggi nella Guida rapida di Apache Kafka per leggere i messaggi dall'argomento Kafka.

Conversione dei messaggi

Un record Kafka contiene una chiave e un valore, che sono array di byte a lunghezza variabile. Se vuoi, un record Kafka può avere anche intestazioni, che sono coppie chiave/valore. Un messaggio Pub/Sub è composto da due parti principali: il corpo del messaggio e zero o più attributi chiave-valore.

Kafka Connect utilizza i convertitori per serializzare chiavi e valori verso e da Kafka. Per controllare la serializzazione, imposta le seguenti proprietà nei file di configurazione del connettore:

• key.converter: il convertitore utilizzato per serializzare le chiavi dei record.
• value.converter: il convertitore utilizzato per serializzare i valori dei record.

Il corpo di un messaggio Pub/Sub è un oggetto ByteString, quindi La conversione più efficiente consiste nel copiare direttamente il payload. Per questo motivo, consigliamo di utilizzare un convertitore che generi tipi di dati primitivi (numero intero, numero intero, stringa o schema di byte) se possibile, per evitare la deserializzazione e rializziamo lo stesso corpo del messaggio.

Conversione da Kafka a Pub/Sub

Il connettore sink converte i record Kafka in messaggi Pub/Sub come segue:

• La chiave del record Kafka viene archiviata come attributo denominato "key" nel messaggio Pub/Sub.
• Per impostazione predefinita, il connettore elimina tutte le intestazioni nel record Kafka. Tuttavia, se impostate l'opzione di configurazione headers.publish su true, il connettore scrive le intestazioni come attributi Pub/Sub. Il connettore ignora tutte le intestazioni che superano i limiti di Pub/Sub per gli attributi dei messaggi.
• Per gli schemi con numeri interi, in virgola mobile, stringa e byte, il connettore passa i byte del valore del record Kafka direttamente nel messaggio Pub/Sub del testo.
• Per gli schemi struct, il connettore scrive ogni campo come attributo del un messaggio Pub/Sub. Ad esempio, se il campo è { "id"=123 }, il messaggio Pub/Sub risultante ha l'attributo "id"="123". La viene sempre convertito in una stringa. I tipi di mappa e struct non sono supportati come tipi di campo all'interno di uno struct.
• Per gli schemi mappa, il connettore scrive ogni coppia chiave-valore come attributo del messaggio Pub/Sub. Ad esempio, se la mappa è {"alice"=1,"bob"=2}, il messaggio Pub/Sub risultante ha due "alice"="1" e "bob"="2". Le chiavi e i valori vengono convertiti in stringhe.

Gli schemi di struttura e mappa presentano alcuni comportamenti aggiuntivi:

• Se vuoi, puoi specificare un determinato campo della struttura o una chiave della mappa come corpo del messaggio impostando la proprietà di configurazione messageBodyName. La del campo o della chiave viene archiviato come ByteString nel corpo del messaggio. Se non imposti messageBodyName, il corpo del messaggio è vuoto per gli schemi struct e map.

• Per i valori degli array, il connettore supporta solo tipi di array primitivi. La sequenza di valori nell'array viene concatenata in un singolo oggetto ByteString.

Conversione da Pub/Sub a Kafka

Il connettore di origine converte i messaggi Pub/Sub in record Kafka come segue:

• Chiave di registrazione Kafka: per impostazione predefinita, la chiave è impostata su null. Facoltativamente, puoi specificare un attributo di messaggio Pub/Sub da usare come chiave, impostare l'opzione di configurazione kafka.key.attribute. In questo caso, cerca un attributo con quel nome e imposta la chiave di record sul valore dell'attributo. Se l'attributo specificato non è presente, la chiave di record è impostato su null.

• Valore del record Kafka. Il connettore scrive il valore del record come segue:

  • Se il messaggio Pub/Sub non ha attributi personalizzati, scrive il corpo del messaggio Pub/Sub direttamente nel record Kafka come tipo byte[], utilizzando il convertitore specificato value.converter.

  • Se il messaggio Pub/Sub ha attributi personalizzati e kafka.record.headers è false, il connettore scrive una struct nel valore del record. Lo struct contiene un campo per ogni attributo e un campo denominato "message" il cui valore è il corpo del messaggio Pub/Sub (archiviati come byte):

    {
      "message": "<Pub/Sub message body>",
      "<attribute-1>": "<value-1>",
      "<attribute-2>": "<value-2>",
      ....
    }
    

    In questo caso, devi utilizzare un value.converter che sia compatibile con struct schemi, ad esempio org.apache.kafka.connect.json.JsonConverter.

  • Se il messaggio Pub/Sub ha attributi personalizzati e kafka.record.headers è true, il connettore scrive gli attributi come intestazioni dei record Kafka. Scrive il corpo del messaggio Pub/Sub direttamente al valore del record Kafka come tipo byte[], utilizzando il convertitore specificato da value.converter.

• Intestazioni dei record Kafka. Per impostazione predefinita, le intestazioni sono vuote, a meno che non imposti Da kafka.record.headers a true.

Nota: nella configurazione del broker Kafka, imposta message.max.bytes su un valore sufficientemente grande per gestire i messaggi Pub/Sub. Pub/Sub ha un limite di dimensioni dei messaggi.

Opzioni di configurazione

Oltre alle configurazioni fornite dall'API Kafka Connect, Il connettore Kafka del gruppo Pub/Sub supporta la configurazione di sink e origine come descritti in Configurazioni del connettore Pub/Sub.

Richiedere assistenza

Se hai bisogno di aiuto, crea un ticket di assistenza. Per domande e discussioni generali, crea un problema nel repository GitHub.

Passaggi successivi

• Comprendere le differenze tra Kafka e Pub/Sub.
• Scopri di più sul connettore Kafka del gruppo Pub/Sub.
• Visualizza il connettore Kafka del gruppo Pub/Sub Repository GitHub.