Connettere Pub/Sub ad Apache Kafka

Questo documento descrive come integrare Apache Kafka e Pub/Sub utilizzando il connettore Kafka del gruppo Pub/Sub.

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

Informazioni sul connettore Kafka del gruppo Pub/Sub

Apache Kafka è una piattaforma open source per l'inserimento di flussi di eventi. È comunemente utilizzato in architetture distribuite per consentire la comunicazione tra componenti a basso accoppiamento. Pub/Sub è un servizio gestito per inviare e ricevere messaggi in modo asincrono. Come con Kafka, puoi utilizzare Pub/Sub per comunicare tra i componenti della tua architettura cloud.

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 li pubblica in Pub/Sub.
• Il connettore di origine legge i messaggi da un argomento Pub/Sub e li pubblica in Kafka.

Ecco alcuni scenari in cui potresti utilizzare il connettore Kafka del gruppo Pub/Sub:

• Stai eseguendo la migrazione di un'architettura basata su Kafka a Google Cloud.
• Hai un sistema di frontend che archivia gli eventi in Kafka al di fuori di Google Cloud, ma utilizzi anche Google Cloud per eseguire alcuni dei tuoi servizi di 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 di frontend che utilizza Google Cloud, ma archivi anche dati on-premise mediante Kafka.

Il connettore richiede Kafka Connect, che è un framework per il flusso di dati tra Kafka e altri sistemi. Per utilizzare il connettore, devi eseguire Kafka Connect insieme al cluster Kafka.

Questo documento presuppone che tu abbia familiarità sia con Kafka che con 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 gli ACL Google Cloud IAM e Kafka Connect.

Inizia a utilizzare il connettore

Questa sezione illustra le seguenti attività:

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

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

Prerequisiti

Installa Kafka

Segui la guida rapida di Apache Kafka per installare Kafka a nodo singolo sulla macchina locale. Completa questi passaggi nella guida rapida:

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

Autentica

Il connettore Kafka del gruppo Pub/Sub deve eseguire l'autenticazione con Pub/Sub per poter inviare e ricevere messaggi Pub/Sub. Per configurare l'autenticazione, esegui questi passaggi:

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
2. Installa Google Cloud CLI.

3. Per initialize gcloud CLI, esegui questo comando:

   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. Crea credenziali di autenticazione locali per il tuo Account Google:

   gcloud auth application-default login

6. Concedi i ruoli al tuo Account Google. Esegui questo comando una volta per ciascuno dei seguenti ruoli IAM: roles/pubsub.admin

   gcloud projects add-iam-policy-binding PROJECT_ID --member="user:EMAIL_ADDRESS" --role=ROLE

   • Sostituisci PROJECT_ID con l'ID progetto.
   • Sostituisci EMAIL_ADDRESS con il tuo indirizzo email.
   • Sostituisci ROLE con ogni singolo ruolo.
7. Installa Google Cloud CLI.

8. Per initialize gcloud CLI, esegui questo comando:

   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. Crea credenziali di autenticazione locali per il tuo Account Google:

    gcloud auth application-default login

11. Concedi i ruoli al tuo Account Google. Esegui questo comando una volta per ciascuno dei seguenti ruoli IAM: roles/pubsub.admin

    gcloud projects add-iam-policy-binding PROJECT_ID --member="user:EMAIL_ADDRESS" --role=ROLE

    • Sostituisci PROJECT_ID con l'ID progetto.
    • Sostituisci EMAIL_ADDRESS con il tuo indirizzo email.
    • Sostituisci ROLE con ogni singolo ruolo.

Nota: per i carichi di lavoro di produzione, consigliamo di utilizzare la federazione delle identità per i carichi di lavoro per l'autenticazione.

Scarica il JAR del connettore

Scarica il file JAR del connettore sul computer locale. Per maggiori informazioni, consulta Acquisire il connettore nel file Leggimi 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 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 scaricato.
2. Nella directory binaria Kafka Connect, apri il file denominato config/connect-standalone.properties in un editor di testo.
3. Se plugin.path property ha un commento, 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 di offset.

   Esempio:

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

Inoltra eventi da Kafka a Pub/Sub

Questa sezione descrive come avviare il connettore sink, pubblicare eventi in Kafka e quindi 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 per ricevere i messaggi da Kafka.
   • PUBSUB_SUBSCRIPTION: il nome di una sottoscrizione Pub/Sub per l'argomento.

2. Apri il file /config/cps-sink-connector.properties in un editor di testo. Aggiungi i valori per le seguenti proprietà, contrassegnate con "TODO" nei 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 cui leggere.
   • PROJECT_ID: il progetto Google Cloud che contiene l'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 nella guida rapida di Apache Kafka per scrivere alcuni eventi nel tuo argomento Kafka.

5. Utilizza gcloud CLI 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, pubblicare messaggi in Pub/Sub e leggere i messaggi inoltrati da Kafka.

1. Utilizza gcloud 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.
   • PUBSUB_SUBSCRIPTION: il nome di una sottoscrizione Pub/Sub.

2. Apri il file denominato /config/cps-source-connector.properties in un editor di testo. Aggiungi valori per le seguenti proprietà, contrassegnate con "TODO" nei 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 l'argomento 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 gcloud CLI per pubblicare un messaggio in Pub/Sub.

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

5. Leggere il messaggio di 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. Facoltativamente, un record Kafka può anche avere intestazioni, che sono coppie chiave/valore. Un messaggio Pub/Sub ha due parti principali: il corpo del messaggio e zero o più attributi chiave-valore.

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

• key.converter: il convertitore utilizzato per serializzare le chiavi di registrazione.
• 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, se possibile, ti consigliamo di utilizzare un convertitore che produce tipi di dati primitivi (schema a numero intero, a virgola mobile, stringa o byte), se possibile, per evitare la deserializzazione e la reserializzazione dello stesso corpo del messaggio.

Conversione da Kafka a Pub/Sub

Il connettore sink converte i record Kafka in messaggi Pub/Sub nel seguente modo:

• La chiave di record Kafka è archiviata come attributo denominato "key" nel messaggio Pub/Sub.
• Per impostazione predefinita, il connettore elimina qualsiasi intestazione nel record Kafka. Tuttavia, se imposti 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 degli attributi dei messaggi di Pub/Sub.
• Per gli schemi interi, in virgola mobile, stringa e byte, il connettore passa i byte del valore del record Kafka direttamente nel corpo del messaggio Pub/Sub.
• Per gli schemi struct, il connettore scrive ogni campo come attributo del messaggio Pub/Sub. Ad esempio, se il campo è { "id"=123 }, il messaggio Pub/Sub risultante ha un attributo "id"="123". Il valore del campo 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 di 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 attributi, "alice"="1" e "bob"="2". Le chiavi e i valori vengono convertiti in stringhe.

Gli schemi di struttura e mappa presentano alcuni comportamenti aggiuntivi:

• Facoltativamente, puoi specificare un determinato campo di struct o una chiave di mappa come corpo del messaggio impostando la proprietà di configurazione messageBodyName. Il valore 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 di struct e map.

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

Conversione da Pub/Sub a Kafka

Il connettore di origine converte i messaggi Pub/Sub in record Kafka nel modo seguente:

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

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

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

  • Se il messaggio Pub/Sub contiene attributi personalizzati e kafka.record.headers è false, il connettore scrive uno 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 (archiviato come byte):

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

    In questo caso, devi utilizzare un valore value.converter che sia compatibile con gli schemi di struct, come org.apache.kafka.connect.json.JsonConverter.

  • Se il messaggio Pub/Sub contiene attributi personalizzati e kafka.record.headers è true, il connettore scrive gli attributi come intestazioni del record Kafka. Scrive il corpo del messaggio Pub/Sub direttamente nel 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 kafka.record.headers su true.

Nota: nella configurazione del tuo broker Kafka, imposta message.max.bytes abbastanza grande da gestire i tuoi messaggi Pub/Sub. Pub/Sub ha una dimensione massima dei messaggi.

Opzioni di configurazione

Oltre alle configurazioni fornite dall'API Kafka Connect, il connettore Kafka del gruppo Pub/Sub supporta le seguenti configurazioni.

Opzioni di configurazione del connettore sink

Il connettore sink supporta le seguenti opzioni di configurazione.

Impostazione	Tipo di dati	Descrizione
connector.class	String	Obbligatorio. La classe Java per il connettore. Per il connettore sink Pub/Sub, il valore deve essere com.google.pubsub.kafka.sink.CloudPubSubSinkConnector.
cps.endpoint	String	L'endpoint Pub/Sub da utilizzare. Valore predefinito: "pubsub.googleapis.com:443".
cps.project	String	Obbligatorio. Il cloud che contiene l'argomento Pub/Sub.
cps.topic	String	Obbligatorio. L'argomento Pub/Sub in cui pubblicare i record Kafka.
gcp.credentials.file.path	String	Facoltativo. Il percorso di un file in cui sono archiviate le credenziali di Google Cloud per l'autenticazione di Pub/Sub Lite.
gcp.credentials.json	String	Facoltativo. Un BLOB JSON che contiene Google Cloud per l'autenticazione di Pub/Sub Lite.
headers.publish	Boolean	Quando true, includi eventuali intestazioni di record Kafka come attributi dei messaggi Pub/Sub. Valore predefinito: false.
maxBufferBytes	Long	Il numero massimo di byte da ricevere su una partizione Kafka di argomento prima di pubblicarli in Pub/Sub. Valore predefinito: 10000000.
maxBufferSize	Integer	Il numero massimo di record da ricevere su una partizione di un argomento Kafka prima di pubblicarli in Pub/Sub. Valore predefinito: 100.
maxDelayThresholdMs	Integer	Il tempo massimo di attesa in millisecondi per raggiungere maxBufferSize o maxBufferBytes prima di pubblicare record in sospeso in Pub/Sub. Valore predefinito: 100.
maxOutstandingMessages	Long	Il numero massimo di record che possono essere in sospeso, inclusi batch incompleti e in attesa, prima che il publisher blocchi ulteriori pubblicazioni. Valore predefinito: Long.MAX_VALUE.
maxOutstandingRequestBytes	Long	Il numero massimo di byte totali che possono essere in sospeso, inclusi i batch incompleti e in attesa, prima che il publisher blocchi l'ulteriore pubblicazione. Valore predefinito: Long.MAX_VALUE.
maxRequestTimeoutMs	Integer	Timeout in millisecondi per le singole richieste di pubblicazione in Pub/Sub. Valore predefinito: 10000.
maxTotalTimeoutMs	Integer	Timeout totale, in millisecondi, per una chiamata da pubblicare in Pub/Sub, inclusi i nuovi tentativi. Valore predefinito: 60.000.
metadata.publish	Boolean	Quando true, includi l'argomento, la partizione, l'offset e il timestamp Kafka come attributi dei messaggi Pub/Sub. Valore predefinito: false.
messageBodyName	String	Quando utilizzi uno schema di valori di struct o mappe, specifica il nome di un campo o di una chiave da utilizzare come corpo del messaggio Pub/Sub. Vedi Conversione da Kafka a Pub/Sub. Valore predefinito: "cps_message_body".
orderingKeySource	String	Specifica come impostare la chiave di ordinamento nel messaggio Pub/Sub. Può essere uno dei seguenti valori: none: non impostare la chiave di ordinamento. key: utilizza la chiave di record Kafka come chiave di ordinamento. partition: utilizza il numero di partizione, convertito in una stringa, come chiave di ordinamento. Utilizza questa impostazione solo per argomenti o argomenti a bassa velocità effettiva con migliaia di partizioni. Valore predefinito: none.
topics	String	Obbligatorio. Un elenco separato da virgole di argomenti Kafka da cui leggere.

Opzioni di configurazione del connettore di origine

Il connettore di origine supporta le seguenti opzioni di configurazione.

Impostazione	Tipo di dati	Descrizione
connector.class	String	Obbligatorio. La classe Java per il connettore. Per il connettore di origine Pub/Sub, il valore deve essere com.google.pubsub.kafka.source.CloudPubSubSourceConnector.
cps.endpoint	String	L'endpoint Pub/Sub da utilizzare. Valore predefinito: "pubsub.googleapis.com:443".
cps.makeOrderingKeyAttribute	Boolean	Quando true, scrivi la chiave di ordinamento nel record Kafka, utilizzando lo stesso formato degli attributi dei messaggi Pub/Sub. Vedi Conversione da record Pub/Sub a record Kafka. Valore predefinito: false.
cps.maxBatchSize	Integer	Il numero massimo di messaggi da eseguire in batch per ogni richiesta di pull verso Pub/Sub. Valore predefinito: 100
cps.project	String	Obbligatorio. Il progetto Google Cloud che contiene l'argomento Pub/Sub.
cps.subscription	String	Obbligatorio. Il nome della sottoscrizione Pub/Sub da cui eseguire il pull dei messaggi.
gcp.credentials.file.path	String	Facoltativo. Il percorso di un file in cui sono archiviate le credenziali di Google Cloud per l'autenticazione di Pub/Sub Lite.
gcp.credentials.json	String	Facoltativo. Un BLOB JSON che contiene Google Cloud per l'autenticazione di Pub/Sub Lite.
kafka.key.attribute	String	L'attributo del messaggio Pub/Sub da utilizzare come chiave per i messaggi pubblicati in Kafka. Se impostato su "orderingKey", utilizza la chiave di ordinamento del messaggio. Se null, i record Kafka non hanno una chiave. Valore predefinito: null.
kafka.partition.count	Integer	Il numero di partizioni Kafka per l'argomento Kafka in cui vengono pubblicati i messaggi. Questo parametro viene ignorato se lo schema di partizione è "kafka_partitioner". Valore predefinito: 1.
kafka.partition.scheme	String	Lo schema per assegnare un messaggio a una partizione in Kafka. Può essere uno dei seguenti valori: round_robin: assegna le partizioni in modo round robin. hash_key: trova la partizione eseguendo l'hashing della chiave del record. hash_value: trova la partizione eseguendo l'hashing del valore del record. kafka_partitioner: delega la logica di partizionamento al producer Kafka. Per impostazione predefinita, il producer di Kafka rileva automaticamente il numero di partizioni ed esegue la mappatura delle partizioni basata su hash murmur o il round robin, a seconda che venga fornita una chiave di record. ordering_key: utilizza il codice hash della chiave di ordinamento di un messaggio. Se non è presente alcuna chiave di ordinamento, utilizza round_robin. Valore predefinito: round_robin.
kafka.record.headers	Boolean	Se true, scrivi gli attributi dei messaggi Pub/Sub come intestazioni Kafka.
kafka.topic	String	Obbligatorio. L'argomento Kafka che riceve messaggi da 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.
• Vedi il Repository GitHub del connettore Kafka del gruppo Pub/Sub.