Ordenar mensagens

A ordem de mensagens é um recurso do Pub/Sub que permite receber mensagens nos clientes assinantes na ordem em que foram publicadas pelos clientes do editor.

Por exemplo, suponha que um cliente editor em uma região publique as mensagens 1, 2 e 3 em ordem. Com a ordenação de mensagens, o cliente assinante recebe as mensagens publicadas na mesma ordem. Para serem entregues em ordem, o cliente editor precisa publicar as mensagens na mesma região.

A ordem das mensagens é um recurso útil em cenários como captura de alterações no banco de dados, rastreamento de sessão do usuário e aplicativos de streaming em que é importante preservar a cronologia dos eventos.

Nesta página, explicamos o conceito de ordenação de mensagens e como configurar seus clientes assinantes para receber mensagens em ordem. Se quiser configurar seus clientes editores para a ordenação de mensagens, consulte Usar chaves de ordenação para publicar uma mensagem.

Visão geral da ordem das mensagens

A ordem no Pub/Sub é determinada pelo seguinte:

• Chave de ordem: é uma string usada nos metadados de mensagens do Pub/Sub e representa a entidade em que as mensagens precisam ser solicitadas. A chave de ordem pode ter até 1 KB de comprimento. Para receber um conjunto de mensagens ordenadas em uma região, publique todas as mensagens com a mesma chave de ordem na mesma região. Alguns exemplos de chaves de pedidos são IDs de clientes e a chave primária de uma linha em um banco de dados.

  A capacidade de publicação em cada chave de ordenação é limitada a 1 MBps. A capacidade em todas as chaves de ordenação em um tópico está limitada à cota disponível em uma região de publicação. Esse limite pode ser aumentado para muitas unidades de GBps.

  Uma chave de ordenação não é equivalente a uma partição em um sistema de mensagens baseado em partição, porque espera-se que as chaves de ordenação tenham uma cardinalidade muito maior que as partições.

• Ativar a ordenação de mensagens: esta é uma configuração de assinatura. Quando a ordenação de mensagens está ativada em uma assinatura, os clientes assinantes recebem mensagens publicadas na mesma região com a mesma chave de ordem na ordem em que foram recebidas pelo serviço. É necessário ativar essa configuração na assinatura.

  Suponha que você tenha duas assinaturas A e B anexadas ao mesmo tópico T. A assinatura A é configurada com a ordem de mensagens ativada, e a assinatura B configurada sem a ordem de mensagens ativada. Nessa arquitetura, as assinaturas A e B recebem o mesmo conjunto de mensagens do tópico T. Se você publicar mensagens com chaves de ordenação na mesma região, a assinatura A receberá as mensagens na ordem em que foram publicadas. Por outro lado, a assinatura B recebe as mensagens sem nenhuma ordem esperada.

Em geral, se a solução exige que os clientes do editor enviem mensagens ordenadas e não ordenadas, crie tópicos separados, um para mensagens ordenadas e outro para mensagens não ordenadas.

Considerações ao usar mensagens ordenadas

A lista a seguir contém informações importantes sobre o comportamento de mensagens ordenadas no Pub/Sub:

• Ordem dentro da chave: as mensagens publicadas com a mesma chave de ordem precisam ser recebidas em ordem. Suponha que, para ordenar a chave A, você publique as mensagens 1, 2 e 3. Com a ordenação ativada, espera-se que 1 seja entregue antes de 2 e que 2 seja entregue antes de 3.

• Ordem cruzada: as mensagens publicadas com chaves de ordem diferentes não são recebidas em ordem. Suponha que você tenha as chaves de ordenação A e B. Para ordenar a chave A, as mensagens 1 e 2 são publicadas em ordem. Para ordenar a chave B, as mensagens 3 e 4 são publicadas em ordem. No entanto, a mensagem 1 pode chegar antes ou depois da mensagem 4.

• Reenvio de mensagens: o Pub/Sub entrega cada mensagem pelo menos uma vez. Dessa forma, o serviço Pub/Sub pode reenviar mensagens. O reenvio de uma mensagem aciona o reenvio de todas as mensagens subsequentes para essa chave, mesmo as confirmadas. Suponha que um cliente assinante receba as mensagens 1, 2 e 3 referentes a uma chave de ordem específica. Se a mensagem 2 for entregue novamente (porque o prazo de confirmação expirou ou a confirmação de melhor esforço não persistiu no Pub/Sub), a mensagem 3 também será reenviada. Se a ordem de mensagens e um tópico de mensagens inativas estiverem ativados em uma assinatura, esse comportamento poderá não ser verdadeiro, porque o Pub/Sub encaminha mensagens para tópicos de mensagens inativas com base no melhor esforço.

• Atrasos de confirmação e tópicos de mensagens inativas: mensagens não confirmadas para uma determinada chave de ordem podem atrasar a entrega de mensagens para outras chaves de ordem, especialmente durante reinicializações do servidor ou alterações de tráfego. Para manter a ordem nesses eventos, confirme o reconhecimento oportuno de todas as mensagens. Se não for possível fazer a confirmação em tempo hábil, use um tópico de mensagens inativas para evitar a retenção de mensagens por tempo indeterminado. A ordem pode não ser preservada quando as mensagens são gravadas em um tópico de mensagens inativas.

• Afinidade de mensagens (clientes streamingPull): as mensagens para a mesma chave geralmente são entregues ao mesmo cliente assinante streamingPull. A afinidade é esperada quando as mensagens estão pendentes para uma chave de ordenação para um cliente assinante específico. Se não houver mensagens pendentes, a afinidade poderá mudar para balanceamento de carga ou desconexões do cliente.

  Para garantir um processamento tranquilo, mesmo com possíveis mudanças de afinidade, é crucial projetar o aplicativo streamingPull de forma que ele possa lidar com mensagens em qualquer cliente para uma determinada chave de ordem.

• Integração com o Dataflow: não ative a ordenação de mensagens para assinaturas ao configurar o Dataflow com o Pub/Sub. O Dataflow tem o próprio mecanismo de ordenação total de mensagens, garantindo a ordem cronológica em todas as mensagens como parte das operações de janelamento. Esse método de ordenação é diferente da abordagem baseada em chaves de pedidos do Pub/Sub. O uso de chaves de ordenação com o Dataflow pode reduzir o desempenho do pipeline.

• Escalonamento automático: a entrega ordenada do Pub/Sub é escalonada para bilhões de chaves de pedidos. Um número maior de chaves de ordenação permite uma entrega mais paralela aos assinantes, já que a ordem se aplica a todas as mensagens com a mesma chave de ordenação.

A entrega do pedido tem algumas desvantagens. Em comparação com a entrega não ordenada, a entrega ordenada pode diminuir um pouco a disponibilidade de publicação e aumentar a latência da entrega de mensagens de ponta a ponta. No caso de entrega ordenada, o failover requer coordenação para garantir que as mensagens sejam gravadas e lidas na ordem correta.

Para mais informações sobre como usar a ordem de mensagens, consulte os seguintes tópicos de práticas recomendadas:

• Práticas recomendadas para a ordenação de mensagens na publicação

• Práticas recomendadas para mensagens ordenadas na assinatura

Comportamento do cliente do assinante para a ordenação de mensagens

Os clientes assinantes recebem as mensagens na ordem em que foram publicadas em uma região específica. Pub/Sub é compatível com diferentes maneiras de receber mensagens, como clientes assinantes conectados a assinaturas de pull e push. As bibliotecas de cliente usam streamingPull (com exceção do PHP).

Para saber mais sobre esses tipos de assinatura, consulte Escolher um tipo de assinatura.

As seções a seguir discutem o que significa receber mensagens em ordem para cada tipo de cliente assinante.

Clientes assinantes do StreamingPull

Ao usar as bibliotecas de cliente com streamingPull, você precisa especificar um callback do usuário que será executado sempre que uma mensagem for recebida por um cliente assinante. Com bibliotecas de cliente, para qualquer chave de ordem especificada, o callback é executado para conclusão nas mensagens na ordem correta. Se as mensagens forem confirmadas nesse callback, todos os cálculos em uma mensagem ocorrerão em ordem. No entanto, se o callback do usuário programar outro trabalho assíncrono em mensagens, o cliente do assinante precisará garantir que o trabalho assíncrono seja feito na ordem. Uma opção é adicionar mensagens a uma fila de trabalho local que é processada em ordem.

Clientes assinantes de pull

Para clientes assinantes conectados a assinaturas de pull, a ordenação de mensagens do Pub/Sub é compatível com o seguinte:

• Todas as mensagens de uma chave de ordem no PullResponse estão na ordem correta na lista.

• Somente um lote de mensagens pode estar pendente para uma chave de ordem por vez.

O requisito de que apenas um lote de mensagens possa estar pendente por vez é necessário para manter a entrega ordenada, já que o serviço Pub/Sub não pode garantir o sucesso ou a latência da resposta enviada para a solicitação de envio de um assinante.

Clientes assinantes de push

As restrições de empurrar são ainda mais rigorosas do que as de puxar. Para uma assinatura de push, o Pub/Sub aceita apenas uma mensagem pendente para cada chave de ordem por vez. Cada mensagem é enviada para um endpoint de push como uma solicitação separada. Assim, enviar as solicitações em paralelo teria o mesmo problema que entregar vários lotes de mensagens para a mesma chave de ordenação para receber assinantes simultaneamente. As assinaturas de push podem não ser uma boa opção para tópicos em que as mensagens são publicadas com frequência com a mesma chave de ordem ou em que a latência é extremamente importante.

Exportar clientes assinantes

As assinaturas de exportação são compatíveis com mensagens ordenadas. Para assinaturas do BigQuery, as mensagens com a mesma chave de ordem são gravadas na tabela do BigQuery em ordem. Para assinaturas do Cloud Storage, as mensagens com a mesma chave de ordem podem não ser gravadas no mesmo arquivo. Quando dentro do mesmo arquivo, as mensagens para uma chave de ordem estão na ordem. Quando espalhadas por vários arquivos, as mensagens posteriores para uma chave de ordenação podem aparecer em um arquivo com um nome que tenha um carimbo de data/hora anterior ao carimbo de data/hora no nome do arquivo com as mensagens anteriores.

Ativar a ordem das mensagens

Para receber as mensagens em ordem, defina a propriedade de ordenação das mensagens na assinatura que recebe as mensagens. O recebimento de mensagens pode aumentar a latência. Não é possível alterar a propriedade de ordem das mensagens depois de criar uma assinatura.

É possível definir a propriedade de ordenação de mensagens ao criar uma assinatura usando o console do Google Cloud, a Google Cloud CLI ou a API Pub/Sub.

Console

Para criar uma assinatura com a propriedade de ordenação de mensagens, siga estas etapas:

1. No Console do Google Cloud, acesse a página Assinaturas.

Acessar "Assinaturas"

1. Clique em Criar assinatura.

2. Insira um ID de assinatura.

3. Escolha um tópico para receber mensagens.

4. Na seção Ordem das mensagens, selecione Ordenar mensagens com uma chave de ordem.

5. Clique em Criar.

gcloud

Para criar uma assinatura com a propriedade de ordenação de mensagens, use o comando gcloud pubsub subscriptions create e a sinalização --enable-message-ordering:

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

Substitua SUBSCRIPTION_ID pelo ID da assinatura.

Se a solicitação for bem-sucedida, a linha de comando exibirá uma confirmação:

Created subscription [SUBSCRIPTION_ID].

REST

Para criar uma assinatura com a propriedade de ordenação de mensagens, envie uma solicitação PUT como esta:

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

Substitua:

• PROJECT_ID: o ID do projeto com o tópico.
• SUBSCRIPTION_ID: o ID da assinatura.

No corpo da solicitação, especifique o seguinte:

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

Substitua TOPIC_ID pelo ID do tópico a ser anexado à assinatura.

Se a solicitação for bem-sucedida, a resposta será a assinatura no formato JSON:

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

C++

Antes de tentar esse exemplo, siga as instruções de configuração do C++ em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C++.

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";
}

C#

Antes de tentar esse exemplo, siga as instruções de configuração do C# em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub C#.

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;
    }
}

Go

Antes de tentar esse exemplo, siga as instruções de configuração do Go em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Go.

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
}

Java

Antes de tentar essa amostra, siga as instruções de configuração do Java em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Java.

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());
    }
  }
}

Node.js

Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.

/**
 * 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.'
  );
}

Node.js

Antes de tentar essa amostra, siga as instruções de configuração do Node.js em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Node.js.

/**
 * 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.'
  );
}

Python

Antes de tentar esse exemplo, siga as instruções de configuração do Python em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Python.

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}")

Ruby

Antes de tentar esse exemplo, siga as instruções de configuração do Ruby em Guia de início rápido: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Pub/Sub Ruby.

# 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."

A seguir

• Leia a postagem do blog sobre pedidos de entrega.

• Para continuar publicando mensagens em caso de erros que não permitem uma nova tentativa, consulte Repetir solicitações com chaves de ordenação.

• Monitore sua assinatura.

• Leia sobre como publicar mensagens com chaves de ordenação.