Mostrar eventos em um painel

Neste documento, descrevemos 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 solucionar um problema.

Sobre as anotações de eventos

É possível exibir 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 mostrados por um painel ou em uma guia Observabilidade, use o console do Google Cloud. Para os painéis criados por você, classificados como personalizados, também é possível usar a API Cloud Monitoring.

A menos que você use a API Cloud Monitoring ou realize uma ação para salvar as seleções de tipo de evento, elas serão aplicadas somente à sessão atual. Quando você usa o console do Google Cloud, a ação de fixar as seleções salva elas.

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

Você pode ver os seguintes tipos de evento 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 evento são salvos, expanda o menu Selecionar tipos de evento e confira 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:

  • Os eventos de alerta são identificados pelo Monitoring. Eventos de alerta mostram informações sobre quando os incidentes foram abertos.

  • Os eventos personalizados do Service Health são identificados pelas 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 projeto do Google Cloud. Essas entradas de registro incluem as geradas pelo projeto e as roteadas para o projeto. Para receber notificações 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 evento.

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 na análise de entradas de registro são mostrados com uma única referência de tempo. Por outro lado, os eventos do Service Health são mostrados com um horário de início e, em seguida, o plano de fundo do gráfico é alterado durante o evento. Esses eventos também exibem 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 evento informativo e de aviso.

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

  • Nome do evento.
  • Data e hora de início do evento.
  • Para eventos do Service Health, ícones 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, ela pode abrir a Análise de registros para que você possa visualizar as entradas de registro ou pode abrir 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 e eventos de série temporal.

Antes de começar

  • Para ter as permissões necessárias para visualizar e mostrar eventos nos 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).
    • Confira e mostre eventos identificados nas entradas de registro de acesso sem dados que foram criadas no seu projeto do Google Cloud: Visualizador de registros (roles/logging.viewer).
    • Confira e mostre os eventos identificados nas entradas de registro criadas no seu projeto do Google Cloud: Visualizador de registros particulares (roles/logging.privateLogViewer).
    • Veja os eventos do Service Health: Leitor do Custom Service Health (roles/servicehealth.viewer)

    Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

    Também é possível receber as permissões necessárias com papéis personalizados ou outros papéis predefinidos.

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

    Ative a API

Mostrar eventos

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

Configurar painéis para mostrar eventos

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

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

Console

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

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

    Acessar Painéis

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

  2. Selecione o painel que você quer acessar.

  3. Na barra de ferramentas do painel, verifique se a opção Eventos está ativada.

    Se o botão de alternância Eventos não for exibido, o painel não poderá exibir eventos.

  4. Clique em Selecionar tipos de evento, escolha os tipos de evento que você quer que o painel mostre e siga um destes procedimentos:

    • Se você estiver visualizando um painel personalizado e quiser salvar suas seleções de tipo de evento, clique em Fixar selecionados. Se o salvamento automático estiver desativado no painel, acesse a barra de ferramentas e clique em Salvar.

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

    • Caso contrário, clique em OK.

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

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

API

Se quiser 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, com dois campos:

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

  • Uma matriz de objetos EventAnnotation. 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 do botão de alternância do evento. Quando true, o botão fica na posição on, e os eventos são mostrados no painel. Quando false, o botão fica na posição off.
    • Um campo eventType, que contém um valor da enumeração de 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 projetos do Google Cloud para pesquisar eventos. Quando esse campo é uma matriz vazia, o projeto selecionado é pesquisado.

Veja a seguir um exemplo de 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.

Configure 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, fornecem uma guia Observabilidade, que exibe dados de métricas e registros.

Console

Se quiser 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, acesse a página Cargas de trabalho do Kubernetes ou a página de detalhes de uma instância de máquina virtual (VM) e selecione a guia Observabilidade.

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

  3. Na barra de ferramentas, clique em Select Events e preencha a caixa de diálogo.

    Depois de atualizar a lista de eventos a ser exibida, são emitidas consultas para recuperar os dados do evento, e o painel é atualizado.

    Quando o botão Selecionar eventos não é exibido, não é possível configurar a guia para exibir eventos.

API

Indisponível.

Mais detalhes do evento

Ao visualizar 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 do console do 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 projeto do Google Cloud, é possível receber notificações quando eles 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 configurou um canal de notificação, faça o seguinte:

    1. No console do Google Cloud, 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 Monitoramento.

    2. Clique em Editar canal de notificação.
    3. 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 console do Google Cloud, acesse a página 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, selecione Criar alerta.

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

  5. Na seção Definir entradas de registro para alertar sobre, insira uma consulta ou atualize a consulta que foi copiada do painel Consulta ao selecionar Criar alerta.

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

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

API

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 evento 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 de API alertPolicies.create. Por exemplo, é possível emitir o comando gcloud alpha monitoring policies create.

Ocultar eventos

Console

Para ocultar todos os eventos, na barra de ferramentas do painel, confira se a opção Eventos está desativada.

Para ocultar um tipo de evento, defina o botão desse tipo como desativado.

API

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

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

A seguir