Mensajes de pedido

El orden de los mensajes es una función de Pub/Sub que te permite recibir mensajes en tus clientes suscriptores en el orden en que los publicaron los clientes publicadores.

Por ejemplo, supongamos que un cliente publicador en una región publica los mensajes 1, 2 y 3 en orden. Con el ordenamiento de mensajes, el cliente suscriptor recibe los mensajes publicados en el mismo orden. Para que se entreguen en orden, el cliente del publicador debe publicar los mensajes en la misma región. Sin embargo, los suscriptores pueden conectarse a cualquier región y la garantía de pedido se mantiene.

El orden de los mensajes es una función útil para situaciones como la captura de cambios en la base de datos, el seguimiento de sesiones de los usuarios y las aplicaciones de transmisión en las que es importante preservar la cronología de los eventos.

En esta página, se explica el concepto de ordenamiento de mensajes y cómo configurar tus clientes de suscriptores para que reciban mensajes en orden. Para configurar tus clientes de publicador para el ordenamiento de mensajes, consulta Cómo usar claves de ordenamiento para publicar un mensaje.

Descripción general del ordenamiento de mensajes

El orden en Pub/Sub se determina según lo siguiente:

• Clave de ordenamiento: Es una cadena que se usa en los metadatos de los mensajes de Pub/Sub y representa la entidad para la que se deben ordenar los mensajes. La clave de orden puede tener un máximo de 1 KB. Para recibir un conjunto de mensajes ordenados en una región, debes publicar todos los mensajes con la misma clave de ordenamiento en la misma región. Algunos ejemplos de claves de ordenamiento son los IDs de cliente y la clave primaria de una fila en una base de datos.

  La capacidad de procesamiento de publicación en cada clave de ordenamiento se limita a 1 MBps. La productividad de todos los temas de orden en un tema se limita a la cuota disponible en una región de publicación. Este límite se puede aumentar a muchas unidades de GBps.

  Una clave de orden no es equivalente a una partición en un sistema de mensajería basado en particiones, ya que se espera que las claves de orden tengan una cardinalidad mucho más alta que las particiones.

• Habilita el ordenamiento de mensajes: Este es un parámetro de configuración de la suscripción. Cuando una suscripción tiene habilitado el ordenamiento de mensajes, los clientes suscriptores reciben los mensajes publicados en la misma región con la misma clave de ordenamiento en el orden en que el servicio los recibió. Debes habilitar este parámetro de configuración en la suscripción.

  Supongamos que tienes dos suscripciones, A y B, vinculadas al mismo tema T. La suscripción A está configurada con el ordenamiento de mensajes habilitado y la suscripción B está configurada sin el ordenamiento de mensajes habilitado. En esta arquitectura, las suscripciones A y B reciben el mismo conjunto de mensajes del tema T. Si publicas mensajes con claves de ordenamiento en la misma región, la suscripción A recibe los mensajes en el orden en que se publicaron. Mientras que la suscripción B recibe los mensajes sin ningún orden esperado.

En general, si tu solución requiere que los clientes del publicador envíen mensajes ordenados y desordenados, crea temas separados, uno para los mensajes ordenados y otro para los desordenados.

Consideraciones para usar la mensajería ordenada

La siguiente lista contiene información importante sobre el comportamiento de los mensajes ordenados en Pub/Sub:

• Ordenamiento dentro de la clave: Se espera que los mensajes publicados con la misma clave de ordenamiento se reciban en orden. Supongamos que, para la clave de ordenamiento A, publicas los mensajes 1, 2 y 3. Con el orden habilitado, se espera que 1 se entregue antes que 2, y que 2 se entregue antes que 3.

• Ordenamiento entre claves: No se espera que los mensajes publicados con diferentes claves de ordenamiento se reciban en orden. Supongamos que tienes las claves de orden A y B. Para la clave de ordenamiento A, los mensajes 1 y 2 se publican en orden. Para la clave de ordenamiento B, los mensajes 3 y 4 se publican en orden. Sin embargo, el mensaje 1 podría llegar antes o después del mensaje 4.

• Reenvío de mensajes: Pub/Sub entrega cada mensaje al menos una vez, por lo que el servicio de Pub/Sub podría volver a entregarlos. Las reenviaciones de un mensaje activan la reenvío de todos los mensajes posteriores para esa clave, incluso los confirmados. Supongamos que un cliente suscriptor recibe los mensajes 1, 2 y 3 para una clave de ordenamiento específica. Si se vuelve a entregar el mensaje 2 (porque venció el plazo de confirmación o no persistió la confirmación del mejor esfuerzo en Pub/Sub), también se volverá a entregar el mensaje 3. Si el orden de los mensajes y un tema de mensajes no entregados están habilitados en una suscripción, es posible que este comportamiento no sea así, ya que Pub/Sub reenvía mensajes a temas de mensajes no entregados en base del mejor esfuerzo.

• Demoras en la confirmación y temas de mensajes no entregados: Los mensajes no confirmados para una clave de orden determinada pueden retrasar la entrega de mensajes para otras claves de orden, en especial durante los reinicios del servidor o los cambios de tráfico. Para mantener el orden en esos eventos, asegúrate de confirmar todos los mensajes de forma oportuna. Si no es posible confirmar los mensajes de forma oportuna, considera usar un tema de mensajes no entregados para evitar que se retengan de forma indefinida. Ten en cuenta que es posible que el orden no se conserve cuando los mensajes se escriben en un tema de mensajes no entregados.

• Afinidad de mensajes (clientes de streamingPull): Los mensajes de la misma clave suelen entregarse al mismo cliente suscriptor de streamingPull. Se espera que haya afinidad cuando los mensajes estén pendientes para una clave de ordenamiento a un cliente de suscriptor específico. Si no hay mensajes pendientes, es posible que la afinidad cambie para el balanceo de cargas o las desconexiones del cliente.

  Para garantizar un procesamiento fluido incluso con posibles cambios de afinidad, es fundamental diseñar tu aplicación de streamingPull de manera que pueda controlar los mensajes en cualquier cliente para una clave de ordenamiento determinada.

• Integración con Dataflow: No habilites el orden de mensajes para las suscripciones cuando configures Dataflow con Pub/Sub. Dataflow tiene su propio mecanismo para ordenar los mensajes por completo, lo que garantiza el orden cronológico en todos los mensajes como parte de las operaciones de ventanas. Este método de ordenamiento difiere del enfoque basado en claves de ordenamiento de Pub/Sub. El uso de claves de ordenamiento con Dataflow puede reducir el rendimiento de la canalización.

• Ajuste de escala automático: La entrega ordenada de Pub/Sub se escala a miles de millones de claves de orden. Una mayor cantidad de claves de ordenamiento permite una entrega más simultánea a los suscriptores, ya que el ordenamiento se aplica a todos los mensajes con la misma clave de ordenamiento.

La entrega programada tiene algunas desventajas. En comparación con la entrega desordenada, la entrega ordenada disminuye la disponibilidad de publicación y aumenta la latencia de entrega de mensajes de extremo a extremo. En el caso de la entrega ordenada, la conmutación por error requiere coordinación para garantizar que los mensajes se escriban y lean en el orden correcto.

Para obtener más información sobre cómo usar el orden de los mensajes, consulta los siguientes temas de prácticas recomendadas:

• Prácticas recomendadas para los mensajes ordenados en la publicación

• Prácticas recomendadas para los mensajes ordenados en la suscripción

Comportamiento del cliente suscriptor para el ordenamiento de mensajes

Los clientes suscriptores reciben los mensajes en el orden en que se publicaron en una región específica. Pub/Sub admite diferentes formas de recibir mensajes, como clientes de suscriptores conectados a suscripciones de extracción y de envío. Las bibliotecas cliente usan streamingPull (con la excepción de PHP).

Para obtener más información sobre estos tipos de suscripción, consulta Elige un tipo de suscripción.

En las siguientes secciones, se explica lo que significa recibir mensajes en orden para cada tipo de cliente suscriptor.

Clientes suscriptores de StreamingPull

Cuando usas las bibliotecas cliente con streamingPull, debes especificar una devolución de llamada del usuario que se ejecute cada vez que un cliente suscriptor reciba un mensaje. Con las bibliotecas cliente, para cualquier clave de ordenamiento determinada, la devolución de llamada se ejecuta hasta completar los mensajes en el orden correcto. Si los mensajes se confirman dentro de esa devolución de llamada, todos los cálculos de un mensaje se realizan en orden. Sin embargo, si la devolución de llamada del usuario programa otro trabajo asíncrono en los mensajes, el cliente suscriptor debe asegurarse de que el trabajo asíncrono se realice en orden. Una opción es agregar mensajes a una cola de trabajo local que se procese en orden.

Clientes suscriptores de extracción

En el caso de los clientes suscriptores conectados a suscripciones de extracción, el orden de los mensajes de Pub/Sub admite lo siguiente:

• Todos los mensajes de una clave de ordenamiento en PullResponse están en el orden correcto en la lista.

• Solo se puede tener un lote de mensajes pendiente para una clave de ordenamiento a la vez.

El requisito de que solo se pueda tener un lote de mensajes pendiente a la vez es necesario para mantener la entrega ordenada, ya que el servicio de Pub/Sub no puede garantizar el éxito o la latencia de la respuesta que envía para la solicitud de extracción de un suscriptor.

Clientes suscriptores de envío

Las restricciones de push son aún más estrictas que las de pull. En el caso de una suscripción de envío, Pub/Sub solo admite un mensaje pendiente para cada clave de ordenamiento a la vez. Cada mensaje se envía a un extremo push como una solicitud independiente. Por lo tanto, enviar las solicitudes en paralelo tendría el mismo problema que entregar varios lotes de mensajes para la misma clave de ordenamiento para extraer suscriptores de forma simultánea. Es posible que las suscripciones push no sean una buena opción para los temas en los que los mensajes se publican con frecuencia con la misma clave de ordenamiento o en los que la latencia es extremadamente importante.

Cómo exportar clientes suscriptores

Las suscripciones de exportación admiten mensajes ordenados. En el caso de las suscripciones a BigQuery, los mensajes con la misma clave de ordenamiento se escriben en su tabla de BigQuery en orden. En el caso de las suscripciones a Cloud Storage, es posible que no todos los mensajes con la misma clave de ordenamiento se escriban en el mismo archivo. Cuando se encuentran en el mismo archivo, los mensajes de una clave de ordenamiento están en orden. Cuando se distribuyen en varios archivos, los mensajes posteriores de una clave de orden pueden aparecer en un archivo con un nombre que tiene una marca de tiempo anterior a la marca de tiempo del nombre del archivo con los mensajes anteriores.

Habilita el ordenamiento de mensajes

Para recibir los mensajes en orden, configura la propiedad de ordenamiento de mensajes de la suscripción de la que recibes mensajes. Recibir mensajes en orden puede aumentar la latencia. No puedes cambiar la propiedad de orden de los mensajes después de crear una suscripción.

Puedes configurar la propiedad de ordenamiento de mensajes cuando creas una suscripción con la consola de Google Cloud, Google Cloud CLI o la API de Pub/Sub.

gcloud pubsub subscriptions create SUBSCRIPTION_ID \
  --enable-message-ordering

Created subscription [SUBSCRIPTION_ID].

PUT https://pubsub.googleapis.com/v1/projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID
Authorization: Bearer $(gcloud auth application-default print-access-token)

{
  "topic": TOPIC_ID,
  "enableMessageOrdering": true,
}

{
  "name": projects/PROJECT_ID/subscriptions/SUBSCRIPTION_ID,
  "topic": projects/PROJECT_ID/topics/TOPIC_ID,
  "enableMessageOrdering": true,
}

namespace pubsub = ::google::cloud::pubsub;
namespace pubsub_admin = ::google::cloud::pubsub_admin;
[](pubsub_admin::SubscriptionAdminClient client,
   std::string const& project_id, std::string const& topic_id,
   std::string const& subscription_id) {
  google::pubsub::v1::Subscription request;
  request.set_name(
      pubsub::Subscription(project_id, subscription_id).FullName());
  request.set_topic(pubsub::Topic(project_id, topic_id).FullName());
  request.set_enable_message_ordering(true);
  auto sub = client.CreateSubscription(request);
  if (sub.status().code() == google::cloud::StatusCode::kAlreadyExists) {
    std::cout << "The subscription already exists\n";
    return;
  }
  if (!sub) throw std::move(sub).status();

  std::cout << "The subscription was successfully created: "
            << sub->DebugString() << "\n";
}

using Google.Cloud.PubSub.V1;
using Grpc.Core;

public class CreateSubscriptionWithOrderingSample
{
    public Subscription CreateSubscriptionWithOrdering(string projectId, string topicId, string subscriptionId)
    {
        SubscriberServiceApiClient subscriber = SubscriberServiceApiClient.Create();
        var topicName = TopicName.FromProjectTopic(projectId, topicId);
        var subscriptionName = SubscriptionName.FromProjectSubscription(projectId, subscriptionId);

        var subscriptionRequest = new Subscription
        {
            SubscriptionName = subscriptionName,
            TopicAsTopicName = topicName,
            EnableMessageOrdering = true
        };

        Subscription subscription = null;
        try
        {
            subscription = subscriber.CreateSubscription(subscriptionRequest);
        }
        catch (RpcException e) when (e.Status.StatusCode == StatusCode.AlreadyExists)
        {
            // Already exists.  That's fine.
        }
        return subscription;
    }
}

import (
	"context"
	"fmt"
	"io"
	"time"

	"cloud.google.com/go/pubsub"
)

func createWithOrdering(w io.Writer, projectID, subID string, topic *pubsub.Topic) error {
	// projectID := "my-project-id"
	// subID := "my-sub"
	// topic of type https://godoc.org/cloud.google.com/go/pubsub#Topic
	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	// Message ordering can only be set when creating a subscription.
	sub, err := client.CreateSubscription(ctx, subID, pubsub.SubscriptionConfig{
		Topic:                 topic,
		AckDeadline:           20 * time.Second,
		EnableMessageOrdering: true,
	})
	if err != nil {
		return fmt.Errorf("CreateSubscription: %w", err)
	}
	fmt.Fprintf(w, "Created subscription: %v\n", sub)
	return nil
}

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

public class CreateSubscriptionWithOrdering {
  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";

    createSubscriptionWithOrderingExample(projectId, topicId, subscriptionId);
  }

  public static void createSubscriptionWithOrderingExample(
      String projectId, String topicId, String subscriptionId) throws IOException {
    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())
                  // Set message ordering to true for ordered messages in the subscription.
                  .setEnableMessageOrdering(true)
                  .build());

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

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID';

// Imports the Google Cloud client library
const {PubSub} = require('@google-cloud/pubsub');

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function createSubscriptionWithOrdering(
  topicNameOrId,
  subscriptionNameOrId
) {
  // Creates a new subscription
  await pubSubClient
    .topic(topicNameOrId)
    .createSubscription(subscriptionNameOrId, {
      enableMessageOrdering: true,
    });
  console.log(
    `Created subscription ${subscriptionNameOrId} with ordering enabled.`
  );
  console.log(
    'To process messages in order, remember to add an ordering key to your messages.'
  );
}

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const subscriptionNameOrId = 'YOUR_SUBSCRIPTION_NAME_OR_ID';

// Imports the Google Cloud client library
import {PubSub} from '@google-cloud/pubsub';

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function createSubscriptionWithOrdering(
  topicNameOrId: string,
  subscriptionNameOrId: string
) {
  // Creates a new subscription
  await pubSubClient
    .topic(topicNameOrId)
    .createSubscription(subscriptionNameOrId, {
      enableMessageOrdering: true,
    });
  console.log(
    `Created subscription ${subscriptionNameOrId} with ordering enabled.`
  );
  console.log(
    'To process messages in order, remember to add an ordering key to your messages.'
  );
}

from google.cloud import pubsub_v1

# 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)

with subscriber:
    subscription = subscriber.create_subscription(
        request={
            "name": subscription_path,
            "topic": topic_path,
            "enable_message_ordering": True,
        }
    )
    print(f"Created subscription with ordering: {subscription}")

# topic_id        = "your-topic-id"
# subscription_id = "your-subscription-id"

pubsub = Google::Cloud::Pubsub.new

topic        = pubsub.topic topic_id
subscription = topic.subscribe subscription_id,
                               message_ordering: true

puts "Pull subscription #{subscription_id} created with message ordering."

¿Qué sigue?

• Lee la entrada de blog sobre la entrega ordenada.

• Para continuar publicando mensajes en el caso de errores que no se pueden reintentar, consulta Cómo reintentar solicitudes con claves de ordenamiento.

• Supervisa tu suscripción.

• Obtén información para publicar mensajes con claves de ordenamiento.