Crie e guarde consultas através da linguagem de consulta de registos

Este documento descreve como obter e analisar registos quando usa o Explorador de registos escrevendo consultas no campo do editor de consultas e selecionando a partir de opções de filtro predefinidas. As consultas que cria são escritas na linguagem de consulta de registo.

Também pode guardar as suas consultas na página Explorador de registos ou através do método da API Logging savedQueries.create.

Antes de começar

A função Logs Viewer (roles/logging.viewer) dá acesso à visualização de registos. Por exemplo, quando lhe é concedida esta função, pode escrever e executar consultas. Também pode guardar consultas como consultas privadas e executar consultas privadas e partilhadas. No entanto, esta função não lhe permite guardar nem modificar consultas partilhadas. Se quiser guardar ou modificar consultas partilhadas, certifique-se de que lhe foi concedido o papel de administrador de registos (roles/logging.admin), que lhe dá acesso total ao Cloud Logging.

Efetue um dos seguintes passos:

• Para receber as autorizações de que precisa para escrever e executar consultas, executar e guardar consultas privadas e executar consultas partilhadas, peça ao seu administrador que lhe conceda a função do IAM Logs Viewer (roles/logging.viewer) no seu projeto.

• Para receber as autorizações de que precisa para escrever e executar consultas, executar e guardar consultas privadas, e executar, criar e gerir consultas partilhadas, peça ao seu administrador que lhe conceda a função do IAM Administrador de registo (roles/logging.admin) no seu projeto.

Para mais informações sobre as autorizações de IAM necessárias, consulte o artigo Autorizações para a Trusted Cloud consola.

Crie consultas

Para criar consultas através da Trusted Cloud consola, faça o seguinte:

1. Na Trusted Cloud consola, aceda à página Explorador de registos:

   Aceda ao Explorador de registos

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cuja legenda é Registo.

2. Selecione o Trusted Cloud projeto ou outro Trusted Cloud recurso para o qual quer ver registos.

3. Use o painel Consulta para criar a sua consulta.

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

   • Pesquise texto em todos os campos de registo.
   • Selecione opções nos menus de filtros.
   • Escreva ou modifique consultas através do editor de consultas.
   • Veja e execute consultas guardadas, recentes e sugeridas a partir da menu_book biblioteca de consultas.

Pesquise texto em campos de registo

Para pesquisar texto em todos os campos de registo e encontrar todas as entradas de registo correspondentes, introduza os termos de pesquisa no campo de pesquisa do painel Consulta.

Pode pesquisar palavras e expressões, e os seus termos de pesquisa podem incluir operadores booleanos e expressões regulares:

• Para fazer uma pesquisa sensível a maiúsculas e minúsculas, tem de usar uma expressão regular.

• Para fazer uma pesquisa sem distinção entre maiúsculas e minúsculas ao longo dos limites dos tokens, introduza os termos de pesquisa sem acentos graves nem aspas duplas.

  Por exemplo, para pesquisar entradas de registo que contenham a palavra hello e a palavra world, introduza hello world. Este comando, que é convertido em SEARCH("hello world"), corresponde a entradas de registo que contêm os tokens hello e world, por qualquer ordem. Uma vez que a pesquisa não é sensível a maiúsculas e minúsculas, a pesquisa também corresponde a uma entrada de registo que contém os tokens Hello e World. A pesquisa não corresponde ao token worlds.

• Para realizar uma pesquisa insensível a maiúsculas/minúsculas de uma expressão ao longo dos limites dos tokens, coloque a expressão entre acentos graves.

  Por exemplo, para pesquisar a expressão hello world, introduza `hello world`. Este comando, que é convertido em SEARCH("`hello world`"), corresponde a entradas de registo que contêm o token hello world. A pesquisa não corresponde ao token hello worlds.

• Para fazer uma pesquisa não sensível a maiúsculas e minúsculas de uma substring, coloque o texto entre aspas duplas. Por exemplo, "hello world" corresponde a Hello World e Hello world. A mesma consulta também corresponde a hello worlds, porque a pesquisa não é realizada ao longo dos limites dos tokens.

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

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

Operadores booleanos

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

O campo de pesquisa suporta a utilização dos operadores booleanos AND, OR e NOT. Quando usar operadores booleanos nas suas expressões de pesquisa, tenha em atenção o seguinte:

• Não pode usar parênteses para aninhar regras. Todos os parênteses na expressão de pesquisa são analisados como termos de pesquisa.
• Tem de escrever os operadores booleanos em maiúsculas. As letras minúsculas and, or e not são analisadas como termos de pesquisa e não como operadores.

Se não incluir operadores, todos os termos e expressões de pesquisa são unidos por AND. Pode omitir o operador AND entre termos de pesquisa.

Os operadores AND e OR são operadores de curto-circuito. Pode 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 transforma-se na seguinte expressão da linguagem de consulta de registo:

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

O operador NOT tem a precedência mais elevada, seguido de OR e AND por essa ordem.

O operador NOT realiza uma negação do termo seguinte. Por exemplo, o operador NOT error devolve entradas de registo que não contêm error. Também pode substituir o operador NOT pelo operador - (menos). Por exemplo, as duas consultas seguintes são iguais:

"response" AND "successful" AND NOT "error"

"response successful" -"error"

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

-"response successful"

NOT "response successful"

Crie consultas com menus de filtros

Pode usar os menus de filtro no painel Consulta para adicionar parâmetros de recursos, nome do registo, gravidade do registo e correlação ao campo do editor de consultas. Estas opções correspondem aos campos LogEntry para todos os registos no Logging.

As opções nos menus Recurso e Nome do registo são derivadas das entradas de registo armazenadas pelo Cloud Logging.

• Resource: permite especificar o resource.type e o resource.labels associado. Pode selecionar um único tipo de recurso através deste menu de filtros e zero ou mais etiquetas de recursos para aplicar à sua consulta. Os parâmetros de recursos são unidos pelo operador lógico AND.
• Nome do registo: permite especificar o logName. Pode selecionar vários nomes de registos para aplicar à sua consulta. Quando seleciona vários nomes de registos, é usado o operador lógico OR.
• Gravidade: permite especificar a gravidade. Pode selecionar vários níveis de gravidade em simultâneo para aplicar à sua consulta. Quando seleciona vários níveis de gravidade, é usado o operador lógico OR.
• Correlacionar por: permite agrupar e ver as entradas do registo num formato "principal-secundário". Para mais informações, consulte o artigo Correlacione entradas de registo.

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

1. Expanda o arrow_drop_down Menu em qualquer um dos menus de filtros no painel Consulta.

2. Refine os parâmetros do filtro.

3. Clique em Aplicar. Os parâmetros são apresentados no campo do editor de consultas.

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

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

Para determinados tipos de recursos do Compute Engine, como gce_instance e gce_network, vê o nome do recurso com o ID do recurso como texto secundário. Por exemplo, para o tipo de recurso gce_instance, vê o nome da VM juntamente com o ID da VM. Os nomes dos recursos ajudam a identificar o ID do recurso correto no qual pode criar consultas.

Veja os registos por intervalo de tempo

Existem duas formas de apresentar registos que foram escritos num intervalo de tempo específico:

1. Use o seletor de intervalo de tempo.
2. Inclua uma expressão de indicação de tempo no campo do editor de consultas.

Use o seletor de intervalo de tempo

O intervalo de tempo predefinido é de uma hora, mas pode selecionar entre as opções de tempo predefinidas, especificar uma hora de início e de fim personalizada ou centrar o intervalo de tempo em torno de uma data/hora específica através do seletor de intervalo de tempo. Por exemplo, se quiser ver os dados da semana anterior, selecione Última semana no seletor de intervalo de tempo.

Também pode definir as suas preferências de fuso horário através do seletor de intervalo de tempo.

Inclua uma expressão de indicação de tempo no campo do editor de consultas

Para adicionar uma expressão de indicação de tempo diretamente ao campo do editor de consultas, use a linguagem de consulta de registo.

Se o campo do editor de consultas contiver uma expressão com uma indicação de tempo, o seletor de intervalo de tempo é desativado e a consulta usa a expressão de indicação de tempo como restrição de intervalo de tempo. Se uma consulta não usar uma expressão de data/hora, a consulta usa o seletor de intervalo de tempo como restrição de intervalo de tempo.

Escreva consultas avançadas com a linguagem de consulta de registo

Pode usar a linguagem de consulta de registo para criar consultas mais avançadas no campo do editor de consultas do Explorador de registos:

1. Se não vir o campo do editor de consultas no painel Consulta, ative a opção Mostrar consulta.

2. Introduza as expressões de consulta diretamente no campo do editor de consultas.

   Se adicionou termos de pesquisa no campo de pesquisa ou selecionou parâmetros nos menus de filtro, estes também aparecem no campo do editor de consultas e são avaliados como parte da expressão de consulta.

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

   Os registos que correspondem à sua consulta são apresentados no painel Resultados da consulta. Os painéis Histograma e Campos de registo também se ajustam de acordo com a expressão de consulta.

Para ver exemplos de consultas comuns que pode querer usar, consulte o artigo Consultas de exemplo com o Explorador de registos.

Usar consultas recentes

Quando executa uma consulta, esta é adicionada à menu_book biblioteca de consultas, que contém as últimas 10 000 consultas únicas durante um período de 30 dias.

Para ver as suas consultas recentes, selecione o botão menu_book Biblioteca de consultas na barra de ferramentas principal. Para consultas recentes, 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.

• more_vert Mais opções: Permite-lhe ver a expressão de consulta com as opções para executar a consulta ou guardá-la na sua lista de consultas Guardadas. Também pode selecionar a consulta diretamente para aceder a estas opções.

  Para guardar a consulta, faça o seguinte:

  1. Clique em Guardar. É apresentada a caixa de diálogo Guardar consulta.

  2. Preencha os seguintes campos:

     • Nome (obrigatório): indique um nome para a consulta. Os nomes estão limitados a 64 carateres.
     • Descrição (opcional): indique uma descrição para ajudar a identificar a finalidade da consulta.
     • Inclua campos de resumo (opcional): ative a opção Inclua campos de resumo e introduza os campos de resumo que quer apresentar.
     • Truncar campos de resumo (opcional): ative a opção Truncar campos de resumo e selecione o número de carateres para truncar e se o truncamento ocorre no início ou no fim dos campos.

  3. Clique em Guardar consulta. A consulta está agora disponível na sua lista de consultas guardadas.

Também pode ordenar e filtrar as suas consultas recentes. O filtro corresponde ao texto na expressão de consulta.

Guarde e partilhe consultas

As consultas guardadas permitem-lhe armazenar expressões de consulta para ajudar a explorar os registos de forma mais consistente e eficiente. O Explorador de registos inclui uma biblioteca de consultas, onde pode aceder às suas consultas guardadas. Também pode guardar as suas consultas através do método da API Logging savedQueries.create.

Pode guardar a sua consulta para que seja privada e visível apenas para si ou pode partilhá-la com outros membros do Trusted Cloud projeto. Depois de partilhar uma consulta, esta deixa de ser sua propriedade, e qualquer membro do projeto com as autorizações necessárias pode aceder à consulta.

{
  "parent": "projects/my-project/locations/global"
  "savedQueryId": "compute-query"
  {
    "displayName": "compute-admin-activity-query",
    "description": "Queries for Compute Engine Admin Activity logs.",

    "loggingQuery":
      {
        "filter": resource.type="gce_instance" AND log_id("cloudaudit.googleapis.com/activity"),
      },
    "visibility": "PRIVATE"
  }
}

Ver consultas guardadas

Pode ver consultas privadas e consultas partilhadas com outros membros no Trusted Cloud projeto clicando no botão menu_book Biblioteca de consultas:

{
  "parent": "name": projects/PROJECT_ID/locations/-
  "visibility": "SHARED"
  "filter": "explorer"
}

Use consultas sugeridas

O registo gera consultas sugeridas com base no contexto do seu Trusted Cloud projeto, como os Trusted Cloud produtos que está a usar. As consultas sugeridas podem ajudar a identificar problemas e fornecer estatísticas sobre o estado geral dos seus sistemas. Por exemplo, ao detetar que está a usar o Google Kubernetes Engine, o Logging pode sugerir uma consulta que encontre todos os registos de erros dos seus contentores.

Para ver e executar consultas sugeridas, clique no botão menu_book Biblioteca de consultas e clique em Sugestões. No separador Sugestões, 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.

• more_vert Mais opções: Permite-lhe ver os detalhes da expressão de consulta com as opções para executar a consulta ou guardá-la. Também pode selecionar a consulta diretamente para aceder a estas opções.

  Para rever os detalhes de uma consulta sugerida, faça uma das seguintes ações:

  • Selecione a linha da consulta.

  • Clique em more_vert Mais e selecione Ver. É apresentada a caixa de diálogo Detalhes da consulta.

  Na caixa de diálogo Detalhes da consulta, vê a consulta e as opções para Executar, Transmitir ou Guardar como:

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

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

    A consulta editada é apresentada na lista Guardadas, onde pode optar por executar a consulta mais tarde.

  • Para executar a consulta agora, clique em Executar. A consulta é executada e aparece no campo do editor de consultas.

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

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

Tenha em atenção os seguintes comportamentos esperados:

• Os carregamentos de páginas sucessivos podem não mostrar as mesmas consultas pela mesma ordem.
• Pode ver zero consultas sugeridas.
• Por vezes, a execução de uma consulta sugerida devolve zero registos.

Selecione consultas da biblioteca

O registo fornece uma biblioteca de consultas baseadas em exemplos de utilização comuns e Trusted Cloud produtos. Estas consultas podem ajudar a encontrar registos de forma eficiente durante sessões de resolução de problemas urgentes e explorar os seus registos para compreender melhor os dados de registo disponíveis.

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

1. Na Trusted Cloud consola, aceda à página Explorador de registos:

   Aceda ao Explorador de registos

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cuja legenda é Registo.

2. Selecione o Trusted Cloud projeto ou outro Trusted Cloud recurso para o qual quer ver registos.

3. Clique no botão menu_book Biblioteca de consultas. Vê categorias de consultas disponíveis e subconjuntos de consultas com base nos Trusted Cloud produtos. Para restringir a seleção de consultas que vê, clique em qualquer um dos produtos.

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

4. Para rever uma expressão de consulta, faça uma das seguintes ações:

   a. Clique na linha da consulta.

   b. Clique em more_vert Mais e selecione Ver.

5. Na caixa de diálogo Detalhes da consulta, vê a consulta e as opções para Executar, Transmitir ou Guardar como:

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

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

     A consulta editada é apresentada na lista Guardadas, onde pode optar por executar a consulta mais tarde.

   • Para executar a consulta agora, clique em Executar. A consulta é executada e aparece no campo do editor de consultas.

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

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

O que se segue?

• Consultas de exemplo