Guarde e partilhe consultas SQL

Este documento descreve como guardar e partilhar consultas que cria no Log Analytics.

Este documento pressupõe que está familiarizado com o Log Analytics e sabe como usar a página Log Analytics para consultar os dados de registo. Se não conhecer estes tópicos, consulte o artigo Consultar e analisar registos.

Para saber como criar gráficos com os resultados da consulta e como guardar esses gráficos num painel de controlo personalizado, consulte o artigo Crie gráficos com os resultados da consulta SQL.

Como as consultas guardadas diferem das vistas de estatísticas

Uma consulta guardada é uma consulta que executa através da página Log Analytics e, em seguida, guarda como uma consulta. A ação de guardar permite-lhe executar novamente esta consulta quando lhe for mais conveniente. Quando guarda a consulta, tem a opção de a tornar privada para si ou pode torná-la visível para outras pessoas que tenham as autorizações necessárias para usar o Log Analytics. Não pode escrever uma consulta SQL em que a cláusula FROM especifique uma consulta guardada.

Uma vista de propriedade do Analytics contém uma consulta que pode voltar a executar quando lhe for mais conveniente. Cria uma visualização de análise escrevendo uma consulta SQL numa visualização de registos e, em seguida, guardando o resultado como uma visualização. Ao contrário das consultas guardadas, não pode tornar uma vista de estatísticas privada para si. Pode consultar uma visualização do Analytics. Esta capacidade permite-lhe transformar os dados de registo do formato LogEntry num formato mais adequado para si. Em seguida, em vez de escrever as consultas com base numa vista de registo, consulta a vista de estatísticas.

Pode guardar consultas que consultam uma vista de registo ou uma vista de estatísticas.

Antes de começar

Esta secção descreve os passos que tem de concluir antes de poder usar a análise de registos.

Configure contentores de registos

Certifique-se de que os contentores de registos foram atualizados para usar o Log Analytics:

  1. Na Google Cloud consola, aceda à página Armazenamento de registos:

    Aceda a Armazenamento de registos

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

  2. Para cada contentor de registos que tenha uma vista de registos que quer consultar, certifique-se de que a coluna Log Analytics disponível apresenta Abrir. Se for apresentado o botão Atualizar, clique nele e conclua a caixa de diálogo.

Configure funções e autorizações do IAM

Esta secção descreve as funções ou as autorizações da IAM necessárias para usar o Log Analytics:

  • Para receber as autorizações de que precisa para usar o Log Analytics e consultar visualizações de registos, peça ao seu administrador que lhe conceda as seguintes funções de IAM no seu projeto:

    Pode restringir um principal a uma vista de registos específica adicionando uma condição de IAM à concessão da função Logs View Accessor feita ao nível do projeto ou adicionando uma associação de IAM ao ficheiro de política da vista de registos. Para mais informações, consulte o artigo Controle o acesso a uma vista de registo.

    Estas são as mesmas autorizações de que precisa para ver entradas de registo na página do Explorador de registos. Para ver informações sobre funções adicionais necessárias para consultar visualizações em contentores definidos pelo utilizador ou para consultar a visualização _AllLogs do contentor de registos _Default, consulte Funções do Cloud Logging.

  • Para receber as autorizações de que precisa para consultar visualizações de propriedade do Analytics, peça ao seu administrador para lhe conceder a função de IAM Utilizador do Observability Analytics (roles/observability.analyticsUser) no seu projeto.

Guarde uma consulta

Todas as consultas que executar são guardadas automaticamente durante 30 dias e estão acessíveis selecionando o separador Recente na página Log Analytics. Pode pesquisar, ver, executar e partilhar as consultas apresentadas no separador Recentes.

Se quiser manter uma consulta disponível para utilização futura, anote-a com informações úteis para si ou permita que os colegas vejam e executem a sua consulta. Em seguida, guarde a consulta. Pode pesquisar e ordenar as suas consultas guardadas pelo nome, pela descrição e pela etiqueta de visibilidade. Também pode editar e eliminar estas consultas. As consultas que guarda são mantidas até as eliminar.

Pode guardar 10 000 consultas por Google Cloud projeto.

Consola

Para guardar uma consulta, faça o seguinte:

  1. Na Google Cloud consola, aceda à página Log Analytics:

    Aceda ao Log Analytics

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

  2. Preencha o painel Consulta com uma consulta.

    Pode preencher o painel Consulta introduzindo uma nova consulta, selecionando uma consulta no separador Recente ou selecionando uma consulta no separador Guardado.

    A sua consulta pode incluir qualquer visualização válida, várias visualizações e visualizações do Analytics.

    Quando a consulta no painel Consulta é válida, a opção Guardar é ativada.

  3. Clique em Guardar, selecione Guardar consulta e preencha os campos Nome e Descrição. Os valores que definir para estes campos são apresentados no separador Guardado.

  4. Opcional: para permitir que todas as pessoas com acesso à página Log Analytics para a vista do projeto executem a consulta guardada, ative o botão Partilhar com o projeto. Google Cloud

    Por predefinição, este botão está desativado e a visibilidade está restrita a si.

  5. Clique em Guardar consulta.

  6. Opcional: para ver, ordenar e executar consultas guardadas visíveis para si, selecione o separador Guardado.

    Pode ordenar e filtrar as consultas guardadas pelo respetivo nome, descrição e etiqueta de visibilidade. Também pode filtrar pelo conteúdo da consulta.

Pode editar e eliminar consultas que criou através das opções no separador Guardado:

  • Para editar uma consulta, clique em Mais opções e selecione Editar. Pode modificar os valores dos campos Nome e Descrição. No entanto, não é possível modificar a própria consulta.

  • Para eliminar uma consulta guardada, clique em Mais opções e selecione Eliminar.

API

Para guardar uma consulta através da API Logging, use o método savedQueries.create. Para mais informações sobre este método, os respetivos parâmetros e os dados de resposta, consulte a página de referência de savedQueries.create.

Pode executar o método savedQueries.create através do widget do Explorador de APIs na página de referência do método. Para as consultas do Log Analytics, tem de especificar o campo opsAnalyticsQuery. O exemplo seguinte ilustra um corpo de pedido de exemplo, que contém uma instância de SavedQuery:

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
      "visibility": "PRIVATE"
   }
}

Partilhe uma consulta

Pode partilhar uma consulta guardada com todas as pessoas que têm acesso ao seu Google Cloud projeto. No entanto, as funções da IAM do principal determinam se a consulta pode ser executada e os dados que a consulta devolve.

Consola

Quando resolve um problema ou vê resultados anómalos, pode querer partilhar uma consulta e os respetivos resultados com um colega de equipa. Quando estiver a ver os resultados da consulta na página Log Analytics, pode copiar um URL que, quando aberto, apresenta a consulta que executou e os respetivos resultados.

Para partilhar uma consulta e os resultados com um colega, faça o seguinte:

  1. Na Google Cloud consola, aceda à página Log Analytics:

    Aceda ao Log Analytics

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

  2. Preencha o painel Consulta com uma consulta e, de seguida, clique em Executar consulta.

    Pode preencher o painel Consulta introduzindo uma nova consulta, selecionando uma consulta no separador Recente ou selecionando uma consulta no separador Guardado.

  3. Clique em Partilhar link.

  4. Envie o link ao seu colega de equipa.

    Quando o seu colega abre o link, é aberta a página Log Analytics. Esta página apresenta a consulta que executou e os resultados da consulta.

    Para abrir o URL com êxito, a função de IAM do seu colega no Google Cloud projeto tem de incluir as autorizações necessárias para ver a página Log Analytics.

API

Pode usar a API Logging para criar uma consulta partilhada usando o método savedQueries.Create e especificando um valor de SHARED no campo visibility. Para mais informações, consulte a página de referência para savedQueries.create.

Veja e execute consultas recentes ou guardadas

Para ver ou executar novamente uma consulta, selecione o separador Recente na página Log Analytics e encontre a consulta:

  • Para executar a consulta, clique em Executar.
  • Para ver a consulta, use as opções no menu Mais opções.

Para ver, editar ou executar uma consulta guardada, selecione o separador Guardado na página Log Analytics e encontre a consulta:

  • Para executar a consulta, clique em Executar.
  • Para editar, ver ou eliminar a consulta, use as opções no menu Mais opções.

O que se segue?