Usar o Service Bus Explorer para executar operações de dados no Barramento de Serviço

Artigo
12/05/2023

O Barramento de Serviço do Azure permite que os aplicativos cliente do remetente e do destinatário desassociem sua lógica de negócios com o uso de semântica de ponto a ponto (fila) e de publicação-assinatura (tópico-assinatura) familiares.

Observação

Este artigo destaca a funcionalidade do Azure Service Bus Explorer que é parte do portal do Azure.

O Service Bus Explorer de código aberto, pertencente à comunidade, é um aplicativo autônomo e é diferente deste.

As operações executadas em um namespace do Barramento de Serviço do Azure são de dois tipos.

Operações de gerenciamento – criar, atualizar, excluir do namespace do Barramento de Serviço, filas, tópicos e assinaturas.
Operações de dados – enviar e receber mensagens para/de filas, tópicos e assinaturas.

Importante

O Service Bus Explorer não oferece suporte a operações de gerenciamento e sessões.
Aconselhamos a não usar o Service Bus Explorer para mensagens maiores, pois isso pode resultar em tempos de espera, dependendo do tamanho da mensagem, latência da rede entre o cliente e o serviço Barramento de Serviço etc. Em vez disso, recomendamos que você use seu próprio cliente para trabalhar com mensagens maiores, em que você pode especificar seus próprios valores de tempo limite.

Pré-requisitos

Para usar a ferramenta Service Bus Explorer, você precisa realizar as seguintes tarefas:

Criar um namespace do Barramento de Serviço do Azure.
Criar uma fila para enviar e receber mensagens ou um tópico com uma assinatura para testar a funcionalidade. Para saber como criar filas, tópicos e assinaturas, confira os seguintes artigos:
- Início Rápido – Criar filas
- Início Rápido – Criar tópicos
Observação

Se este não for o namespace que você criou, verifique se você é membro de uma destas funções no namespace:

Usar o Service Bus Explorer

Para usar o Service Bus Explorer, navegue até o namespace do Barramento de Serviço no qual você deseja executar as operações de dados.

Se você estiver procurando executar operações em uma fila, escolha Filas no menu de navegação. Se você estiver procurando executar operações em um tópico (e nas assinaturas relacionadas), selecione Tópicos.
Depois de selecionar Filas ou Tópicos, selecione a fila ou o tópico específico.
Selecione o Service Bus Explorer no menu de navegação à esquerda

Observação

Ao espiar ou receber de uma assinatura, primeiro selecione a Assinatura específica no seletor suspenso.

Espiar uma mensagem

Com a funcionalidade de espiada, você pode usar o Service Bus Explorer para ver as 100 primeiras mensagens de uma fila, assinatura ou fila de mensagens mortas.

Para espiar mensagens, selecione Modo Espiar no menu suspenso do Service Bus Explorer.
Verifique as métricas para ver se há Mensagens ativas ou Mensagens mortas a espiar e selecione a Fila / Assinatura ou a subfila de Mensagens Mortas.
Selecione o botão Espiar do início.
Depois que a operação de espiar for concluída, até 100 mensagens são exibidas na grade, conforme mostrado na imagem a seguir. Para exibir os detalhes de uma mensagem específica, selecione-a na grade. Você pode optar por exibir o corpo ou as propriedades da mensagem.

Alterne para a guia Propriedades da Mensagem no painel inferior para ver os metadados.

Observação

Como espiar não é uma operação destrutiva, a mensagem não será removida da entidade.

Observação

Por motivos de desempenho, ao espiar mensagens de uma fila ou assinatura com o tamanho máximo da mensagem definido em 1 MB, o corpo da mensagem não será recuperado por padrão. Em vez disso, você pode carregar o corpo da mensagem para uma mensagem específica clicando no botão Carregar corpo da mensagem. Se o corpo da mensagem tiver mais de 1 MB, ele será truncado antes de ser exibido.

Espiar uma mensagem com opções avançadas

A funcionalidade de espiada com opções permite usar o Service Bus Explorer para exibir as primeiras mensagens em uma fila, assinatura ou fila de mensagens mortas, especificando o número de mensagens a espiar e o número da sequência a partir do qual começar a operação de espiada.

Para espiar mensagens com opções avançadas, selecione Modo Espiar no menu suspenso do Service Bus Explorer.
Verifique as métricas para ver se há Mensagens ativas ou Mensagens mortas a espiar e selecione a Fila / Assinatura ou a subfila de Mensagens Mortas.
Selecione o botão Espiar com opções. Forneça o número de mensagens a serem espiadas e o número da sequência do qual começar a espiar e selecione o botão Espiar.
Depois que a operação de espiar for concluída, as mensagens são exibidas na grade, conforme mostrado na imagem a seguir. Para exibir os detalhes de uma mensagem específica, selecione-a na grade. Você pode optar por exibir o corpo ou as propriedades da mensagem.

Alterne para a guia Propriedades da Mensagem no painel inferior para ver os metadados.

Observação

Como espiar não é uma operação destrutiva, a mensagem não será removida da fila.

Receber uma mensagem

A função de recebimento no Service Bus Explorer permite o recebimento de mensagens de uma fila ou assinatura.

Para receber mensagens, selecione Modo de Recebimento na lista suspensa do Service Bus Explorer.
Verifique as métricas para ver se há Mensagens ativas ou Mensagens mortas a serem recebidas e selecione Fila/Assinatura ou Fila de Mensagens Mortas.
Selecione o botão Receber mensagens e especifique o modo de recebimento, o número de mensagens a serem recebidas e o tempo máximo pelo qual aguardar uma mensagem e selecione Receber.

Importante

Observe que o modo ReceiveAndDelete é uma operação de recebimento destrutivo, ou seja, a mensagem é removida da fila quando ela é exibida na ferramenta Service Bus Explorer.

Para procurar mensagens sem removê-las da fila, considere o uso da funcionalidade Espiar ou use o modo de recebimento PeekLock.
Depois que a operação de recebimento for concluída, as mensagens são exibidas na grade, conforme mostrado na imagem a seguir. Para exibir os detalhes de uma mensagem específica, selecione-a na grade.

Observação

Por motivos de desempenho, ao receber mensagens de uma fila ou assinatura com o tamanho máximo da mensagem definido em 1MB, apenas uma mensagem será recebida por vez. Se o corpo da mensagem tiver mais de 1 MB, ele será truncado antes de ser exibido.

Depois que uma mensagem é recebida no modo PeekLock, há várias ações que podemos executar nela.

Observação

Só podemos executar essas ações desde que tenhamos um bloqueio na mensagem.

Concluir uma mensagem

Na grade, selecione as mensagens recebidas que desejamos concluir.
Selecione o botão Concluir.

Importante

Observe que concluir uma mensagem é um recebimento destrutivo, ou seja, a mensagem é removida da fila quando a opção Concluir é selecionada na ferramenta Service Bus Explorer.

Adiar uma mensagem

Na grade, selecione as mensagens recebidas que desejamos adiar.
Selecione o botão Adiar.

Abandonar bloqueio

Na grade, selecione as mensagens recebidas para as quais queremos abandonar o bloqueio.
Selecione o botão Abandonar bloqueio.

Depois que o bloqueio for abandonado, a mensagem estará disponível novamente para operações de recebimento.

Mensagens mortas

Na grade, selecione as mensagens recebidas que desejamos colocar na fila de Mensagens mortas.
Selecione o botão Mensagens mortas.

Depois que uma mensagem se torna mensagem morta, ela estará disponível na subfila de Mensagens mortas.

Enviar uma mensagem a uma fila ou um tópico

Para enviar uma mensagem para uma fila ou um tópico, selecione o botão Enviar mensagens do Service Bus Explorer.

Escolha o Tipo de Conteúdo como Texto/Simples, Aplicativo/Xml ou Aplicativo/Json.
Para o Corpo da mensagem, adicione o conteúdo da mensagem. Verifique se ele corresponde ao Tipo de conteúdo definido anteriormente.
Defina Propriedades do agente (opcional) – isso inclui ID de correlação, ID da mensagem, ReplyTo, Rótulo/Assunto, TTL (Vida útil) e Tempo de enfileiramento agendado (para mensagens agendadas).
Defina Propriedades personalizadas (opcional) – pode ser qualquer propriedade de usuário definida em relação a uma chave de dicionário.
Marque Repetir o envio para enviar a mesma mensagem várias vezes. Se nenhuma ID de Mensagem tiver sido definida, ela será automaticamente preenchida com valores sequenciais.
Depois que a mensagem tiver sido redigida, pressione o botão Enviar.
Quando a operação de envio for concluída com êxito, um dos seguintes eventos ocorrerá:
- Se o envio estiver sendo feito para uma fila, o contador de métricas de Mensagens Ativas será incrementado.
- Se o envio estiver sendo feito para um tópico, o contador de métricas de Mensagens ativas será incrementado na assinatura para a qual a mensagem foi roteada.

Reenviar uma mensagem

Depois de espiar ou receber uma mensagem, podemos reenviá-la, o que enviará uma cópia da mensagem para a mesma entidade, permitindo-nos atualizar seu conteúdo e suas propriedades. O original permanecerá e não será excluído, mesmo quando o reenvio for da fila de mensagens mortas.

Na grade, selecione a(s) mensagem(ns) que deseja reenviar.
Selecione o botão Reenviar as mensagens selecionadas.
Opcionalmente, selecione qualquer mensagem cujos detalhes desejamos atualizar e faça as alterações desejadas.
Selecione o botão Enviar para enviar as mensagens para a entidade.
Observação
- A operação de reenvio envia uma cópia da mensagem original. Ela não remove a mensagem original que você reenvia.
- Se você reenviar uma mensagem em uma fila de mensagens mortas de uma assinatura, uma cópia da mensagem será enviada ao tópico. Portanto, todas as assinaturas receberão uma cópia da mensagem.