Mostrar eventos em um painel

Este documento descreve como configurar um painel para mostrar anotações de eventos. Um evento é uma atividade, como uma implantação ou uma falha, que afeta a operação de um sistema. Mostrar anotações de eventos pode ajudar você a correlacionar dados de diferentes fontes ao resolver um problema.

Esse recurso só é compatível com projetos Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.

Sobre as anotações de eventos

É possível mostrar eventos na maioria dos painéis listados na página Painéis do console do Google Cloud . Da mesma forma, é possível configurar algumas guias de Observabilidade específicas do serviço, como as do Compute Engine e do Google Kubernetes Engine, para mostrar eventos. Para configurar os tipos de eventos que são mostrados em um painel ou na guia Observabilidade, use o console Google Cloud . Para os painéis criados, que são classificados como personalizados, também é possível usar a API Cloud Monitoring.

A menos que você use a API Cloud Monitoring ou salve suas seleções de tipo de evento, elas serão válidas apenas para a sessão atual. Quando você usa o console Google Cloud , o fixação das suas seleções salva elas.

Para conferir uma lista de tipos de eventos, referências de solução de problemas e outras informações, consulte a página Tipos de eventos.

Tipos de evento recomendados

Os seguintes tipos de eventos podem aparecer ativados em um painel ou na guia Observabilidade, mesmo que você não tenha selecionado nenhum tipo de evento:

• Alerta aberto.
• Incidente do Personalized Service Health, quando a API Service Health está ativada.
• Para cada tipo de recurso com dados mostrados no painel, um tipo de evento.

Quando um tipo de evento é adicionado automaticamente, ele é recomendado. Você pode deixar esses tipos de eventos no estado recomendado, salvá-los no JSON do painel ou dispensá-los, o que remove a recomendação. Para determinar quais tipos de eventos são salvos, expanda o menu Anotações e consulte a seção Fixados.

Como os eventos são identificados

Os painéis consultam diferentes fontes de dados para identificar os eventos que serão mostrados no painel:

• O Monitoring identifica os eventos de alerta. Os eventos de alerta fornecem informações sobre quando os incidentes foram abertos.

• Os eventos do Personalized Service Health são identificados por consultas que o Monitoring envia à API Service Health. Esses eventos indicam quando há uma interrupção em um serviço do Google Cloud .

• Todos os outros tipos de eventos são identificados analisando as entradas de registro que passam pelos coletores do Cloud Logging no seu projeto Google Cloud . Essas entradas incluem as geradas e as encaminhadas para seu projeto. Para receber uma notificação quando um desses eventos ocorrer, crie uma política de alertas baseada em registros. Na política de alertas, use as consultas fornecidas na página Tipos de eventos.

Como os eventos são mostrados

Para todos os eventos, à medida que eles ocorrem, os gráficos no painel são anotados. Os eventos identificados pela análise de entradas de registro são mostrados com uma única referência de tempo. Em contrapartida, os eventos do Service Health são mostrados com um horário de início, e o plano de fundo do gráfico é alterado durante a duração do evento. Esses eventos também mostram um ícone de coração.

A captura de tela a seguir ilustra um gráfico que mostra vários eventos identificados pela análise de entradas de registro e um evento do Service Health:

Conforme mostrado na captura de tela anterior, a dica de um evento inclui informações como:

• Nome do evento.
• Data e hora de início do evento.
• Para eventos do Service Health, chips que mostram o número de produtos e locais afetados. Para listar os produtos ou locais afetados, coloque o ponteiro no ícone correspondente.
• Um botão Visualizar, que, quando selecionado, abre uma página com mais informações sobre o evento. Por exemplo, ele pode abrir o Explorador de registros para que você possa ver as entradas de registro ou a página de detalhes de um evento do Service Health.

Os filtros do painel, que limitam os dados mostrados por um painel, geralmente filtram dados de série temporal e eventos.

Antes de começar

Faça o seguinte no projeto do Google Cloud em que você quer ver eventos nos painéis:

• Para ter as permissões necessárias para visualizar e mostrar eventos em painéis e criar políticas de alertas, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

  • Visualizar e criar painéis e políticas de alertas: Editor do Monitoring (roles/monitoring.editor).
  • Veja e mostre eventos identificados em entradas de registro que não são de acesso a dados e que foram criadas no seu projeto Google Cloud : Visualizador de registros (roles/logging.viewer).
  • Veja e mostre eventos identificados em entradas de registro criadas no seu projeto Google Cloud : Visualizador de registros privados (roles/logging.privateLogViewer).
  • Ver eventos do Service Health: Leitor do Personalized Service Health (roles/servicehealth.viewer)

  Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

  Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

• Se você quiser mostrar eventos do Service Health no seu painel, ative a API Service Health:

  Enable the API

Mostrar eventos

Nesta seção, descrevemos como configurar um painel ou uma guia Observabilidade para mostrar eventos.

Configurar painéis para mostrar eventos

Nesta seção, descrevemos como configurar os painéis listados na página Painéis do console Google Cloud para mostrar eventos.

Para conferir uma lista de tipos de eventos, referências de solução de problemas e consultas que podem ser usadas com o Explorador de registros ou com políticas de alertas com base em registros, consulte a página Tipos de eventos.

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

Configurar a guia Observabilidade para mostrar eventos

Nesta seção, descrevemos como configurar a guia Observabilidade para mostrar eventos. Alguns serviços, como o Compute Engine e o Google Kubernetes Engine, oferecem uma guia Observabilidade que mostra dados de métricas e registros.

Ver detalhes do evento

Ao visualizar um gráfico com anotações de eventos, use os links fornecidos na dica para acessar mais informações.

Para acessar detalhes sobre um evento específico, clique em Ver.

A página do console Google Cloud aberta pelo botão Visualizar é determinada pelo tipo de evento. Por exemplo, para um evento de verificação de tempo de atividade, esse botão abre o painel da verificação. Para um tipo de evento diferente, a Análise de registros pode ser aberta.

Criar políticas de alerta

Quando os eventos são identificados analisando as entradas de registro que passam pelos coletores do Cloud Logging no seu projeto Google Cloud , você pode receber uma notificação quando esses eventos ocorrem configurando um alerta com base em registros. As políticas de alertas com base em registros consultam suas entradas de registro à medida que são recebidas. Quando a consulta retorna um resultado não vazio, um incidente é criado e as notificações são enviadas.

Ocultar eventos

A seguir

• Compartilhar um painel personalizado
• Analisar os dados em gráficos
• Acessar painéis específicos de recursos
• Adicionar filtros temporários a painéis personalizados
• Adicionar filtros permanentes a painéis personalizados