Criar consultas no Buscador de registros

Neste documento, descrevemos como criar consultas no Explorador de registros do Console do Google Cloud para recuperar e analisar registros.

Para mais informações sobre como fazer consultas no Explorador de registros, consulte Como usar o Explorador de registros.

Antes de começar

Para ver os registros que você está enviando de uma conta da Amazon Web Services (AWS) para o Logging, selecione o projeto de conector da AWS no seletor de recursos do Console do Google Cloud e use o Explorador de registros. O projeto de conector da AWS armazena o Amazon Resource Name (ARN) da sua conta da AWS e vincula sua conta da AWS aos serviços do Google Cloud. Para mais informações, consulte Como visualizar métricas para contas da AWS.

Verifique se você tem as permissões ou o papel corretos do Identity and Access Management para criar consultas usando o Explorador de registros. Para ver detalhes sobre as permissões do IAM necessárias, consulte Controle de acesso com permissões do IAM: console.

Introdução

Para começar a usar o console para criar consultas, navegue até o Explorador de registros:

Acesse o Explorador de registros

Selecione o projeto do Cloud apropriado ou outro recurso do Google Cloud de que você quer ver os registros.

Criar consultas

Ao criar consultas no Explorador de registros, você usa principalmente o painel Consulta:

Painel de consultas do Explorador de registros

O painel Consulta oferece várias maneiras de criar e executar expressões de consulta:

  • Pesquise texto em todos os campos de registro.
  • Selecione as opções nos menus dos filtros.
  • Grave consultas avançadas usando a linguagem de consulta do Logging.
  • Veja, edite ou execute as consultas nas guias Recentes, Salvas, Sugeridas e Biblioteca.

As seções a seguir descrevem esses recursos em mais detalhes.

Pesquisar texto nos campos do registro

Para pesquisar texto em todos os campos de registro e encontrar todas as entradas de registro correspondentes, digite os termos da pesquisa no campo de pesquisa:

O campo de pesquisa do Explorador de registros no painel de consulta.

Para encontrar entradas de registro que contenham uma frase, coloque os termos de pesquisa entre aspas. Também é possível usar operadores booleanos nas expressões de pesquisa. Para ver os termos de pesquisa na expressão de consulta, ative a opção Mostrar consulta.

Depois de inserir os termos de pesquisa, clique em Executar consulta ou pressione a tecla Enter. Os resultados da consulta são exibidos no painel Resultados da consulta.

Operadores booleanos

As entradas de campo de pesquisa são convertidas em expressões booleanas que especificam um subconjunto de todas as entradas de registro no recurso selecionado do Google Cloud.

O campo de pesquisa aceita o uso dos operadores booleanos AND, OR e NOT. Ao usar operadores booleanos nas expressões de pesquisa, observe o seguinte:

  • Não é possível usar parênteses para aninhar regras. Os parênteses na expressão de pesquisa são analisados como termos de pesquisa.
  • É necessário usar letras maiúsculas nos operadores booleanos. As letras minúsculas and, or e not são analisadas como termos de pesquisa, não como operadores.

Se você não incluir operadores, todos os termos e frases de pesquisa serão unidos por AND. É possível omitir o operador AND entre os termos de pesquisa.

Os operadores AND e OR são operadores de curto-circuito. É possível combinar as regras AND e OR na mesma expressão. Por exemplo, quando os dois operadores são combinados, a expressão a AND b OR c AND d se transforma na seguinte expressão de linguagem de consulta do Logging:

"a"
"b" OR "c"
"d"

O operador NOT tem a precedência mais alta, seguido por OR e AND, nessa ordem.

O operador NOT executa uma negação do termo subsequente. Por exemplo, NOT error retorna entradas de registro que não contêm error. Você também pode substituir o operador NOT pelo operador - (menos). Por exemplo, as duas consultas a seguir são as mesmas:

response AND successful AND NOT error
response successful -error

Essa lógica também funciona com uma frase, se o operador - (menos) estiver fora das aspas. Por exemplo, as duas consultas a seguir são iguais:

-"response successful"
NOT "response successful"

Usar menus de filtro

Use os menus de filtro no painel Consulta para adicionar parâmetros de recursos, nomes e gravidade de registros ao campo "query-editor". Essas opções correspondem aos campos LogEntry de todos os registros no Logging.

Filtrar menus do editor de consultas

  • Recurso: permite especificar o resource.type e o resource.labels associado. É possível selecionar um único tipo de recurso usando esse menu de filtros e zero ou mais rótulos de recursos a serem aplicados à consulta. Os parâmetros de recursos são mesclados pelo operador lógico AND.
  • Nome do registro: permite que você especifique logName. Selecione vários nomes de registro para aplicar à consulta. Ao selecionar vários nomes de registros, o operador lógico OR é usado.
  • Gravidade: permite que você especifique a gravidade. É possível selecionar vários níveis de gravidade ao mesmo tempo para aplicar à sua consulta. Ao selecionar vários níveis de gravidade, o operador lógico OR é usado.

Para usar qualquer um dos menus de filtro, faça o seguinte:

  1. Expanda qualquer um dos menus de filtro no painel Consulta.

  2. Refine os parâmetros de filtro.

  3. Clique em Aplicar. Você verá os parâmetros no campo "query-editor".

    Para ver os termos de pesquisa na expressão de consulta, ative a opção Mostrar consulta.

  4. Depois de analisar a consulta, clique em Executar consulta. Os resultados da consulta são exibidos no painel Resultados da consulta.

Para determinados tipos de recursos do Compute Engine, como gce_instance e gce_network, você vê o nome do recurso com o ID do recurso como subtexto. Por exemplo, para o tipo de recurso gce_instance, você vê o nome da VM ao lado do ID da VM. Os nomes dos recursos ajudam a identificar o código correto, em que as consultas podem ser criadas.

Escrever consultas com restrições de tempo

Há duas maneiras de consultar registros com base no tempo:

  1. Consulte o seletor de intervalo de tempo.
  2. Consulta usando uma expressão de carimbo de data/hora no campo query-editor.

Para consultar rapidamente em segundos, minutos, horas ou dias, use os valores predefinidos ou insira um intervalo de tempo personalizado usando o seletor de período.

Para adicionar uma expressão de carimbo de data/hora diretamente ao campo "query-editor", use a linguagem de consulta do Logging.

Se o campo "query-editor" tiver uma expressão com um carimbo de data/hora, o seletor de período será desativado, e a consulta usará a expressão de carimbo de data/hora como a restrição de intervalo de tempo. Se uma consulta não usar uma expressão de carimbo de data/hora, ela usará o seletor de intervalo de tempo como restrição.

Usar o seletor de período

O seletor de período permite restringir os resultados da consulta por período:

Seletor de período no painel de consultas.

Para usar o seletor de período, faça o seguinte:

  1. Clique no seletor de período no painel Consulta.

  2. Selecione o período apropriado para ver os registros.

  3. Clique em Aplicar. Você verá os parâmetros no campo "query-editor".

    O painel Resultados da consulta é ajustado de acordo com o período que você selecionou.

O período padrão é de uma hora. Use a opção Ir para este ponto no tempo para restringir e centralizar o período em torno de um carimbo de data/hora específico.

É possível definir suas preferências regionais, incluindo formatação de data e hora, no seletor de período:

  1. Selecione Inserir intervalo personalizado.
  2. Selecione Alterar data e formato de hora.
  3. Atualize suas preferências no menu Language & region.
  4. Clique em Save.

    Depois de atualizar o navegador, o formato de data e hora de sua preferência aparecerá no Explorador de registros.

Escrever consultas avançadas usando a linguagem de consulta do Logging

É possível usar a linguagem de consulta do Logging para criar consultas mais avançadas no campo "query-editor" do Explorador de registros:

  1. Se você não vir o campo "query-editor" no painel Query, ative Show query.

  2. Insira suas expressões de consulta diretamente no campo "query-editor".

    Se você tiver adicionado termos ao campo de pesquisa ou selecionado parâmetros nos menus do filtro, eles também aparecerão no campo "query-editor" e serão avaliados como parte da expressão de consulta.

  3. Depois de revisar a consulta, clique em Executar consulta.

    Os registros que correspondem à consulta estão listados no painel Resultados da consulta. Os painéis Histograma e Campos de registro também se ajustam de acordo com a expressão de consulta.

Para exemplos de consultas comuns que podem ser usadas, veja Amostra de consultas usando o Explorador de registros.

Usar consultas recentes

Quando você executa qualquer consulta, ela é adicionada à sua lista de consultas Recentes, que contém as últimas 10.000 consultas únicas em um período de 30 dias.

Para visualizar suas consultas recentes, selecione a guia Recentes no painel Consulta. Na guia Recente, você tem as seguintes opções:

  • Stream: para executar a consulta e transmitir os resultados, escolha esta opção.
  • Executar: para executar a consulta, escolha esta opção.
  • Mais opções : permite ver a expressão de consulta com as opções para executar a consulta ou salvá-la na sua lista de consultas salvas. Também é possível selecionar a consulta diretamente para ver essas opções.

    Para salvar a consulta, faça o seguinte:

    1. Clique em Salvar como. A caixa de diálogo Salvar consulta é aberta.
    2. Preencha os seguintes campos:

      • Nome (obrigatório): forneça um nome para sua consulta. Os nomes são limitados a 64 caracteres.
      • Descrição (opcional): forneça uma descrição para ajudar a identificar a finalidade da consulta.
      • Incluir campos de resumo (opcional): ative Incluir campos de resumo e insira os campos de resumo que você quer exibir.
      • Truncar campos de resumo (opcional): ative os campos de resumo do truncamento e selecione o número de caracteres que serão truncados e se o truncamento ocorrerá no início ou no fim dos campos.
    3. Clique em Salvar consulta. A consulta agora está disponível na sua lista de consultas salvas.

Também é possível classificar e filtrar as consultas recentes. O filtro corresponde ao texto na expressão da consulta.

Salvar consultas

O painel Consulta apresenta uma guia Salvas, em que é possível acessar as consultas salvas. Com as consultas salvas, você pode armazenar expressões de consulta para explorar seus registros de maneira mais consistente e eficiente.

Para salvar uma expressão de consulta criada no campo "query-editor", faça o seguinte:

  1. Clique em Salvar no painel Consulta. A caixa de diálogo Salvar consulta é aberta, com a expressão de consulta no campo "query-editor".

  2. Preencha os seguintes campos:

    • Nome (obrigatório): forneça um nome para sua consulta. Os nomes são limitados a 64 caracteres.
    • Descrição (opcional): forneça uma descrição para ajudar a identificar a finalidade da consulta.
    • Incluir campos de resumo (opcional): ative Incluir campos de resumo e insira os campos de resumo que você quer exibir.
    • Truncar campos de resumo (opcional): ative os campos de resumo do truncamento e selecione o número de caracteres que serão truncados e se o truncamento ocorrerá no início ou no fim dos campos.
    1. Clique em Salvar consulta. As consultas salvas aparecem em uma lista na guia Salvas.

Para executar uma consulta salva, clique em Executar. Para executar a consulta e transmitir os resultados, clique em Stream.

Também é possível classificar e filtrar as consultas salvas. O filtro corresponde ao texto na expressão de consulta.

Compartilhar consultas

As consultas compartilhadas permitem que os usuários de um projeto do Cloud compartilhem consultas salvas entre si. Você pode ver as consultas compartilhadas na guia Salvos.

Para ver os papéis e as permissões necessários para visualizar e editar consultas compartilhadas, consulte permissões do console. Os usuários com o papel do IAM roles/logging.admin ou roles/editor podem editar outras consultas compartilhadas.

Criar uma consulta compartilhada

É possível compartilhar consultas que você já salvou ou compartilhar uma nova consulta.

Para criar e compartilhar uma consulta, faça o seguinte:

  1. Insira uma consulta no campo "query-editor".

  2. Clique em Save.

  3. Preencha os campos na caixa de diálogo Salvar consulta.

  4. Ative Compartilhar com o projeto.

  5. Clique em Salvar consulta.

Agora sua consulta será compartilhada com outros usuários do projeto do Cloud.

Para compartilhar uma consulta já salva, faça o seguinte:

  1. Selecione a guia Salvos.

  2. Selecione Mais opções > Editar ou selecione a consulta diretamente.

  3. Na caixa de diálogo Editar consulta, ative a opção Compartilhar com o projeto e clique em Atualizar consulta.

Agora sua consulta será compartilhada com outros usuários do projeto do Cloud.

Ver consultas compartilhadas

Para visualizar rapidamente todas as consultas compartilhadas, classifique a coluna Visibilidade para mostrar as consultas compartilhadas primeiro:

  1. Selecione a guia Salvos.

  2. Clique em Todos.

  3. Classifique a coluna Visibilidade.

A coluna Visibilidade indica se as consultas foram compartilhadas e como isso é feito:

  • Compartilhados por mim: consultas que você salvou e compartilhou com outros usuários do projeto do Cloud.
  • Compartilhados: consultas compartilhadas por outros usuários do projeto do Cloud.
  • Particular: consultas que você salvou e não compartilhou com outros usuários do projeto do Cloud.

Ver somente suas consultas

Para ver as consultas salvas que você criou ou compartilhou, clique em Minhas. Será exibida uma lista de consultas que você criou e salvou. Na coluna Visibilidade, é possível ver suas consultas privadas não compartilhadas. As consultas que você compartilhou são indicadas por Compartilhadas por mim.

Usar consultas sugeridas

O Logging gera consultas sugeridas com base no contexto do seu projeto do Cloud, como os produtos do Google Cloud que você está usando. As consultas sugeridas podem ajudar você a identificar problemas e fornecer insights sobre a integridade geral dos sistemas. Por exemplo, ao detectar que você está usando o Google Kubernetes Engine, o Logging pode sugerir uma consulta que encontra todos os registros de erro dos seus contêineres.

Para visualizar e executar consultas sugeridas, selecione a guia Suggested no painel Consulta. A guia Sugestão mostra uma lista de consultas, cada uma com descrições e as seguintes opções:

  • Stream: para executar a consulta e transmitir os resultados, escolha esta opção.
  • Executar: para executar a consulta, escolha esta opção.
  • Mais opções: permite ver os detalhes da expressão de consulta com as opções de executar a consulta ou salvá-la. Também é possível selecionar a consulta diretamente para ver essas opções.

    Para analisar os detalhes de uma consulta sugerida, siga um destes procedimentos:

    • Selecione a linha da consulta.

    • Clique em More e selecione View. A caixa de diálogo Detalhes da consulta é aberta.

    Na caixa de diálogo Detalhes da consulta, você verá a consulta e as opções Run, Stream ou Save As:

    • Para salvar a consulta, faça o seguinte:

      1. Clique em Salvar como.
      2. Preencha os campos na caixa de diálogo Salvar consulta.

      A consulta editada é exibida na sua lista Salvas, onde é possível escolher executar a consulta posteriormente.

    • Para executar a consulta agora, clique em Executar. A consulta será executada e exibida no campo query-editor.

    • Para executar a consulta agora e transmitir os resultados, clique em Stream.

    • Para fechar a caixa de diálogo e retornar à lista de consultas sugeridas, clique em Fechar.

Observe os seguintes comportamentos esperados:

  • Carregamentos sucessivos da página podem não mostrar as mesmas consultas na mesma ordem.
  • Talvez você não veja nenhuma sugestão de consulta.
  • Às vezes, executar uma consulta sugerida não gera registros.

Selecionar consultas da biblioteca

O Logging fornece uma biblioteca de consultas com base em casos de uso comuns e produtos do Google Cloud. Essas consultas podem ajudar você a encontrar registros de maneira eficiente durante sessões de solução de problemas críticas e explorar seus registros para entender melhor quais dados de registro estão disponíveis.

Para ver e executar as consultas da biblioteca, faça o seguinte:

  1. Selecione a guia Biblioteca no painel Consulta.

  2. Na coluna Todas as consultas, há categorias amplas de consultas disponíveis e subconjuntos de consultas com base nos produtos do Google Cloud. Para restringir a seleção de consultas exibidas, clique em qualquer um dos produtos.

    Também é possível usar o campo de pesquisa para pesquisar as consultas disponíveis por categoria, descrição ou conteúdo da expressão de consulta.

  3. Para revisar uma expressão de consulta, siga um destes procedimentos:

    a. Clique na linha da consulta.

    b. Clique em Mais e selecione Visualizar.

  4. Na caixa de diálogo Detalhes da consulta, você verá a consulta e as opções Run, Stream ou Save As:

    • Para salvar a consulta, faça o seguinte:

      1. Clique em Salvar como.
      2. Preencha os campos na caixa de diálogo Salvar consulta.

      A consulta editada é exibida na sua lista Salvas, onde é possível escolher executar a consulta posteriormente.

    • Para executar a consulta agora, clique em Executar. A consulta será executada e exibida no campo query-editor.

    • Para executar a consulta agora e transmitir os resultados, clique em Stream.

    • Para fechar a caixa de diálogo e retornar à lista de consultas sugeridas, clique em Fechar.