Como usar o Explorador de registros

Antes de começar

Você não precisa de um espaço de trabalho para usar o Logging, a menos que esteja enviando registros do Amazon Web Services (AWS) para o Logging.

Se você estiver usando um espaço de trabalho, o Logging não combinará os registros dos projetos monitorados do Google Cloud. Você precisa selecionar um projeto específico do Cloud para ver os registros dele.

Se você estiver usando um espaço de trabalho e a AWS, selecione o projeto de conector da AWS para ver os registros da AWS.

Primeiros passos

Para navegar até o Explorador de registros, faça isto:

  1. Acesse o menu de navegação do Google Cloud e selecione Logging > Explorador de registros:
    Acessar o Explorador de registros
  2. Selecione um projeto do Google Cloud.
  3. No menu Upgrade, alterne de Visualizador de registros legados para Explorador de registros.

Agora você está no Explorador de registros.

Interface do Explorador de registros

A interface do Explorador de registros permite recuperar registros, analisar dados de registros e refinar os parâmetros de consulta.

Interface do usuário do Explorador de registros

  1. Página do Explorador de registros: permite criar, analisar e refinar consultas.
  2. Seletor de organização e projeto: permite que você visualize registros em nível de organização ou para envolvidos no projeto.
  3. Criador de consultas: permite criar consultas usando os menus suspensos ou a linguagem do criador de consultas. Ela também tem guias para visualizar suas consultas salvas e recentes.
  4. Campos de registro (Beta): permitem ver resultados baseados em agregação relativos aos campos resource.type, resource.labels, logName e severity. Também oferecem um jeito mais eficiente de refinar consultas.
  5. Histograma: permite visualizar a frequência dos seus dados de registros.
  6. Resultados da consulta: permite que você visualize os registros recuperados da sua consulta.
  7. Entradas de registro: permite que você visualize entradas de registro no formato JSON estruturado.
  8. Fuso horário: permite alterar o fuso horário em que os registros são exibidos.
  9. Layout da página: permite ativar e desativar os painéis Histograma e Explorador de campo de registros.
  10. Seletor de período: permite restringir os resultados por intervalo de tempo. O intervalo de tempo padrão é uma hora.
  11. Executar consulta: permite que você execute suas consultas depois de criá-las no painel do criador de consultas.
  12. Ir para agora: permite que você faça uma atualização forçada para incluir o horário atual. Se o seletor de intervalo de tempo usar um intervalo personalizado e um horário de término for definido, ele executará a consulta com um período padrão de uma hora. Caso contrário, ele será atualizado com a data ou a duração de início atual e executará a consulta.
  13. Ações: permitem configurar uma métrica com base em registros, criar um destino do coletor ou fazer o download dos registros.
  14. Configurar: permite adicionar o valor de um campo de registro à linha de resumo no início ou no final da entrada de registro. Isso também permite que você escolha exibir os registros mais recentes primeiro ou último.
  15. Ocultar resumo do registro: permite ocultar a linha de resumo de registro dos resultados da consulta.
  16. Expandir ou recolher campos de registro aninhados: permite expandir ou recolher campos aninhados.
  17. Copiar para área de transferência: permite copiar a entrada de registro no formato JSON.
  18. Salvar: permite que você salve consultas que podem ser visualizadas e executadas na guia Salvos.
  19. Dados de trace: permite visualizar detalhes de trace e refinar a consulta com base no trace.
  20. Expandir e recolher resultados da consulta: permite expandir o painel de resultados da consulta para visualizar mais entradas de registro.
  21. Ajustar período: permite alterar o período usado para consultas ajustando as alças. Depois de ajustar as alças, clique em Executar para atualizar o intervalo de tempo usado na consulta.
  22. Refinar escopo: permite que você defina o escopo da sua pesquisa por registros apenas no projeto atual ou por uma ou mais visualizações de armazenamento.

  23. Fixar entrada de registro: permite fixar uma entrada de registro nos painéis Resultados da consulta e Histograma. Dependendo de como o painel de Resultados da consulta está configurado, o Logging fixa o registro na parte superior ou na parte inferior do painel Resultados da consulta.

  24. Copiar um link para uma entrada de registro: permite que você compartilhe um link em uma entrada de registro.

  25. Janela de visualização do histograma: permite ver o período dos registros que são exibidos atualmente no painel Resultados da consulta.

No painel de resultados da consulta, é possível clicar nos valores de um campo para escolher fazer o seguinte:

  1. Mostrar entradas correspondentes: permite consultar entradas de registro correspondentes.
  2. Ocultar entradas correspondentes: permite consultar entradas de registro que não correspondem à expressão selecionada.
  3. Adicionar campo à linha de resumo: permite adicionar o campo como uma linha de resumo às entradas de registro.

Opções depois de selecionar o valor do campo

Refinar escopo

É possível refinar o escopo dos registros exibidos no Explorador de registros por meio do painel Refinar escopo. Você tem a opção de pesquisar apenas registros no projeto atual ou pesquisar registros com base em uma ou mais visualizações de armazenamento.

Para refinar o escopo do Explorador de registros, conclua estas etapas.

  1. No menu do Logging, selecione Explorador de registros.

    Acessar o Explorador de registros

  2. Selecione Refinar escopo.

  3. No painel Refinar escopo, selecione uma opção Escopo por.

    O painel Refinar escopo

    • Escopo por projeto: permite que você pesquise registros gerados pelo projeto atual.

    • Escopo por armazenamento permite pesquisar registros com base em uma ou mais visualizações de armazenamento.

  4. Se você selecionar Escopo por armazenamento, selecione um ou mais intervalos que quer visualizar.

    O painel lista as visualizações de armazenamento que atendem às seguintes condições:

    • O usuário tem acesso à visualização de armazenamento.
    • Os intervalos pertencem ao projeto selecionado ou se o projeto selecionado roteou registros para os intervalos de armazenamento.
  5. Clique em Aplicar.

Adicionar campos de resumo

Os campos de resumo ajudam a detectar padrões nos seus registros com mais rapidez. Por exemplo, a imagem a seguir mostra o valor do campo de resumo resource.labels.pod_name adicionado antes dos registros que contêm esse valor.

O Explorador de registros mostra os registros precedidos por um texto verde que exibe os
nomes dos pods.

Adicionar um campo de resumo de uma entrada de registro

Para adicionar um campo de resumo a uma entrada de registro, siga estas etapas:

  1. Expanda uma entrada de registro clicando no botão de expansão .

  2. Clique no valor de um campo e selecione Adicionar campo à linha de resumo.

    O campo de resumo agora aparece antes das entradas de registro que contêm esse campo.

Adicionar um campo de resumo usando o botão Configurar

Para adicionar um campo de resumo usando o botão Configurar, siga estas etapas:

  1. Clique em Configurar e selecione Gerenciar campos de resumo.

  2. Adicionar campos.

    A seleção do campo de resumo tem os seguintes recursos:

    • Preenchimento automático usando os registros exibidos no momento.
    • Correção de campo para caracteres aceitos entre aspas.

      Por exemplo, se você digitar jsonPayload.id-field, ele será alterado para jsonPayload."id-field".

  3. Clique em Truncar campos de resumo para reduzir a exibição dos valores do campo de resumo. Em seguida, escolha quantos caracteres exibir antes de o campo ficar truncado e se o início ou o término do campo é exibido.

  4. Clique em Aplicar.

    O campo de resumo agora aparece antes das entradas de registro que contêm esse campo.

Painel "Campos de registro"

O painel Campos de registro oferece um resumo de alto nível dos dados dos registros e fornece uma maneira mais eficiente de refinar consultas. Ele mostra a contagem de entradas de registro, classificadas por contagem decrescente, para o campo de registro especificado. As contagens do campo de registro correspondem ao período usado pelo painel Histograma.

O painel Campos de registro é preenchido e atualizado com base em uma consulta executada. Quando há uma consulta vazia, o painel Campos de registro exibe contagens de entradas de registro por campos de gravidade do registro e tipo de recurso.

O painel

Como usar o painel "Campos de registro"

É possível adicionar campos do painel Campos de registro ao Criador de consultas para restringir e refinar uma consulta. Para isso, clique em um valor de campo no painel Campos de registro. Isso adiciona o campo de registro ao Criador de consultas e executa automaticamente a consulta adicionando-a como uma expressão à consulta original usando o operador AND.

Quando uma consulta é executada, as contagens do campo de registro são carregadas gradualmente à medida que as entradas de registro são verificadas progressivamente. Quando a consulta é concluída, o que é indicado pelo encerramento da barra de progresso azul, você vê as contagens totais de todos os campos de registro.

Painel do histograma

O painel do histograma permite visualizar a distribuição de registros ao longo do tempo. Isso facilita a visualização das tendências nos dados dos registros e a solução de problemas.

Como ativar o painel de histograma

Para ativar o painel de histograma, selecione Layout de página e marque a caixa de seleção Histograma. O painel Histograma é exibido.

O layout da página está aberto e os histogramas estão selecionados

Para desativar o painel de histograma, desmarque a caixa de seleção Histograma.

Como usar o painel de histograma

Um histograma é gerado quando você executa uma consulta. Ela exibe a frequência de entradas de registro correspondentes para o período selecionado.

Como analisar registros

Para analisar seus dados de registro, passe o cursor sobre uma barra no painel Histograma e selecione Ir para este momento para detalhar um intervalo de tempo. Isso gera uma nova consulta com essa restrição de intervalo de tempo.

Histogramas de registros mostrando a caixa de diálogo pop-up para pular para o momento especificado

O painel Histograma apresenta uma janela de visualização que reflete o intervalo de tempo dos registros exibidos no painel Resultados da consulta. A janela de visualização ajuda a orientar você nos registros que estiver visualizando no período maior.

O tamanho da janela de visualização se baseia na duração entre o máximo e o mínimo de timestamp das entradas de registro exibidas no painel Resultados da consulta.

O painel do histograma está mostrando a janela de visualização.

Rastrear dados

Quando uma entrada de registro contém o campo relacionado a latência e trace, os ícones de latência e trace são exibidos.

Exibição da entrada de registro que contém dados de trace.

Quando uma entrada de registro contém apenas o campo trace, somente o ícone de trace é exibido.

Exibição de entrada de registro que contém apenas o ícone de trace.

Para visualizar os dados de trace relacionados à entrada de registro, clique no ícone de trace. Você tem as seguintes opções:

  • Visualizar detalhes do trace: mostra o período pai e os traces filhos, além de detalhes sobre o trace. Para ver mais detalhes sobre o trace, clique em Ver no Trace para navegar até ele. Para mais informações sobre o conteúdo no painel suspenso, consulte Como visualizar detalhes do trace.
  • Mostrar todos os registros deste trace: refina e executa a consulta adicionando o campo trace definido ao identificador do trace associado à entrada de registro.

  • Mostrar apenas solicitações rastreadas: refina e executa a consulta adicionando o campo traceSampled definido como True. Para mais informações sobre amostragem, acesse Taxa de amostragem.

Como fixar registros

Fixar um registro permite que você destaque uma entrada de registro de interesse. Para fixar um registro, passe o cursor sobre o registro que você quer fixar e selecione o ícone de fixação . Depois que você fixa uma entrada de registro, o plano de fundo dela fica escuro e um ícone de fixação é exibido.

Depois de fixar um registro e executar novamente sua consulta, o registro fixado aparecerá na parte superior ou inferior do painel de Resultados da consulta, dependendo de como seus registros estiverem configurados. Um ícone de alfinete também aparece no painel Histograma com base no timestamp do registro fixado.

O Explorador de registros mostra uma entrada de registro fixada nos painéis

Para liberar o registro, selecione o ícone de alfinete e depois Desafixar a entrada do registro.

Como visualizar uma entrada de registro fixada no contexto do recurso

É possível ver o registro fixado no contexto do recurso, o que permite examinar as entradas de registro em torno do registro fixado que têm o mesmo tipo de recurso que o registro fixado.

Para visualizar o registro fixado no contexto do recurso, selecione o ícone de fixação e, em seguida, selecione Fixar e mostrar entradas de registro de recursos.

Fixar e mostrar no contexto do recurso está selecionado.

O Logging preenche o Criador de consultas com o tipo de recurso do registro fixado e executa a consulta. Agora é possível visualizar a relação do registro fixado com seu tipo de recurso.

Como visualizar uma entrada de registro fixada no painel Histograma

Usando o painel Histograma, selecione o registro fixado e, em seguida, selecione Aplicar zoom até a entrada de registro para restringir o período de exibição do painel Histograma. Isso permite que você refine sua consulta para isolar os registros próximos ao registro fixado.

O período do histograma foi restringido.

Para compartilhar um link em um registro, expanda uma entrada de registro e selecione Copiar link. O link será copiado para a área de transferência. Agora é possível enviar o link para os usuários que têm acesso ao projeto. Quando um usuário cola o link em um navegador ou o seleciona, o Logging fixa a entrada de registro no painel Resultados da consulta.

Copie o link para compartilhar a entrada de registro com outras pessoas.

Fazendo download de registros

É possível fazer o download dos registros no formato CSV ou JSON. Você precisa dos seguintes papéis para fazer o download de registros:

  • Administrador do Logging (roles/logging.admin)
  • Acessador de visualização de registros (roles/logging.viewAccessor)

Para fazer o download dos registros, siga estas etapas:

  1. Selecione Ações e, em seguida, Fazer o download de registros.

    Faça o download de registros com o botão de ação.

  2. Na caixa de diálogo "Fazer o download de registros", selecione o formato CSV ou JSON e escolha fazer o download dos registros para o computador, para o Drive ou visualizá-los em uma nova guia.

    Ao salvar um CSV e selecionar o Drive, será possível abrir o arquivo no Planilhas.

Solução de problemas

Nesta seção, fornecemos instruções para solucionar problemas comuns ao usar o Explorador de registros.

Como selecionar um projeto ou uma organização do Cloud

Para selecionar um projeto do Cloud de qualquer lugar no Console do Google Cloud, inclusive no Explorador de registros, use o seletor de projeto e organização:

Um projeto é selecionado no menu suspenso

Como conseguir o ID do projeto ou da organização do Cloud

Para receber um ID do projeto ou da organização do Cloud de qualquer lugar no Console do Google Cloud, expanda a lista de projetos do seletor de projeto e organização e encontre o ID na coluna ID:

O ID do projeto é mostrado

Não é possível ver as entradas de registro

Se nenhuma entrada de registro for exibida, verifique o seguinte:

  • O projeto correto está selecionado? Caso contrário, selecione o projeto correto no seletor de projeto e organização.

  • Seu projeto está usando recursos que geram registros e há atividade nesses recursos? Mesmo que o projeto seja novo, ele precisa ter registros de auditoria que gravam o fato de ter sido criado. Verifique se você está usando um recurso que gera registros acessando a seção "Como mapear serviços para tipos de recursos" na página "Lista de recursos monitorados".

  • O intervalo de tempo é muito limitado? Verifique se o período em sua consulta está correto.

  • Visualize suas consultas de exclusão atuais para garantir que os registros que você está procurando não sejam excluídos acidentalmente.

Minha consulta está correta, mas ainda não vejo as entradas de registro

  • Não é possível ver entradas de registro anteriores ao período de armazenamento do Logging. Para o período de armazenamento de registros ativo, veja esta página.

  • Durante períodos de muita atividade, pode haver um tempo de espera no envio de registros para o Logging ou no recebimento e exibição dos registros.

  • O Explorador de registros não mostra as entradas de registro que têm carimbo de data/hora no futuro até que esses momentos cheguem. Essa é uma situação incomum causada provavelmente por um desvio no tempo do aplicativo que envia os registros.

Como receber suporte

Para informações sobre como receber suporte, consulte a página de suporte do pacote de operações do Google Cloud.