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 a correlacionar dados de diferentes fontes ao solucionar um problema.

Esse recurso é compatível apenas com Google Cloud projetos. Para App Hub configurações, selecione o projeto host do App Hub ou o projeto de gerenciamento.

Sobre as anotações de eventos

É possível mostrar eventos na maioria dos painéis listados na página Painéis do Google Cloud console. Da mesma forma, é possível configurar algumas guias 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 por um painel ou em uma guia Observabilidade, use o Google Cloud console. 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 tome uma ação para salvar as seleções de tipo de evento, elas serão aplicadas apenas à sessão atual. Ao usar o Google Cloud console, fixar as seleções as salva.

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

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

Quando um tipo de evento é adicionado automaticamente, ele é um tipo de evento recomendado. É possível 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 confira a seção Fixado.

Como os eventos são identificados

Os painéis consultam diferentes fontes de dados para identificar os eventos a serem mostrados no painel:

  • Os eventos de alerta são identificados pelo Monitoring. 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 Google Cloud serviço.

  • Todos os outros tipos de eventos são identificados pela análise das entradas de registro que passam pelos coletores do Cloud Logging no seu Google Cloud projeto. Essas entradas de registro incluem as geradas pelo seu projeto e as encaminhadas para ele. Para receber uma notificação quando um desses eventos ocorrer, crie uma política de alertas com base 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 o 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:

Gráfico mostrando anotações de eventos informativos e de aviso.

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

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

Os filtros do painel, que limitam os dados mostrados por um painel, normalmente filtram dados e eventos de séries temporais.

Antes de começar

Conclua as etapas a seguir para o Google Cloud projeto em que você quer conferir eventos nos painéis:

  • Para receber as permissões necessárias para conferir e mostrar eventos nos painéis e criar políticas de alertas, peça que o administrador conceda a você os seguintes papéis do IAM no projeto:

    • Conferir e criar painéis e políticas de alertas: editor do Monitoring (roles/monitoring.editor).
    • Conferir e mostrar eventos identificados em entradas de registro de acesso a dados que são criadas no seu Google Cloud projeto: leitor de registros (roles/logging.viewer).
    • Conferir e mostrar eventos identificados em qualquer entrada de registro criada no seu Google Cloud projeto: leitor de registros particulares (roles/logging.privateLogViewer).
    • Conferir eventos de Service Health: 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 usando personalizados papéis ou outros predefinidos papéis.

  • Se você quiser mostrar eventos de integridade do serviço no painel, ative a API Service Health:

    Funções necessárias para ativar APIs

    Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (roles/serviceusage.serviceUsageAdmin), que contém a permissão serviceusage.services.enable. Saiba como conceder papéis.

    Ativar a API

Mostrar eventos

Esta seção descreve como configurar um painel ou uma guia Observabilidade para mostrar eventos.

Configurar painéis para mostrar eventos

Esta seção descreve como configurar os painéis listados em a página Painéis do Google Cloud console para mostrar eventos.

Console

Para mostrar eventos em um painel, faça o seguinte:

  1. No Google Cloud console, acesse a página  Painéis:

    Acesse Painéis

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do Google Cloud console, selecione seu Google Cloud projeto. Para App Hub configurações, selecione o projeto host do App Hub ou o projeto de gerenciamento.
  3. Selecione o painel que você quer conferir.
  4. Na barra de ferramentas do painel, clique em Anotações e selecione os tipos de eventos que você quer que o painel mostre.

  5. Escolha uma destas opções:

    • Para salvar as seleções para que os eventos sejam mostrados quando você recarregar o painel, clique em Fixar selecionados. Se o salvamento automático estiver desativado no painel, acesse a barra de ferramentas do painel e clique em Salvar.

      Ao fixar as seleções, você modifica a definição JSON do painel. Portanto, quando o painel é reaberto, as seleções são carregadas e o painel mostra anotações para os tipos de eventos correspondentes.

    • Para mostrar os tipos de eventos apenas na sessão atual, clique em Aplicar.

    Depois de atualizar a lista de tipos de eventos a serem mostrados, o Cloud Monitoring emite consultas, o que leva alguns instantes, e adiciona as anotações aos gráficos no painel.

  6. Para conferir um resumo de um evento ou acessar links para mais informações, use o ponteiro para ativar a dica.

REST

Para configurar um painel personalizado para mostrar eventos, inclua um campo annotations no objeto Dashboard. O campo annotations contém uma instância de um objeto DashboardAnnotations, que contém dois campos:

  • O campo defaultResourceName lista os padrões de nível do painel para os Google Cloud projetos em que os eventos serão pesquisados. Se você não especificar esse campo, o projeto selecionado será pesquisado.

  • Uma matriz de EventAnnotation objetos. Cada objeto contém o seguinte:

    • Um campo displayName, que permite definir o rótulo na alternância específica do evento. Quando esse campo não é especificado ou quando o valor dele é uma string vazia, o nome padrão do evento é mostrado.
    • Um campo enabled, que controla o valor da alternância do evento. Quando true, a alternância está na posição on e os eventos são mostrados no painel. Quando false, a alternância está na posição off.
    • Um campo eventType, que contém um valor da enumeração EventType.
    • Um campo filter, que permite especificar uma consulta a ser anexada à consulta específica do evento. Quando o valor desse campo é uma string vazia, a consulta específica do evento é usada.
    • Um campo resourceNames, que permite definir uma lista de Google Cloud projetos para pesquisar eventos. Quando esse campo é uma matriz vazia, o projeto selecionado é pesquisado.

O exemplo a seguir mostra um objeto annotations para um evento de atualização de cluster. O campo filter neste exemplo restringe os eventos a um cluster específico:

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

Para informações detalhadas sobre como usar a API Cloud Monitoring para criar painéis, consulte Criar e gerenciar painéis por API e Exemplo: ativar eventos em painéis.

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

Configurar a guia Observabilidade para mostrar eventos

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

Console

Para configurar a guia Observabilidade para mostrar eventos, faça o seguinte:

  1. Acesse a guia Observabilidade de um serviço ou produto.

    Por exemplo, acesse a página Clusters do Kubernetes e selecione a guia Observabilidade. Da mesma forma, você pode acessar a página Workloads do Kubernetes ou a página de detalhes de uma instância de máquina virtual (VM) e selecionar a guia Observabilidade.

  2. Verifique se o menu Painel está definido como Predefinido. Não é possível mostrar eventos em painéis personalizados.

  3. Na barra de ferramentas, clique em Anotações, e preencha a caixa de diálogo.

    Depois de atualizar a lista de eventos a serem mostrados, as consultas são emitidas para recuperar os dados de eventos, e o painel é atualizado.

    Quando o menu Anotações não é mostrado, a guia não pode ser configurada para mostrar eventos.

REST

Indisponível.

Conferir detalhes do evento

Ao conferir um gráfico que mostra anotações de eventos, é possível usar os links fornecidos na dica para acessar mais informações.

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

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

Criar políticas de alerta

Quando os eventos são identificados pela análise das entradas de registro que passam pelos coletores do Cloud Logging no seu Google Cloud projeto, é possível 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 as 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.

Console

Para criar um alerta com base em registros, faça o seguinte:

  1. Se você não tiver configurado um canal de notificação, faça o seguinte:

    1. No Google Cloud console do, acesse a  página Alertas:

      Acessar Alertas

      Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

    2. Na barra de ferramentas do Google Cloud console, selecione seu Google Cloud projeto. Para App Hub configurações, selecione o projeto host do App Hub ou o projeto de gerenciamento.
    3. Clique em Editar canal de notificação.
    4. Acesse o tipo de canal de notificação que você quer configurar, clique em Adicionar novo e preencha a caixa de diálogo.

  2. No Google Cloud console do, acesse a página segmento Análise de registros:

    Acessar a Análise de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.

  3. Na barra de ferramentas do Google Cloud console, selecione seu Google Cloud projeto.

  4. Na barra de ferramentas, selecione Criar alerta.

  5. Insira um nome para a política de alertas e clique em Próxima.

  6. Na seção Definir entradas de registro para alertar , insira uma consulta ou atualize a consulta que foi copiada do painel Consulta quando você selecionou Criar alerta.

    Para cada tipo de evento, a página Tipos de eventos lista uma consulta adequada para uso em uma política de alertas com base em registros.

  7. Preencha a caixa de diálogo e clique em Salvar.

REST

Para criar uma política de alertas com base em registros usando a API Cloud Monitoring, faça o seguinte:

  1. Identifique a consulta que será incluída na condição da política de alertas. Para cada tipo de evento, a página Tipos de eventos lista uma consulta adequada para uso em uma política de alertas com base em registros.

  2. Crie o arquivo JSON que contém a representação da política de alertas. Para mais informações sobre essa etapa e um exemplo, consulte Projetar a política de alertas.

  3. Invoque o método da API alertPolicies.create. Por exemplo, você pode emitir o gcloud monitoring policies create comando.

Ocultar eventos

Console

Para ocultar todos os eventos, na barra de ferramentas do painel, clique em Anotações, selecione Limpar e, em seguida, selecione Aplicar.

Para ocultar um tipo de evento, clique em Anotações, desmarque a seleção desse tipo de evento e selecione Aplicar.

REST

Para ocultar um tipo de evento em um painel personalizado, encontre o EventAnnotation objeto para o tipo de evento, e defina o enabled campo como false.

Para informações detalhadas sobre como usar a API Cloud Monitoring, consulte Criar e gerenciar painéis por API.

A seguir