Como ver os registros (Clássico)

Neste guia, mostramos como pesquisar registros e visualizar entradas de registro com o visualizador de registros do Cloud Logging (Clássico).

  • Para ler entradas de registro por meio da API Logging, consulte entries.list.
  • Para ler entradas de registro usando o SDK do Cloud, consulte esta página.

Antes de começar

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

O visualizador de registros exibe registros de um único projeto do Google Cloud. Se você estiver usando um espaço de trabalho, o Stackdriver Logging não combinará os registros dos projetos monitorados. Selecione um projeto específico para visualizar 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 dessa plataforma.

Se você ingerir registros de nuvem híbrida e no local por meio do BindPlane, poderá encontrá-los no tipo de recurso generic_node.

Primeiros passos

  1. Acesse a página Logging > Registros (visualizador de registros) no Console do Cloud:

    Acessar a página "Visualizador de registros"

  2. Selecione um projeto atual do Google Cloud na parte superior da página ou crie um novo.

  3. Use os menus suspensos para selecionar o recurso com os registros que você quer ver.

Se você não vir nenhum registro, consulte a seção Como solucionar problemas abaixo.

Interfaces de consulta do visualizador de registros

Há duas interfaces de consulta no visualizador de registros:

  • A interface de consulta básica permite que você selecione registros a partir de menus e tenha um recurso de pesquisa simples.
  • A interface de consulta avançada permite visualizar entradas de vários registros e tem um recurso de pesquisa mais sofisticado.

É possível alternar entre essas interfaces usando a seta suspensa (▾) à direita da caixa de consulta de pesquisa em qualquer interface.

A captura de tela a seguir mostra o layout do visualizador de registros com a interface de consulta básica. Ela exibe as entradas de registro de um aplicativo do App Engine:

Visualizador de registros

A interface de consulta básica tem os seguintes componentes principais, indicados por números vermelhos na captura de tela acima. Alguns deles são compartilhados com a interface de consulta avançada:

  1. O guias de janela deixar você ficar em Registros (a página Visualizador de registros) ou escolher entre outros recursos do Logging: Métricas (veja Métricas com base em registros), Exportações (veja Como exportar com o Visualizador de registros) e Processamento de registros (veja Exclusões de registros).
  2. A caixa de consulta de pesquisa na interface básica permite consultar entradas de registro por pesquisa de texto ou de rótulo. A consulta básica é mostrada, e a seta suspensa (▾) no canto direito permite alternar para a interface de consulta avançada ou receber um link para a consulta. As consultas de registro são rotuladas como "filtros" na interface do usuário, porque permitem que você selecione um conjunto específico de entradas.
  3. O menu básico de seleção permite selecionar recursos, registros e níveis de gravidade a serem exibidos:

    • Recursos: os recursos disponíveis no seu projeto atual.
    • Registros: os tipos de registro disponíveis para os recursos atuais no projeto.
    • Gravidade do registro: os níveis de gravidade do registro.
  4. Os menus suspensos de seleção de intervalo de tempo permitem consultar datas e horas específicas nos registros.

  5. Seletor de transmissão: localizado na parte superior da página, controla se as novas entradas de registro são exibidas conforme elas chegam.

  6. A tabela de entrada de registro contém as entradas de registro disponíveis de acordo com suas consultas atuais e campos personalizados.

  7. A seta de expansão (▸) na frente de cada entrada de registro permite ver todo o conteúdo da entrada. Para mais informações, consulte Expandir entradas de registro.

  8. O menu Ver opções, na extremidade direita, tem mais opções de exibição.

  9. O menu Fazer o download de registros, na extremidade direita, permite fazer o download de entradas de registro. Para mais detalhes, consulte Fazer o download de entradas de registro.

  10. A opção Mais (⋮) exibida com cada entrada de registro permite colocar um alfinete na entrada de registro, mostrar a entrada de registro no contexto do recurso dele e copiar um URL da entrada de registro para a área de transferência.

Por fim, o visualizador de registros usa a posição do cursor para destacar a entrada de registro associada e colocar um símbolo de alfinete (📌) próximo de Mais (⋮).

Rolar e transmitir registros

Ao abrir o visualizador de registros pela primeira vez, você vê entradas de registro recentes suficientes para preencher a tela. Quando você rola pelas entradas, o visualizador busca mais delas. Com a barra amarela acima e abaixo dos registros, você confere se há mais entradas disponíveis.

Os ícones na parte superior da tela controlam quando os registros são atualizados:

  • Clique no ícone de atualização refresh para recuperar os registros mais recentes e role para baixo para exibi-los.
  • Clique no ícone de reprodução play_arrow para transmitir os registros mais recentes. O streaming é interrompido quando você seleciona uma entrada de registro ou rola a tela de registros.
  • Clique no ícone de pausa pause para interromper o streaming.

Rolar até um horário

Consulte as entradas de registro por data e hora usando os menus de seleção de intervalo de tempo abaixo da caixa de pesquisa.

Seletor de intervalo

A seleção padrão é Última hora. É possível usar o menu suspenso para selecionar outros intervalos de tempo ou definir um intervalo:

  • Selecione Ir para este ponto no tempo para consultar os registros em uma data e hora específicas.
  • Selecione Personalizar para especificar um intervalo ou um fuso horário personalizado.

Para mostrar as entradas de registro atuais, clique em Ir para o momento atual.

Em todos os casos, uma seleção faz com que o visualizador de registros atualize a tela. Em seguida, será possível percorrer e inspecionar as entradas de registro exibidas.

Para redefinir a data e a hora a fim de que elas correspondam à entrada de registro recém-recebida, clique no ícone de atualização ou reprodução.

Alterar o fuso horário

É possível selecionar um fuso horário para suas entradas de registro:

  1. No menu suspenso Última hora, selecione Personalizar.
  2. Clique na seta de expansão (▾) em qualquer um dos novos menus para abrir um calendário suspenso.
  3. No painel Fuso horário, selecione um país e fuso horário.

Sua seleção faz com que o visualizador de registros atualize a tela e o fuso horário de cada entrada de registro:

Personalizar o fuso horário

Expandir entradas de registro

A tabela de entrada de registro exibe uma linha de resumo para cada entrada por padrão.

Linha de resumo da entrada de registro

A linha de resumo da entrada de registro pode conter campos destacados. Por exemplo, os campos personalizados são destacados.

Os campos incluídos na linha de resumo são selecionados como subconjuntos dos campos de entrada de registro. Por padrão, alguns campos são exibidos se atenderem a um ou mais destes critérios:

  • A entrada de registro precisa ter um tipo conhecido, como um registro de solicitação do App Engine.
  • A entrada de registro contém o campo httpRequest.
  • A entrada de registro tem um payload contendo um campo chamado message.

Para detalhes completos de uma entrada de registro, clique na seta de expansão (▸) na frente da linha de resumo. Para detalhes completos em uma visualização estruturada de todas as entradas de registro disponíveis na consulta atual, clique no menu Ver opções no canto direito e selecione Expandir tudo:

Visualizar menu de opções

É possível selecionar Recolher tudo para recolher todos os detalhes da entrada de registro expandida.

Quando você expande uma linha de resumo de uma entrada de registro, o visualizador de registros exibe uma representação estruturada (JSON):

Entrada de registro de solicitação estruturada

Para uma descrição dos campos em uma entrada de registro, consulte o tipo LogEntry.

Adicionar campos personalizados

Campos personalizados são campos dentro de entradas de registro que você especifica para serem incluídos na linha de resumo. Sempre que estiverem disponíveis nas entradas de registro, esses campos serão preenchidos e destacados em azul.

Campos personalizados na linha de resumo

Há duas maneiras de adicionar campos personalizados às linhas de resumo da tabela de entrada de registro:

  • Em uma entrada de registro expandida, clique em um campo dentro da representação JSON. No painel resultante, selecione Adicionar campo à linha de resumo:

Adicionar campo à linha de resumo

  • No menu Ver opções, no canto superior direito do Visualizador de registros, selecione Adicionar campos personalizados. Se você já tiver campos personalizados no projeto, essa opção será Modificar campos personalizados. No painel resultante, adicione a chave JSON que você quer usar e clique em Salvar. É possível adicionar várias chaves separando-as por vírgulas. Para reorganizar a aparência dos campos personalizados nas linhas de resumo, reordene o texto nesse painel e clique em Salvar.

Adicionar campo JSON à linha de resumo

Há duas maneiras de remover campos personalizados das linhas de resumo da tabela de entrada de registro:

  • Para remover um campo personalizado de uma linha de resumo, clique no campo e selecione Remover campo da linha de resumo.
  • No menu Ver opções, na parte superior direita do visualizador de registros, selecione Modificar campos personalizados. No painel resultante, exclua as chaves JSON que você quer remover e clique em Salvar.

Os campos personalizados serão adicionados ao URL atual e permanecerão enquanto você continuar usando esse URL ou estiver na mesma sessão do navegador. Não é possível defini-los em um nível global nem salvá-los por usuário ou projeto do Google Cloud.

Não é possível remover os campos padrão da tabela de entrada de registro.

Fixar uma entrada de registro

Se você identificou uma entrada de registro interessante e quer investigar entradas próximas, fixe essa entrada. Depois que a entrada de registro é fixada, é possível alterar a consulta. Assim, o visualizador de registros concentra automaticamente a pesquisa ao redor da entrada fixada. Com esse recurso, é possível examinar a entrada de registro no contexto especificado por um filtro definido por você. Depois que um registro é fixado, a cor do plano de fundo é alterada e um alfinete é exibido:

Entrada de registro fixada

Para fixar uma entrada de registro, clique no ícone de alfinete ou clique em Mais (⋮) e selecione Fixar essa entrada de registro.

O alfinete colocado em uma entrada de registro só fica visível para você. Outros usuários que olharem as mesmas entradas de registro não verão seu alfinete nem terão a visualização modificada de qualquer outra maneira.

Fixar uma entrada de registro não altera a interface de consulta, as configurações de consulta nem atualiza o conteúdo exibido. É você quem determina as configurações de consulta e quando a exibição do visualizador de registros precisa ser atualizada. É possível modificar as configurações de consulta e atualizar a tela quantas vezes quiser sem afetar os registros fixados.

Fixar uma entrada de registro interrompe o streaming, se estiver ativado no momento.

Se uma entrada de registro estiver fixada, será possível mover ou remover o alfinete:

  • Para mover o alfinete para uma entrada de registro diferente, na nova entrada de registro, clique no ícone de alfinete ou clique em Mais (⋮) e selecione Mover a marcação para esta entrada de registro.

  • Para desafixar uma entrada de registro, clique no símbolo de alfinete ou clique em Mais (⋮) e selecione Desafixar esta entrada de registro.

Se você ativar o streaming enquanto uma entrada de registro estiver fixada, o visualizador de registros removerá o alfinete.

Mostrar registros similares

Clique no valor de um campo individual na visualização expandida de entrada de registro para mostrar ou ocultar todas as entradas de registro com o mesmo valor:

Mostrar entradas correspondentes

Quando você fizer isso, o visualizador de registros será alterado para a interface de consulta avançada. Para modificar a pesquisa, edite a consulta e clique em Enviar filtro. Para mais informações, consulte a interface de consulta avançada.

Além disso, é possível correlacionar as entradas de registro de solicitações do App Engine e visualizá-las em uma estrutura aninhada. Para mais detalhes, consulte Como exibir entradas de registro de solicitações relacionadas e selecione sua linguagem de ambiente de execução.

Mostrar detalhes de latência

Novo Para registros de solicitação do Google App Engine, o Visualizador de registros fornece um link para o Cloud Trace para facilitar a visualização dos detalhes de latência da entrada de registro.

Para mostrar o menu de opções relacionadas à latência de uma entrada de registro, identifique o campo protoPayload.latency:

Mostrar protoPayload.latency

Clique no valor de latência:

Mostrar opções de latência

As duas primeiras opções no menu restringem as entradas de registro mostradas àquelas com maior ou menor latência. A última opção no menu restringe as entradas de registro àquelas que contêm detalhes de trace visíveis pelo Cloud Trace. Especificamente, a última opção restringe as entradas de registro àquelas em que a opção Visualizar detalhes do trace está ativada.

Como visualizar os detalhes de latência no Cloud Trace

Para determinados registros de solicitações do App Engine, a opção Visualizar detalhes do rastreamento está ativada. Quando ativada, clique nessa opção para abrir o Cloud Trace e exibir os detalhes de latência da entrada de registro:

Mostrar cronograma de rastreamento

Mostrar no contexto do recurso

Se você encontrou uma entrada de registro interessante e quer identificar outras entradas de registro associadas ao mesmo tipo de recurso, clique em Mais (⋮) na extremidade direita da linha e selecione a opção Mostrar no contexto do recurso:

Mostrar contexto

Em resposta à sua ação, o visualizador de registros faz o seguinte:

  1. Fixa a entrada de registro.
  2. Alterna para a interface de consulta avançada e substitui o conteúdo da consulta por uma consulta no tipo de recurso.
  3. Atualiza a tela. A entrada de registro fixada é exibida na parte inferior da tela.

Mostrado no contexto

Compartilhar uma entrada de registro

Para compartilhar uma entrada de registro, clique em Mais (⋮) e selecione Copiar link para a entrada de registro da área de transferência. Com isso, o visualizador de registros gera um URL exclusivo para a entrada de registro e copia o URL na área de transferência.

Selecionar registros

Use os menus e a caixa de pesquisa para encontrar os registros que você quer ver:

  • Selecione um tipo de recurso e instância com os registros que você quer ver. É possível visualizar todas as instâncias desse tipo de recurso ou selecionar uma específica. Na captura de tela acima, a opção Instância da VM do GCE, referente a todas as instâncias, está selecionada. Para ver uma lista de tipos de recursos, consulte Lista de recursos monitorados.

  • Selecione os registros nomeados que você quer ver no segundo menu ou selecione Todos os registros. O menu mostra os registros que estão sendo usados pelas instâncias de recurso selecionadas.

  • Selecione o menor nível de gravidade que você quer ver no terceiro menu. Selecionar Qualquer nível de registro também mostra entradas de registro que não têm gravidade atribuída.

  • Selecione o intervalo de tempo que você quer ver no quarto menu, ou selecione Ir para o momento atual no quinto menu.

Conforme você altera as seleções dos menus, as entradas de registro correspondentes são exibidas.

Observações sobre o menu:

  • São exibidos apenas os tipos de recurso, instâncias e nomes de registros que estão no seu projeto. Pode levar algum tempo para que os menus sejam atualizados depois que você adicionar um novo tipo de recurso ou instância ou fizer gravações em um novo registro.

  • Na interface de consulta básica, é possível analisar apenas as entradas de registro de um tipo de recurso de cada vez. A interface de consulta avançada permite vários tipos de recursos.

  • Nenhum registro será exibido se você navegar até um momento anterior ao período de armazenamento atual. Para mais informações, consulte Períodos de armazenamento dos registros.

Fazer o download de entradas de registro

Com alguns cliques, é possível fazer o download, no formato JSON ou CSV, de todas as entradas de registro armazenadas na memória de trabalho do visualizador de registros. Por motivos de desempenho, o visualizador de registros tenta carregar 100 entradas de registro de cada vez e não retém mais do que 300 entradas de registro na memória de trabalho. Esses valores não são configuráveis.

Para fazer o download de entradas de registro, clique no menu Fazer o download de registros, localizado na parte superior direita do visualizador de registros. Na caixa de diálogo de download, selecione JSON ou CSV para o formato de entrada de registro e clique em Download:

Mostrar detalhes do download

Para exibir entradas de registro no formato JSON ou CSV em uma página da Web, siga as mesmas etapas para fazer o download, mas selecione Visualizar na nova guia.

Como pesquisar com o visualizador de registros

É possível restringir ainda mais suas pesquisas usando consultas nas interfaces básica e avançada. A interface de consulta avançada contém a maioria dos recursos da interface de consulta básica, mas tem recursos de pesquisa mais sofisticados.

Diferenças entre consultas básicas e avançadas

A sintaxe das interfaces de consulta básica e avançada é diferente. A interface de consulta básica é criada com suposições que são inválidas para a interface de consulta avançada. Por exemplo, todas as pesquisas são indiferentes a maiúsculas.

As próximas seções destacam as principais diferenças na sintaxe dessas duas interfaces.

Palavra-chave "text:"

O visualizador de registros mostra pesquisas de texto na consulta básica prefixando o texto com o rótulo text:. Não use o rótulo text: com consultas avançadas.

A tabela a seguir mostra pesquisas de texto equivalentes:

Consulta básica do visualizador de registros Consulta de registros avançados com o mesmo significado
text:"one two" "one two"
text:three three
text:n=5 "n=5" (são necessárias aspas)

Se você usar acidentalmente text: na consulta avançada, procurará uma correspondência em um campo chamado text, que não existe.

Nomes de campos

A interface de consulta básica tem nomes de campo internos para determinados registros, incluindo o registro de solicitações do App Engine. Esses nomes de campo não existem em consultas avançadas.

A tabela a seguir mostra uma pesquisa de campo equivalente para um registro de solicitações do App Engine:

Consulta básica Consulta avançada
querystring:var=3 protoPayload.resource:"var=3"
status:400..405 protoPayload.status >= 400 AND protoPayload.status <= 405

Se você usar querystring:var=3 no filtro avançado, vai procurar um campo chamado querystring, que não existe. Portanto, o visualizador de registros não encontra entradas de registro correspondentes.

Correspondências de substring

Na interface de consulta básica, todas as pesquisas são correspondências de substring que são indiferentes a maiúsculas. Ou seja, as pesquisas text:abc ou somefieldname:abc correspondem a entradas de registro que contêm abc, xyabcyx e ABc. Em consultas de registro avançadas, use o operador de pesquisa "has" (:) para o mesmo comportamento.

Para uma correspondência exata, use o operador de igualdade (=). A comparação field=abc exige que field contenha exatamente abc, com letra maiúscula ou minúscula. Essa pesquisa não pode ser expressa na interface de consulta básica.

AND e OR

Na interface de consulta básica, duas comparações usando o mesmo nome de campo (ou text:) são implicitamente associadas a OR, enquanto comparações com rótulos diferentes são unidas por AND. Em consultas de registros avançadas, todas as comparações são unidas por AND, a menos que OR seja especificado explicitamente. Também é possível usar parênteses para agrupar comparações. A tabela a seguir mostra pesquisas equivalentes nas duas interfaces de consulta:

Pesquisa de consulta básica Pesquisa de consulta avançada
text:abc querystring:def text:xyz protoPayload.resource:"def" AND ("abc" OR "xyz")

Desempenho da pesquisa

Veja algumas dicas para melhorar o desempenho da pesquisa:

  • Pesquise valores específicos de campos indexados como o nome da entrada de registro, o tipo de recurso e os marcadores. Na interface de consulta básica, você faz isso com seleções de menu. Na interface de consulta avançada, use condições como as seguintes:

    resource.type = "gce_instance"
        logName = "projects/[PROJECT_ID]/logs/cloudaudit.googleapis.com%2Factivity"
        resource.labels.module_id="default"
        resource.labels.instance_id="1234567890"
        
  • Escolha correspondências exatas em vez de pesquisas de substring. Principalmente nos campos de índice, as correspondências parciais são mais lentas. Na interface de consulta básica, todas as pesquisas de texto são correspondências parciais. Na interface de consulta avançada, prefira testes usando o operador de igualdade (=) em vez de usar “has” (:).

  • Reduza o período pesquisado. A interface de consulta básica não permite isso, mas na interface de consulta avançada é possível especificar um intervalo de tempo:

    timestamp >= "2016-11-29T23:00:00Z" AND timestamp <= "2016-11-29T23:30:00Z"
        

Para mais informações sobre o desempenho, consulte Como localizar entradas de registro rapidamente.

Pesquisas salvas

É possível salvar uma pesquisa com filtros básicos ou avançados em uma biblioteca de pesquisas salvas e dar um nome e uma descrição a ela. Os filtros básicos são convertidos em filtros avançados quando salvos na biblioteca de pesquisas salvas. É possível nomear, gerenciar e compartilhar pesquisas salvas na sua biblioteca. Há um limite de 100 pesquisas salvas por usuário, de acordo com o projeto do Google Cloud.

Para criar uma pesquisa salva, siga estas etapas:

  1. Filtre os registros que você quer salvar criando um filtro de registros avançado.

  2. Clique em Salvar pesquisa.

    Botão de pesquisas salvas

  3. Nomeie e descreva o filtro que você criou e clique em Salvar na biblioteca.

    O painel Filtrar visualização exibe os critérios de filtro para a pesquisa salva.

Visualizar pesquisas salvas

Para visualizar suas pesquisas salvas, clique em Mostrar biblioteca.

Biblioteca de pesquisas salvas

Editar pesquisas salvas

Para aplicar o filtro salvo, excluí-lo ou visualizar a notação dele, conclua as seguintes etapas:

  1. Para ver suas pesquisas salvas, clique em Mostrar biblioteca.

  2. Para visualizar ou excluir uma pesquisa salva, clique em Mais .

    Editar pesquisas salvas

    Não é possível alterar os critérios de filtro para uma pesquisa salva depois que ela é criada. Se você quiser alterar os critérios de filtro de uma pesquisa salva, exclua a pesquisa e, em seguida, crie uma nova com os critérios que você quer.

Compartilhar pesquisas salvas

É possível compartilhar suas pesquisas salvas com usuários que têm permissões do Cloud Identity and Access Management no seu projeto.

Para compartilhar uma pesquisa salva, siga estas etapas:

  1. Para ver suas pesquisas salvas, clique em Mostrar biblioteca.

  2. Clique Mais e depois Visualizar.

  3. Clique em Copiar link para filtrar.

    Compartilhar uma pesquisa salva

Solução de problemas

Nesta seção, você vê instruções para solucionar problemas comuns encontrados ao interagir ou pesquisar com o visualizador de registros.

Seleção de projetos do Google Cloud

Para selecionar um projeto do Google Cloud de qualquer lugar no Console do Google Cloud, inclusive no visualizador de registros, use o seletor de projetos na parte superior da página:

Seletor de projetos do Console do GCP

Código do projeto do Google Cloud

Para recuperar o código do projeto do Google Cloud de qualquer lugar no Console do Google Cloud, incluindo o Visualizador de registros, expanda sua lista de projetos na parte superior da página e procure na coluna Código:

Informações do código do projeto do Console do GCP

Não há registros

Caso nenhum registro seja exibido, verifique o seguinte:

  • Você selecionou o projeto certo na parte superior da página? Se não tiver selecionado, use o menu suspenso no topo da página para escolher um projeto. Selecione o que tem os registros que você quer ver.

  • O projeto tem alguma atividade? Mesmo que seja novo, o projeto precisa ter atividades ou registros de auditoria que comprovem a criação dele. Para conseguir mais registros, confira o Guia de início rápido.

  • O intervalo de tempo é muito limitado? Use os menus suspensos abaixo da caixa de consulta de pesquisa para selecionar outros períodos ou definir um intervalo Personalizado. Selecione Ir para este ponto no tempo para consultar os registros em uma data e hora específicas ou use o menu Ir para o momento atual para ver as entradas de registro atuais.

  • O período está incorreto? Se você estiver gravando uma consulta que inclua um carimbo de data/hora, selecione Sem limite no seletor de intervalo de tempo abaixo da caixa de consulta de pesquisa.

Minha pesquisa não está funcionando.

Se você não souber por que sua pesquisa não está funcionando na interface de consulta básica, alterne para a interface de consulta avançada:

  1. Selecione Converter para filtro avançado no menu &blacktriangledown; no final da caixa de consulta de pesquisa.
  2. Analise a consulta avançada para ver se é o que você quer.
  3. Retorne à interface de consulta básica usando o botão Voltar do navegador.

Veja outros motivos pelos quais não é possível ver todas as entradas de registro esperadas:

  • 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 visualizador 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 uma distorção no tempo do aplicativo que envia os registros.

A seguir