Mostrar registros e erros em um painel personalizado

Este documento descreve os widgets que você pode adicionar aos seus painéis personalizados para que você possa visualizar os dados de registros e erros no mesmo contexto que seus dados de métricas. O widget do painel de registros exibe as entradas de registro. O widget do painel do Error Reporting exibe os grupos de erros mais recentes. Ambas as opções os widgets fornecem informações que podem ser úteis na solução de problemas. O widget de gráfico da Análise de dados de registros, que exibe os resultados de uma consulta SQL, permite identificar tendências nos dados de registro.

Análise de registros e widget do painel de registros

A Análise de registros é a maneira padrão de investigar registros. Adicionar um widget de painel de registros a um painel não muda a forma como você usa a Análise de registros. Como é possível adicionar widgets do painel de registros painéis personalizados, eles fornecem uma maneira de visualizar as entradas de registro no mesmo contexto das métricas.

A Análise de registros e o widget do painel de registros são compatíveis com mesma linguagem de consulta e ambas exibirem somente aquelas que você tem permissão para visualizar. Seu papéis do Identity and Access Management (IAM) nos recursos que armazenam as entradas de registro determinar se é possível visualizar as entradas de registro armazenadas.

A Análise de registros e o widget do painel de registros são pré-configurados para pesquisar os recursos listados no escopo de registro padrão para entradas de registro. Se esse escopo não estiver acessível, ele vai procurar as entradas de registro que se originam do projeto selecionado. Quando um projeto é selecionado, os resultados da pesquisa incluem o que são roteadas para o projeto por um coletor em outro projeto e armazenados em um bucket de registros. É possível configurar quais recursos são pesquisados em entradas de registro. Por exemplo: Você pode pesquisar entradas por visualização de registros.

Os widgets do painel de registros mostram uma entrada por linha, com colunas para gravidade, carimbo de data/hora e um resumo da entrada. Para exibir a representação formatada em JSON de um registro entrada, clique no botão Visualizar detalhes do registro. A estrutura do resumo de cada entrada varia de acordo com o tipo de registro. Por exemplo: a imagem a seguir mostra duas entradas de registro:

Imagem de duas entradas de registro no widget do painel de registros.

Na imagem anterior, a primeira entrada de registro mostra informações sobre uma solicitação de serviço. O resumo mostra informações o serviço, um endereço de e-mail e uma versão formatada em string do Estrutura JSON para a entrada. A segunda entrada mostra os resultados de uma solicitação e exibe apenas uma frase que resume a ação que ocorreu.

Para informações gerais sobre o Cloud Logging, consulte os seguintes recursos:

Antes de começar

Para ter as permissões necessárias para adicionar um widget do painel de registros a um painel personalizado usando o o console do Google Cloud e configurá-lo para exibir entradas de registro em projetos ou em visualizações de registros, peça ao administrador para conceder a você os seguintes papéis do IAM:

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.

Exibir entradas de registro em um painel

Nesta seção, descrevemos como adicionar e configurar um widget do painel de registros usando no console do Google Cloud. Para mais informações sobre como usar a API Cloud Monitoring, consulte Painel com um widget LogsPanel.

É possível incluir até 40 widgets no painel.

Para adicionar um widget de painel de registros ao painel usando o console, faça o seguinte:

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

    Ir para Painéis

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

  2. Selecione um painel ou clique em Criar painel.
  3. Na barra de ferramentas, clique em  Add widget.
  4. Na caixa de diálogo Adicionar widget, selecione  Registros.
  5. Opcional: para atualizar o título, digite o novo título Campo Título do widget.

  6. Configure quais recursos são pesquisados em entradas de registro:

    • Para pesquisar por projeto, defina a entrada Escopo por como Projeto Expanda a entrada Projects e preencha a caixa de diálogo.

      O menu Projetos lista todos os projetos do Google Cloud no ambiente atual escopo das métricas. Se uma entrada no menu incluir o texto "Você não tem permissão no nível do projeto para consultar os registros neste projeto", você não tem as permissões necessárias para visualizar as entradas de registro disponíveis nesse projeto do Google Cloud.

      As entradas de registro exibidas incluem aquelas que se originam no seu projeto do Google Cloud e aquelas que são roteadas para seu projeto do Google Cloud por um coletor em outro projeto.

    • Para pesquisar entradas de registro por visualizações de registro nos buckets de registros, defina a entrada Escopo por como Armazenamento e, em seguida, expanda a entrada Storage views e preencha a caixa de diálogo.

      O menu Visualizações de armazenamento lista as visualizações de registro nos buckets de registro do seu projeto do Google Cloud selecionado.

      Para selecionar visualizações de registros em buckets de registros em outros projetos do Google Cloud, no menu, Clique em Importar projeto. selecione um projeto e uma ou mais visualizações de registro. Só é possível importar projetos que estão incluídas no escopo de métricas atual.

    • Para pesquisar os recursos incluídos em um escopo de registros, que podem incluir projetos e visualizações de registros, defina a entrada Escopo por como Escopo dos registros e expanda a entrada Escopos de registro e selecione um deles.

      Os escopos do registro estão no Acesso antecipado.

  7. Opcional: para restringir os registros exibidos pelo widget do painel, insira uma consulta no campo Editor de consultas e, caso tenha desativado consultas sejam executadas automaticamente, e clique em Executar consulta. Para uma breve introdução às consultas, consulte Exemplos de consulta.

  8. Opcional: aplique as variáveis de modelo ao widget do painel de registros. Para mais informações, consulte Aplique um filtro permanente a um widget.

  9. Para aplicar as alterações ao painel, na barra de ferramentas, Clique em Aplicar. Para descartar as mudanças, clique em Cancelar.

  10. Para salvar o dashboard modificado, clique em Salvar na barra de ferramentas.

    O widget do painel de registros exibe uma tabela de entradas de registro. Também é possível usar o filtro do widget para alterar temporariamente as entradas de registro que o widget exibe. Para mais informações, consulte a seção chamada Filtre as entradas de registro.

Exemplos de consultas

Para preencher o campo Editor de consultas, insira o texto nele ou faça seleções nos menus. O campo Editor de consultas usa a mesma linguagem de consulta que o Explorador de registros. Para informações sobre solução de problemas, consulte Problemas de sintaxe.

Os menus Gravidade e Nome do registro permitem que você selecione várias opções. Veja a seguir um exemplo de instrução de consulta que corresponde a vários níveis de gravidade:

severity=(WARNING OR ERROR OR CRITICAL OR ALERT OR EMERGENCY)

O menu Recurso permite filtrar por recurso. Você pode selecionar um tipo de recurso, como Recurso auditado, ou navegar pelos as janelas para selecionar um método específico.

Por exemplo, para adicionar uma consulta para Recurso auditado, faça o seguinte:

  1. Abra o menu Recurso.
  2. Pesquise e selecione Recurso auditado.

  3. Clique em Aplicar.

    Estas etapas adicionam a seguinte cláusula ao campo Editor de consultas:

    resource.type="audited_resource"

Da mesma forma, para adicionar uma consulta aos registros de auditoria de funções do Cloud Run, faça o seguintes:

  1. Abra o menu Recurso.
  2. Pesquise e selecione Recurso auditado.
  3. No menu de serviços, selecione Cloud Functions.

  4. Clique em Aplicar.

    Essas etapas adicionam a seguinte cláusula ao Editor de consultas campo:

    resource.type="audited_resource" resource.labels.service="cloudfunctions.googleapis.com"

Filtrar as entradas de registro

É possível modificar quais entradas de registro um widget de painel de registros exibe modificando os valores dos seguintes campos ou menus:

  • Seletor de tempo do painel: o widget do painel de registros recupera apenas que são entradas de registro escrito no intervalo especificado por este campo.

  • No campo Filtro no widget do painel de registros: O filtro especificado é aplicado. após a conclusão da consulta. O valor desse campo é retido apenas para a sessão atual.

  • Menu Gravidade no widget do painel de registros: o filtro por nível de gravidade é aplicada após a conclusão da consulta. O valor desse campo é mantido apenas para a sessão atual.

  • Consultar no widget do painel de registros: o widget do painel de registros é exibido apenas as entradas de registro que correspondem à consulta. Se você não especificar uma consulta, todos os registros o intervalo de tempo selecionado são exibidos. Se você especificar uma consulta, o widget do painel de registros exibe uma opção Mostrar consulta que mostra a consulta atual como uma dica.

    Para modificar a consulta, edite o widget do painel de registros.

  • Projeto do Google Cloud no widget do painel de registros: para modificar essa configuração, editar o widget do painel de registros.

  • Filtros do painel: quando existem filtros do painel, a configuração do filtro é aplicada à consulta do widget do painel de registros. Por exemplo, se você adicionar o filtro de painel cluster_name: mycluster, a consulta será atualizada para incluir resource.labels."cluster_name"="mycluster". Para mais informações sobre filtros de painel, consulte Adicione filtros temporários e Adicione filtros permanentes.

O restante desta seção oferece mais informações sobre como filtrar as entradas de registro.

Exemplo: filtrar entradas de registro por data

Para exibir os registros mais recentes em um widget do painel de registros, use os campos de tempo na barra de ferramentas do painel. Por exemplo, selecione 1H. Contanto que você não selecione um período personalizado, o widget sempre exibirá os registros mais recentes, mesmo quando anterior à janela de tempo selecionada.

Ao investigar um incidente, é possível restringir as entradas de registro às entradas que estão em um intervalo de tempo específico. Para configurar as entradas de registro para mostrar os registros que estão em um intervalo de tempo fixo, siga um ou ambos os procedimentos a seguir:

  • Selecione um intervalo de tempo usando o seletor de intervalo de tempo.
  • Insira uma cláusula timestamp no campo Editor de consultas do painel de configuração e selecione Aplicar filtro.

Quando você especifica um intervalo de tempo, o widget do painel de registros não é ativado automaticamente atualizado.

Exemplo: filtrar entradas de registro por gravidade

Quando você está monitorando a depuração de uma situação de falha, convém ver apenas mensagens de erro e ocultar da exibição todas as outras entradas de registro. Para configurar um widget de painel de registros para exibir apenas as entradas que satisfaçam níveis de gravidade específicos, siga um ou ambos os procedimentos a seguir:

  • Para aplicar um filtro temporário, selecione um valor para o menu Gravidade em no widget do painel de registros. Esse menu especifica um nível de gravidade mínimo. Por exemplo, um valor de "Aviso" resulta na recuperação de entradas de registro com uma gravidade "Erro", mas aquelas com uma gravidade de "Aviso" não são recuperadas. Por padrão, o valor desse campo é definido como Default, o que inclui todas as entradas de registro.

    A configuração do menu Gravidade é descartada quando você sai do painel.

  • Para aplicar um filtro permanente, insira uma cláusula severity no campo Editor de consultas no painel de configuração e selecione Aplicar filtro.

Exemplo: filtrar entradas de registro por uma string ou frase

Filtrar entradas de registro por string ou frase específica permite eliminar a visualização de entradas de registro que não são de interesse. Por exemplo, para visualizar entradas de registro que incluem um endereço de e-mail específico, filtre por esse endereço.

  • Para aplicar um filtro temporário para visualizar apenas as entradas de registros que contêm uma palavra ou frase específica, use o campo Filtro. O contém-test é indiferente a maiúsculas.

    Se você adicionar vários filtros, somente os registros que corresponderem a todos os filtros serão mostrados porque um AND implícito é inserido entre filtros adjacentes. No entanto, é possível inserir explicitamente um operador OR:

    • Por exemplo, quando você adicionar os filtros Get e Compute, serão exibidas entradas de registro que contêm as duas palavras.

    • Por exemplo, quando você adiciona os filtros Get, OR e Compute, as entradas de registro que contêm Get ou Compute são exibidas.

    O valor do campo Filtro não é persistente.

  • Para aplicar um filtro permanente, modifique a consulta armazenada no campo Editor de consultas e selecione Aplicar filtro. Para informações sobre a sintaxe da consulta, veja a Linguagem de consulta do Logging.

    Por exemplo, para exibir somente essas entradas de registro com um campo MESSAGE cujo valor contém a string "lamp", adicione a cláusula jsonPayload.MESSAGE:"lamp" ao Editor de consultas.

Ver entradas de registro no Explorador de registros

Os widgets do painel de registros mostram campos de entradas de registro. Eles não mostram a entrada de registro completa. Para examinar todos os campos de uma entrada de registro, faça o seguinte:

  1. No widget do painel de registros, selecione Ver na Análise de registros.

  2. Na caixa de diálogo, selecione o projeto do Google Cloud em que o Explorador de registros será aberto.

    A Análise de registros é aberta em uma nova guia do navegador, e os filtros selecionados no widget do painel de registros são aplicados automaticamente.

  3. Selecione a entrada de registro que você quer ver.

Mostrar gráficos gerados de uma consulta da Análise de dados de registros

Esta seção descreve como configurar e salvar um gráfico gerado a partir de uma consulta do Log Analytics em um painel personalizado. Com a Análise de dados de registros, pesquisar e agregar registros para gerar insights úteis usando consultas SQL.

Além de usar a página Análise de dados de registros para configurar e salvar gráficos no um painel, salve um gráfico da Análise de dados de registros diretamente no Monitoring fazendo o seguinte:

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

    Ir para Painéis

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

  2. Selecione um painel ou clique em Criar painel.
  3. Na barra de ferramentas, clique em  Add widget.
  4. Na caixa de diálogo Adicionar widget, acesse a seção Dados e Em seguida, selecione Análise de dados de registros.
  5. No painel Configurar widget, defina os dados que serão mostrados na gráfico criando uma consulta usando SQL e clicando em Executar consulta.

  6. Opcional: na guia Resultados, personalize a configuração do gráfico usando o painel Exibição.

    No painel Exibição, é possível mudar o tipo de gráfico e personalizar quais linhas e colunas são representadas mudando a dimensão, a medida e o detalhe:

    • Dimensão: A dimensão precisa ser uma coluna de carimbo de data/hora, numérica ou de string. Por padrão, a dimensão é definida como a primeira coluna baseada em carimbo de data/hora no esquema. Se nenhum carimbo de data/hora estiver presente na consulta, o a primeira coluna de string é selecionada como a dimensão. Também é possível personalizar a dimensão no painel Exibição do gráfico. Quando uma coluna de carimbo de data/hora é selecionada como dimensão, o gráfico mostra como os dados mudam com o tempo.

    • Medir: É possível selecionar várias medidas no painel Exibição do gráfico. Ao selecionar uma medida, você também precisa selecionar a função de agregação a ser realizada nos valores agrupados, como count, sum, average e percentile-99. Por exemplo, count-distinct retorna o número de valores exclusivos em uma determinada coluna.

    • Detalhamento: Para dividir uma única série de dados em várias com base em outra coluna, adicione um detalhamento.

    Para mais informações sobre como personalizar a configuração do gráfico, consulte Personalize a configuração do gráfico.

  7. Para salvar o painel modificado, clique em Salvar na barra de ferramentas.

Os gráficos da Análise de dados de registros também podem ser editados depois de serem salvos em um painel. Para mais informações, consulte Modificar a configuração de um widget.

Exibir erros em um painel

Esta seção descreve como adicionar e configurar um painel de relatório de erros usando no console do Google Cloud. Para informações sobre como adicionar um painel de relatório de erros para um painel usando a API Cloud Monitoring, consulte Painel com um widget ErrorReportingPanel.

Para adicionar um painel do Error Reporting ao painel usando o console, faça o seguinte:

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

    Ir para Painéis

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

  2. Selecione um painel ou clique em Criar painel.
  3. Na barra de ferramentas, clique em  Adicionar widget.
  4. Na caixa de diálogo Adicionar widget, acesse a seção Visualização e selecione Painel de notificação de erros.
  5. Selecione o projeto em que os grupos de erros aparecem, abra Projects e faça uma seleção.
  6. Opcional: atualize o título.

  7. Opcional: para restringir os recursos em que os erros são exibidos, faça o seguinte:

    1. abra Todos os recursos e selecione um deles.

    2. Depois de selecionar um recurso, selecione Aplicar ou use os outros menus para refinar os critérios de filtro:

      • Para mostrar erros em recursos do App Engine, selecione GAE Services e clique em Aplicar.

      • Para mostrar erros de um serviço específico do App Engine, selecione GAE Services, selecione o serviço e clique em Aplicar.

  8. Para aplicar as alterações ao painel, na barra de ferramentas, Clique em Aplicar. Para descartar as mudanças, clique em Cancelar.

    O exemplo a seguir mostra um painel do Error Reporting:

    Exemplo de um painel de configuração do painel do Error Reporting.

  9. Para salvar o dashboard modificado, clique em Salvar na barra de ferramentas.

Resolver problemas

A seguir