Escribe de Dataflow a Pub/Sub

En este documento, se describe cómo escribir datos de texto de Dataflow a Pub/Sub mediante el conector de E/S PubSubIO de Apache Beam.

Nota: Según tu situación, considera usar una de las plantillas de Dataflow proporcionadas por Google. Varias de estas plantillas generan resultados en Pub/Sub.

Descripción general

Para escribir datos en Pub/Sub, usa el conector PubSubIO. Los elementos de entrada pueden ser mensajes de Pub/Sub o solo los datos del mensaje. Si los elementos de entrada son mensajes de Pub/Sub, puedes establecer atributos o una clave de ordenamiento en cada mensaje de forma opcional.

Puedes usar la versión de Java, Python o Go del conector PubSubIO de la siguiente manera:

Java

Para escribir en un solo tema, llama al método PubsubIO.writeMessages. Este método toma una colección de entrada de objetos PubsubMessage. El conector también define métodos convenientes para escribir cadenas, mensajes Avro codificados en formato binario o mensajes protobuf codificados en formato binario. Estos métodos convierten la colección de entradas en mensajes de Pub/Sub.

Para escribir en un conjunto dinámico de temas según los datos de entrada, llama a writeMessagesDynamic. Especifica el tema de destino de cada mensaje mediante una llamada a PubsubMessage.withTopic en el mensaje. Por ejemplo, puedes enrutar mensajes a diferentes temas según el valor de un campo particular en tus datos de entrada.

Para obtener más información, consulta la documentación de referencia PubsubIO.

Python

Llama al método pubsub.WriteToPubSub. De forma predeterminada, este método toma una colección de entrada de tipo bytes que representa la carga útil del mensaje. Si el parámetro with_attributes es True, el método toma una colección de objetos PubsubMessage.

Para obtener más información, consulta la documentación de referencia del módulo pubsub.

Go

Para escribir datos en Pub/Sub, llama al método pubsubio.Write. Este método toma una colección de entrada de objetos PubSubMessage o porciones de bytes que contienen las cargas útiles del mensaje.

Para obtener más información, consulta la documentación de referencia paquete pubsubio.

Para obtener más información sobre los mensajes de Pub/Sub, consulta Formato del mensaje en la documentación de Pub/Sub.

Marcas de tiempo

Pub/Sub establece una marca de tiempo en cada mensaje. Esta marca de tiempo representa la hora en la que se publica el mensaje en Pub/Sub. En una situación de transmisión, también puede importar la marca de tiempo del evento, que es la hora en que se generaron los datos del mensaje. Puedes usar la marca de tiempo del elemento de Apache Beam para representar la hora del evento. Las fuentes que crean una PCollection no delimitada a menudo le asignan una marca de tiempo a cada elemento nuevo que corresponde a la hora del evento.

Para Java y Python, el conector de E/S de Pub/Sub puede escribir la marca de tiempo de cada elemento como un atributo de mensaje de Pub/Sub. Los consumidores de mensajes pueden usar este atributo para obtener la marca de tiempo del evento.

Java

Llama a PubsubIO.Write<T>.withTimestampAttribute y especifica el nombre del atributo.

Python

Especifica el parámetro timestamp_attribute cuando llames a WriteToPubSub.

Entrega de mensajes

Dataflow admite el procesamiento de mensajes exactamente una vez de mensajes dentro de una canalización. Sin embargo, el conector de E/S de Pub/Sub no puede garantizar la entrega de mensajes exactamente una vez a través de Pub/Sub.

Para Java y Python, puedes configurar el conector de E/S de Pub/Sub a fin de escribir el ID único de cada elemento como un atributo de mensaje. Luego, los consumidores de mensajes pueden usar este atributo para anular la duplicación de mensajes.

Java

Llama a PubsubIO.Write<T>.withIdAttribute y especifica el nombre del atributo.

Python

Especifica el parámetro id_label cuando llames a WriteToPubSub.

Ejemplos

En el siguiente ejemplo, se crea una PCollection de mensajes de Pub/Sub y los escribe en un tema de Pub/Sub. El tema se especifica como una opción de canalización. Cada mensaje contiene datos de carga útil y un conjunto de atributos.

Java

Para autenticarte en Dataflow, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.coders.DefaultCoder;
import org.apache.beam.sdk.extensions.avro.coders.AvroCoder;
import org.apache.beam.sdk.io.gcp.pubsub.PubsubIO;
import org.apache.beam.sdk.io.gcp.pubsub.PubsubMessage;
import org.apache.beam.sdk.options.Description;
import org.apache.beam.sdk.options.PipelineOptions;
import org.apache.beam.sdk.options.PipelineOptionsFactory;
import org.apache.beam.sdk.transforms.Create;
import org.apache.beam.sdk.transforms.MapElements;
import org.apache.beam.sdk.values.TypeDescriptor;

public class PubSubWriteWithAttributes {
  public interface Options extends PipelineOptions {
    @Description("The Pub/Sub topic to write to. Format: projects/<PROJECT>/topics/<TOPIC>")
    String getTopic();

    void setTopic(String value);
  }

  // A custom datatype for the source data.
  @DefaultCoder(AvroCoder.class)
  static class ExampleData {
    public String name;
    public String product;
    public Long timestamp; // Epoch time in milliseconds

    public ExampleData() {}

    public ExampleData(String name, String product, Long timestamp) {
      this.name = name;
      this.product = product;
      this.timestamp = timestamp;
    }
  }

  // Write messages to a Pub/Sub topic.
  public static void main(String[] args) {
    // Example source data.
    final List<ExampleData> messages = Arrays.asList(
        new ExampleData("Robert", "TV", 1613141590000L),
        new ExampleData("Maria", "Phone", 1612718280000L),
        new ExampleData("Juan", "Laptop", 1611618000000L),
        new ExampleData("Rebeca", "Videogame", 1610000000000L)
    );

    // Parse the pipeline options passed into the application. Example:
    //   ----runner=DirectRunner --topic=projects/MY_PROJECT/topics/MY_TOPIC"
    // For more information, see https://beam.apache.org/documentation/programming-guide/#configuring-pipeline-options
    var options = PipelineOptionsFactory.fromArgs(args).withValidation().as(Options.class);
    var pipeline = Pipeline.create(options);
    pipeline
        // Create some data to write to Pub/Sub.
        .apply(Create.of(messages))
        // Convert the data to Pub/Sub messages.
        .apply(MapElements
            .into(TypeDescriptor.of(PubsubMessage.class))
            .via((message -> {
              byte[] payload = message.product.getBytes(StandardCharsets.UTF_8);
              // Create attributes for each message.
              HashMap<String, String> attributes = new HashMap<String, String>();
              attributes.put("buyer", message.name);
              attributes.put("timestamp", Long.toString(message.timestamp));
              return new PubsubMessage(payload, attributes);
            })))
        // Write the messages to Pub/Sub.
        .apply(PubsubIO.writeMessages().to(options.getTopic()));
    pipeline.run().waitUntilFinish();
  }
}

Python

Para autenticarte en Dataflow, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

import argparse
from typing import Any, Dict, List

import apache_beam as beam
from apache_beam.io import PubsubMessage
from apache_beam.io import WriteToPubSub
from apache_beam.options.pipeline_options import PipelineOptions

from typing_extensions import Self

def item_to_message(item: Dict[str, Any]) -> PubsubMessage:
    # Re-import needed types. When using the Dataflow runner, this
    # function executes on a worker, where the global namespace is not
    # available. For more information, see:
    # https://cloud.google.com/dataflow/docs/guides/common-errors#name-error
    from apache_beam.io import PubsubMessage

    attributes = {
        'buyer': item['name'],
        'timestamp': str(item['ts'])
    }
    data = bytes(item['product'], 'utf-8')

    return PubsubMessage(data=data, attributes=attributes)

def write_to_pubsub(argv: List[str] = None) -> None:

    # Parse the pipeline options passed into the application. Example:
    #     --topic=$TOPIC_PATH --streaming
    # For more information, see
    # https://beam.apache.org/documentation/programming-guide/#configuring-pipeline-options
    class MyOptions(PipelineOptions):
        @classmethod
        # Define a custom pipeline option to specify the Pub/Sub topic.
        def _add_argparse_args(cls: Self, parser: argparse.ArgumentParser) -> None:
            parser.add_argument("--topic", required=True)

    example_data = [
        {'name': 'Robert', 'product': 'TV', 'ts': 1613141590000},
        {'name': 'Maria', 'product': 'Phone', 'ts': 1612718280000},
        {'name': 'Juan', 'product': 'Laptop', 'ts': 1611618000000},
        {'name': 'Rebeca', 'product': 'Video game', 'ts': 1610000000000}
    ]
    options = MyOptions()

    with beam.Pipeline(options=options) as pipeline:
        (
            pipeline
            | "Create elements" >> beam.Create(example_data)
            | "Convert to Pub/Sub messages" >> beam.Map(item_to_message)
            | WriteToPubSub(
                  topic=options.topic,
                  with_attributes=True)
        )

    print('Pipeline ran successfully.')