Criar consultas no Buscador de registros

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Neste documento, descrevemos como criar consultas no registro de registros do console do Google Cloud para recuperar e analisar registros.

Para mais informações sobre como fazer consultas no Explorador de registros, acesse este link.

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. Veja detalhes sobre as permissões necessárias do IAM em Controle de acesso com o IAM: permissões do Console do Google Cloud.

Começar

Para começar a usar o Console do Google Cloud 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 sobre o qual você quer ver os registros.

Criar consultas

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

O painel de consulta 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 de filtro.
  • Crie 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 com mais detalhes.

Pesquisar texto em campos de registro

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

Campo de pesquisa do Explorador de registros no painel de consultas.

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 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 do campo de pesquisa são convertidas em expressões booleanas que especificam um subconjunto de todas as entradas de registros no recurso selecionado do Google Cloud.

O campo de pesquisa é compatível com o uso dos operadores booleanos AND, OR e NOT. Ao usar operadores booleanos nas suas 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.
  • Você precisa usar letras maiúsculas em operadores booleanos. and, or e not em letras minúsculas são analisados como termos de pesquisa, não como operadores.

Se você não incluir nenhum operador, 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 regras AND e OR na mesma expressão. Por exemplo, quando os dois operadores são misturados, 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 iguais:

response AND successful AND NOT error
response successful -error

Essa lógica também funcionará 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 os menus de filtro

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

As opções nos menus Recurso e Nome do registro exibem apenas registros armazenados atualmente no Cloud Logging.

Menus de filtro do editor de consultas

  • Recurso: permite especificar o resource.type e o resource.labels associado. Selecione um único tipo de recurso usando esse menu de filtro e zero ou mais rótulos de recursos para aplicar à consulta. Os parâmetros do recurso 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 adicionar à 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 do filtro.

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

    Para ver os termos de pesquisa na expressão de consulta, ative 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 ID de recurso correto, para você poder criar consultas.

Criar consultas com restrições de tempo

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

  1. Consulte o seletor de períodos.
  2. Consulte usando uma expressão de carimbo de data/hora no campo "query-editor".

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

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" contiver uma expressão com um carimbo de data/hora, o seletor de intervalo de tempo será desativado e a consulta usará a expressão de carimbo de data/hora como restrição. Se uma consulta não usar uma expressão de carimbo de data/hora, ela usará o seletor de período como restrição.

Usar o seletor de intervalo de tempo

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

Seletor de intervalo de tempo no painel de consulta.

Para usar o seletor de intervalo de tempo, faça o seguinte:

  1. Clique no seletor de intervalo de tempo no painel Consulta.

  2. Selecione o período apropriado do intervalo de registros que você quer ver.

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

    O painel Resultados da consulta é ajustado de acordo com o período selecionado.

O período padrão é de uma hora. Use a opção Pular para 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 a formatação de data e hora, no seletor de períodos:

  1. Selecione Inserir intervalo personalizado.
  2. Selecione Alterar formato de data e hora.
  3. Atualize suas preferências no menu Idioma e região.
  4. Clique em Save.

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

Criar 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 de consulta do editor do Explorador de registros:

  1. Se você não vir o campo "query-editor" no painel Consulta, ative Mostrar consulta.

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

    Se você tiver adicionado termos de pesquisa no campo de pesquisa ou selecionado parâmetros nos menus de filtro, eles também aparecerão no campo de consulta do 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 uma 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 as consultas recentes, selecione a guia Recentes no painel Consulta. Na guia Recentes, você tem as seguintes opções:

  • Stream: para executar a consulta e fazer streaming dos 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 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 Campos de resumo do truncamento e selecione o número de caracteres para truncar e se o truncamento ocorre 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 de consulta.

Salvar consultas

O painel Consulta apresenta uma guia Salvas, em que você pode acessar as consultas salvas. As consultas salvas permitem armazenar expressões de consulta para ajudar a explorar os registros com mais consistência e eficiência.

Para salvar uma expressão de consulta que você tenha criado no campo "query-editor", faça o seguinte:

  1. Clique em Salvar no painel Consulta. A caixa de diálogo Salvar consulta será 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 Campos de resumo do truncamento e selecione o número de caracteres para truncar e se o truncamento ocorre no início ou no fim dos campos.
    1. Clique em Salvar consulta. Suas consultas salvas aparecem em uma lista na guia Salvas.

Para executar uma consulta salva, clique em Executar. Para executar a consulta e fazer streaming dos resultados, clique em Stream.

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

Compartilhar consultas

Com as consultas compartilhadas, os usuários de um projeto do Cloud podem compartilhar as consultas salvas entre si. Você pode ver as consultas compartilhadas na guia Salvas.

Para ver os papéis e as permissões necessárias para visualizar e editar consultas compartilhadas, consulte Permissões do Console do Google Cloud. Os usuários que têm o papel do IAM roles/logging.admin ou roles/editor podem editar outras consultas compartilhadas.

Criar uma consulta compartilhada

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

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

  1. Digite 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.

Sua consulta agora é 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 Compartilhar com o projeto e clique em Atualizar consulta.

Sua consulta agora é 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 e como as consultas são compartilhadas:

  • Compartilhados por mim: consultas que você salvou e compartilhou com outros usuários do projeto do Cloud.
  • Compartilhada: consultas que outros usuários do projeto do Cloud compartilharam.
  • 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 Mine. Agora é possível ver 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 encontre todos os registros de erros dos seus contêineres.

Para visualizar e executar consultas sugeridas, selecione a guia suggested no painel Query. A guia Sugeridos mostra uma lista de consultas, cada uma com descrições e as seguintes opções:

  • Stream: para executar a consulta e fazer streaming dos 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 para executar a consulta ou salvá-la. Também é possível selecionar a consulta diretamente para ver essas opções.

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

    • Selecione a linha da consulta.

    • Clique em Mais e selecione Ver. A caixa de diálogo Detalhes da consulta será aberta.

    Na caixa de diálogo Detalhes da consulta, você vai ver a consulta e as opções Executar, Stream ou Salvar como:

    • 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 lista Salvas, onde você pode optar por executá-la mais tarde.

    • Para executar a consulta agora, clique em Executar. A consulta é 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 de página sucessivos podem não exibir as mesmas consultas na mesma ordem.
  • Talvez você não veja consultas sugeridas.
  • Às vezes, a execução de uma consulta sugerida não retorna 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 urgentes e a explorar os registros para entender melhor quais dados de geração de registros estão disponíveis.

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

  1. Selecione a guia Biblioteca no painel Consulta.

  2. Na coluna Todas as consultas, você vê 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 procurar 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ê vai ver a consulta e as opções para Executar, Transmitir ou Salvar como:

    • 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 lista Salvas, onde você pode optar por executá-la mais tarde.

    • Para executar a consulta agora, clique em Executar. A consulta é 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.