Monitorar o Pub/Sub no Cloud Monitoring

Use o console do Google Cloud ou a API Cloud Monitoring para monitorar o Pub/Sub.

Neste documento, mostramos como monitorar o uso do Pub/Sub no no console do Google Cloud usando o Monitoring.

  • Se você quiser conferir métricas de outros recursos do Google Cloud, métricas do Pub/Sub, use o Monitoring.

  • Caso contrário, use os painéis de monitoramento fornecidos no Pub/Sub. Consulte Monitorar tópicos e Monitorar assinaturas.

Para conhecer as práticas recomendadas sobre o uso de métricas nos seus escalonamento automático, consulte Práticas recomendadas para usar métricas do Pub/Sub como um indicador de escalonamento.

Antes de começar

Antes de usar o Monitoring, verifique se você preparou o seguinte:

  • Uma conta do Cloud Billing

  • Um projeto do Pub/Sub com faturamento ativado

Uma maneira de garantir que você tenha ambos é concluir o Guia de início rápido sobre como usar o Console do Cloud.

Acessar um painel

Com um painel, é possível visualizar e analisar dados de diferentes fontes no mesmo contexto. O Google Cloud oferece painéis predefinidos e personalizados. Para exemplo, é possível conferir um painel predefinido do Pub/Sub ou criar um painel que exibe dados de métricas, políticas de alertas e entradas de registro relacionadas no Pub/Sub.

Para monitorar seu projeto do Pub/Sub usando o Cloud Monitoring, siga estas etapas:

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

    Acessar Monitoring

  2. Selecione o nome do seu projeto (se ele ainda não estiver selecionado) na parte superior da página.

  3. Clique em Painéis no menu de navegação.

  4. Na página Visão geral dos painéis, crie um painel. ou selecione o painel atual do Pub/Sub.

    Para pesquisar o painel atual do Pub/Sub, use o filtro Todos os painéis, selecione a propriedade Nome e insira Pub/Sub.

Para mais informações sobre como criar, editar e gerenciar uma painel personalizado, consulte Gerenciar painéis personalizados.

Conferir uma única métrica do Pub/Sub

Para conferir uma única métrica do Pub/Sub usando no console do Google Cloud, siga estas etapas:

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

    Acessar Monitoring

  2. No painel de navegação, selecione Metrics Explorer.

  3. Na seção Configuração, clique em Selecionar uma métrica.

  4. No filtro, digite Pub/Sub.

  5. Em Recursos ativos, selecione Assinatura do Pub/Sub ou Tópico do Pub/Sub.

  6. Selecione uma métrica específica e clique em Aplicar.

    A página de uma métrica específica é aberta.

Para saber mais sobre o painel de monitoramento, leia a documentação do Cloud Monitoring.

Conferir métricas e tipos de recursos do Pub/Sub

Monitorar o uso de cotas

Para um determinado projeto, é possível usar a IAM e Painel de cotas do administrador as cotas e o uso atuais.

Você pode visualizar o histórico de uso da cota com as seguintes métricas:

Essas métricas usam o tipo de recurso monitorado consumer_quota. Para mais métricas relacionadas a cotas, consulte a Lista de métricas

Por exemplo, a consulta Linguagem de consulta do Monitoring a seguir cria um gráfico com a fração da cota de editor que está sendo usada em cada região:

fetch consumer_quota
| filter resource.service == 'pubsub.googleapis.com'
| { metric serviceruntime.googleapis.com/quota/rate/net_usage
    | filter metric.quota_metric == 'pubsub.googleapis.com/regionalpublisher'
    | align delta_gauge(1m)
    | group_by [metric.quota_metric, resource.location],
        sum(value.net_usage)
  ; metric serviceruntime.googleapis.com/quota/limit
    | filter metric.quota_metric == 'pubsub.googleapis.com/regionalpublisher'
    | group_by [metric.quota_metric, resource.location],
        sliding(1m), max(val()) }
| ratio

Se você prevê que o uso excede os limites de cota padrão, crie políticas de alerta para todas as cotas relevantes. Esses alertas são disparados quando o uso atinge uma fração do limite. Para exemplo, a consulta a seguir em linguagem de consulta do Monitoring aciona uma política de alertas quando qualquer cota do Pub/Sub exceder 80% de uso:

fetch consumer_quota
| filter resource.service == 'pubsub.googleapis.com'
| { metric serviceruntime.googleapis.com/quota/rate/net_usage
    | align delta_gauge(1m)
    | group_by [metric.quota_metric, resource.location],
        sum(value.net_usage)
  ; metric serviceruntime.googleapis.com/quota/limit
    | group_by [metric.quota_metric, resource.location],
        sliding(1m), max(val()) }
| ratio
| every 1m
| condition gt(val(), 0.8 '1')

Para monitoramento e alertas mais personalizados sobre métricas de cota, consulte Como usar métricas de cota.

Consulte Cotas e limites para mais informações sobre cotas.

Mantenha uma assinatura íntegra

Para manter uma assinatura saudável, é possível monitorar várias propriedades de assinatura usando as métricas fornecidas pelo Pub/Sub. Por exemplo, é possível monitorar o volume de mensagens não confirmadas, a expiração dos prazos de confirmação de mensagens e assim por diante. Você também pode verificar se a assinatura está íntegra o suficiente baixa latência de entrega de mensagens.

Consulte as próximas seções para saber mais detalhes sobre as métricas específicas.

Monitorar o backlog das mensagens

Para garantir que os assinantes acompanhem o fluxo das mensagens, crie em um painel. O painel pode mostrar as seguintes métricas de backlog, agregadas por recurso, para todas as assinaturas:

Crie políticas de alerta que sejam acionadas quando esses valores estiverem fora do intervalo aceitável no contexto do sistema. Por exemplo, o número absoluto de mensagens não confirmadas não é necessariamente significativo. Uma lista de pendências um milhão de mensagens pode ser aceitável para um milhão de mensagens por segundo mas inaceitável para uma assinatura de uma mensagem por segundo.

Problemas comuns de pendências

Sintomas Problema Soluções
Tanto oldest_unacked_message_age quanto num_undelivered_messages estão crescendo no mesmo ritmo. Assinantes não acompanham o volume de mensagens
  • Adicione mais linhas de execução ou processos de assinantes.
  • Adicione mais máquinas ou contêineres de assinantes.
  • Procure sinais de bugs no código que impeçam que ele confirme mensagens ou processe-as em tempo hábil. Consulte Como monitorar a expiração do prazo de confirmação.
Se houver um acúmulo de volume pequeno e constante combinado a um oldest_unacked_message_age com crescimento constante, pode haver algumas mensagens que não podem ser processadas. Mensagens travadas
  • Examine os registros do aplicativo para saber se algumas mensagens estão causando falhas no código. É improvável, mas possível. — que as mensagens ofensivas ficam presas no Pub/Sub e não no seu cliente. Faça uma caso de suporte depois que você tiver certeza seu código processa cada mensagem com sucesso.
  • Se algumas mensagens estiverem causando falhas no código, considere encaminhar essas mensagens para um tópico de mensagens inativas.
O oldest_unacked_message_age excede a assinatura duração da retenção da mensagem. Perda permanente de dados
  • Configure um alerta que seja acionado antes da duração da retenção de mensagens expirar.

Monitorar a integridade da latência de exibição

No Pub/Sub, a latência de envio é o tempo que uma mensagem publicada leva para ser entregue a um assinante. Se o backlog das mensagens estiver aumentando, use o artigo Integridade da latência de entrega score (subscription/delivery_latency_health_score) para verificar quais fatores contribuem para o aumento da latência.

Essa métrica mede a integridade de uma única assinatura em uma janela de 10 minutos. A métrica fornece insights sobre os seguintes critérios, que são necessários para que uma assinatura alcance uma latência baixa consistente:

  • Solicitações de busca insignificantes.

  • Mensagens confirmadas negativamente (não recebidas).

  • Prazos de confirmação de mensagens expiradas nulos.

  • Latência de confirmação consistente inferior a 30 segundos.

  • Baixa utilização consistente, o que significa que a assinatura tem capacidade adequada para processar novas mensagens.

A métrica Pontuação de integridade da latência de entrega informa uma pontuação de 0 ou 1. para cada um dos critérios especificados. Uma pontuação de 1 indica um estado íntegro e uma pontuação de 0 indica um estado não íntegro.

  • Solicitações de busca: se a assinatura teve alguma solicitação de busca nos últimos 10 minutos, a pontuação será definida como 0. Procurando uma assinatura pode fazer com que as mensagens antigas sejam reproduzidas muito depois de serem publicado, o que aumenta a latência de entrega.

  • Mensagens confirmadas negativamente (não recebidas): se a assinatura teve alguma solicitações de confirmação negativa (nack) nos últimos 10 minutos, a pontuação será definido como 0. Uma confirmação negativa faz com que uma mensagem seja reenviada com uma latência de entrega maior.

  • Prazos de confirmação expirados: se a assinatura tiver prazos de confirmação expirados nos últimos 10 minutos, a pontuação será definida como 0. As mensagens cujo prazo de confirmação expirou são reenviadas com uma latência de envio maior.

  • Latências de confirmação: se o 99,9o percentil de toda a confirmação latências nos últimos 10 minutos foi maior do que 30 segundos, a pontuação é definido como 0. Uma latência de confirmação alta é um sinal de que um cliente assinante está demorando muito para processar uma mensagem. Esta pontuação pode indicar um bug ou algumas restrições de recursos no lado do cliente assinante.

  • Baixa utilização: a utilização é calculada de maneira diferente para cada tipo de assinatura.

    • StreamingPull: se você não tiver streams suficientes abertos, a pontuação será definida como 0. Abra mais streams para garantir a capacidade adequada para novas mensagens.

    • Push: se você tiver muitas mensagens pendentes no endpoint de push, a pontuação é definida como 0. Adicione mais capacidade ao endpoint de push para ter de armazenamento para novas mensagens.

    • Pull: se você não tem solicitações de pull pendentes suficientes, a pontuação é definido como 0. Abra mais solicitações de pull simultâneas para garantir que você esteja pronto para receber novas mensagens.

Para conferir a métrica, Metrics Explorer; selecione a opção Integridade da latência de entrega pontuação para o tipo de recurso de assinatura do Pub/Sub. Adicione um filtro para selecionar apenas uma assinatura por vez. Selecione a área empilhada. gráfico e indicam um momento específico para verificar as pontuações dos critérios do assinatura naquele momento.

Confira abaixo uma captura de tela da métrica representada em um período de uma hora usando um gráfico de área empilhada. A pontuação de integridade combinada vai para 5 às 4h15, com um pontuação de 1 para cada critério. Depois, a pontuação combinada diminui para 4 às 4h20, quando a pontuação de utilização cai para 0.

Captura de tela da métrica de latência de exibição

A Linguagem de consulta do Monitoring é uma interface expressiva e baseada em texto para dados de séries temporais do Cloud Monitoring. A seguinte consulta MQL cria um gráfico para medir a pontuação de integridade da latência de entrega de uma assinatura.

fetch pubsub_subscription
| metric 'pubsub.googleapis.com/subscription/delivery_latency_health_score'
| filter (resource.subscription_id == '$SUBSCRIPTION')
| group_by 1m,
   [value_delivery_latency_health_score_sum:
     sum(if(value.delivery_latency_health_score, 1, 0))]
| every 1m

Monitorar a expiração do prazo de confirmação

Para reduzir a latência de entrega de mensagens, o Pub/Sub permite aos clientes assinantes um tempo limitado para confirmar (confirmar) um determinado mensagem. Esse período é conhecido como prazo de confirmação. Se os assinantes demorarem demais para confirmar as mensagens, elas serão entregues novamente, fazendo com que os assinantes vejam mensagens duplicadas. Isso pode acontecer por vários motivos:

  • Seus assinantes estão subprovisionados (você precisa de mais linhas de execução ou máquinas).

  • O processamento de cada mensagem leva mais tempo do que a confirmação da mensagem prazo. As bibliotecas de cliente do Cloud geralmente estendem para mensagens individuais até um máximo configurável. No entanto, também há um prazo máximo de extensão para as bibliotecas.

  • Algumas mensagens falham consistentemente no cliente.

É possível medir a taxa de perda do prazo de confirmação dos assinantes. A métrica específica depende do tipo de assinatura:

Caso a taxa de expiração de prazo de confirmação seja alta demais, seu sistema poderá ter um custo alto devido à falta de eficiência. Você paga por cada reenvio e pela tentativa de processar cada mensagem repetidamente. Por outro lado, uma taxa de expiração pequena (por exemplo, 0,1% a 1%) podem ser saudáveis.

Monitore a capacidade de processamento das mensagens

Os assinantes de pull e streaming pull podem receber lotes de mensagens em cada resposta de pull. As assinaturas de push recebem uma única mensagem em cada solicitação de push. Você pode monitorar a capacidade de processamento de mensagens em lote que está sendo processada pelos assinantes com estas métricas:

É possível monitorar a capacidade de mensagens individuais ou não agrupadas que estão sendo processadas pelos assinantes com a métrica subscription/sent_message_count filtrada pelo rótulo delivery_type.

Monitorar assinaturas de push

Para assinaturas de push, monitore estas métricas:

  • subscription/push_request_count

    Agrupe a métrica por response_code e subcription_id. Como as assinaturas de push do Pub/Sub usam códigos de resposta como confirmações implícitas de mensagens, é importante monitorar os códigos de resposta das solicitações por push. Como as assinaturas de push regressam exponencialmente em caso de erros ou alcance do tempo limite, o backlog pode aumentar rapidamente de acordo com o modo como seu endpoint responde.

    Considere definir um alerta para altas taxas de erro, uma vez que essas taxas levam a entrega lenta e um backlog crescente. É possível criar uma métrica filtrada por classe de resposta. No entanto, as contagens de solicitações push provavelmente serão mais úteis quanto uma ferramenta para investigar o tamanho e o tempo de backlog crescentes.

  • subscription/num_outstanding_messages

    O Pub/Sub geralmente limita o número de mensagens pendentes. Tente enviar menos de mil mensagens pendentes em na maioria das situações. Depois que a capacidade alcançar uma taxa na ordem de 10.000 mensagens por segundo, o serviço vai ajustar o limite para o número de mensagens pendentes. Essa limitação é feita em incrementos de 1.000. Não há garantias específicas além do valor máximo, então 1.000 mensagens pendentes é um bom guia.

  • subscription/push_request_latencies

    Essa métrica ajuda a entender a distribuição de latência de resposta do endpoint de push. Devido ao limite do número de mensagens pendentes, a latência do endpoint afeta a capacidade da assinatura. Se levar 100 milissegundos para processar cada mensagem, o limite de capacidade provavelmente será de 10 mensagens por segundo.

Para acessar limites maiores de mensagens pendentes, os assinantes de push precisam confirmar mais de 99% das mensagens recebidas.

É possível calcular a fração de mensagens que os assinantes confirmam usando a Linguagem de consulta do Monitoring. A consulta de MQL a seguir cria um gráfico com a fração de mensagens que os assinantes reconhecem em uma assinatura:

fetch pubsub_subscription
| metric 'pubsub.googleapis.com/subscription/push_request_count'
| filter
    (resource.subscription_id == '$SUBSCRIPTION')
    | filter_ratio_by [], metric.response_class == 'ack'
    | every 1m

Monitorar assinaturas com filtros

Se você configurar um filtro em uma assinatura, o Pub/Sub reconhece automaticamente as mensagens que não correspondem o filtro. É possível monitorar esse aviso automático.

As métricas de backlog incluem apenas mensagens que correspondem ao filtro.

Para monitorar a taxa de mensagens confirmadas automaticamente que não correspondem ao filtro, use o subscription/ack_message_count com o rótulo delivery_type definido como filter.

Para monitorar a capacidade e o custo de mensagens confirmadas automaticamente que não correspondem ao filtro, use o subscription/byte_cost com o rótulo operation_type definido como filter_drop. Para mais informações sobre as taxas dessas mensagens, consulte a página de preços do Pub/Sub.

Monitorar mensagens não entregues encaminhadas

Para monitorar as mensagens não entregues que o Pub/Sub encaminha para um tópico de mensagens inativas, use a métrica subscription/dead_letter_message_count. Essa métrica mostra o número de mensagens não entregues que o Pub/Sub encaminha de uma assinatura.

Para verificar se o Pub/Sub está encaminhando mensagens não entregues, podemos comparar a métrica subscription/dead_letter_message_count topic/send_request_count métrica. Faça a comparação para o tópico de mensagens inativas para o qual o Pub/Sub encaminha essas mensagens.

Você também pode anexar uma assinatura ao tópico de mensagens inativas e, em seguida, monitorar os encaminhou mensagens que não podem ser entregues nesta assinatura usando as seguintes métricas:

Mantenha um editor íntegro

O principal objetivo de um editor é manter a rapidez dos dados de mensagens. Monitorar o desempenho usando topic/send_request_count , agrupado por response_code. Essa métrica indica se o Pub/Sub está íntegro e aceitando solicitações.

Uma taxa de segundo plano de erros que podem ser repetidos (menor que 1%) não é um Isso é motivo de preocupação, já que a maioria das bibliotecas de cliente do Cloud e falha em mensagens. Investigue taxas de erro maiores que 1%. Como os códigos não repetíveis são processados pelo aplicativo (e não pela biblioteca de cliente), você deve examine os códigos de resposta. Se o aplicativo do editor não tiver uma boa maneira de sinalizar um estado não íntegro, considere definir um alerta na métrica topic/send_request_count.

É igualmente importante monitorar as solicitações de publicação com falha no cliente de publicação. Embora as bibliotecas de cliente geralmente repitam solicitações com falha, elas não garantem a publicação. Consulte Como publicar mensagens para saber como detectar falhas permanentes de publicação ao usar as bibliotecas de cliente do Cloud. No mínimo, o aplicativo do editor precisa registrar os erros permanentes de publicação. Se você registrar esses erros no Cloud Logging, poderá configurar uma métrica com base em registros com uma política de alertas.

Monitore a capacidade de processamento das mensagens

Os editores podem enviar mensagens em lotes. É possível monitorar a taxa de transferência de mensagens enviada pelos editores com estas métricas:

  • topic/send_request_count: o volume de mensagens em lote enviadas pelos editores.

  • Um contador de topic/message_sizes: o volume de mensagens individuais (sem agrupamento) enviadas pelos editores.

    É possível calcular uma contagem de mensagens enviadas aplicando um agregador de contagem a essa métrica ou usando a Linguagem de consulta do Monitoring. A consulta de MQL a seguir cria um gráfico com a taxa de mensagens individuais enviadas em um tópico:

    fetch pubsub_topic
| metric 'pubsub.googleapis.com/topic/message_sizes'
| filter
    (resource.topic_id == '$TOPIC')
| align delta(1m)
| every 1m
| group_by [], [row_count: row_count()]

A seguir