Salvar e compartilhar consultas SQL

Neste documento, descrevemos como salvar e compartilhar consultas criadas no Log Analytics.

Este documento pressupõe que você já conhece a Análise de registros e sabe como usar a página Análise de registros para consultar seus dados de registro. Se você não estiver familiarizado com esses tópicos, consulte Consultar e analisar registros.

Para saber como criar gráficos com os resultados da consulta e como salvar esses gráficos em um painel personalizado, consulte Criar consulta SQL SQL.

Diferenças entre consultas salvas e visualizações de análise

Uma consulta salva é uma consulta que você executa usando a página Análise de registros e salva como uma consulta. A ação de salvar permite executar essa consulta novamente quando quiser. Ao salvar a consulta, você pode deixá-la particular ou visível para outras pessoas que têm as permissões necessárias para usar a Análise de registros. Não é possível escrever uma consulta SQL em que a cláusula FROM especifica uma consulta salva.

Uma visualização do Google Analytics contém uma consulta que você pode executar novamente quando quiser. Para criar uma visualização de análise, escreva uma consulta SQL em uma visualização de registros e salve o resultado como uma visualização. Ao contrário das consultas salvas, não é possível tornar uma visualização do Google Analytics particular. É possível consultar uma visualização de análise. Com esse recurso, você pode transformar os dados de registro do formato LogEntry em outro mais adequado para você. Em vez de escrever consultas em uma visualização de registros, você consulta a visualização de análise.

É possível salvar consultas que consultam uma visualização de registros ou de análise.

Antes de começar

Nesta seção, descrevemos as etapas que você precisa concluir antes de usar a análise de registros.

Configurar buckets de registros

Confirme se os buckets de registros foram atualizados para usar a Análise de registros:

  1. No console Google Cloud , acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.

  2. Para cada bucket de registros com uma visualização que você quer consultar, verifique se a coluna Log Analytics disponível mostra Abrir. Se a opção Fazer upgrade aparecer, clique nela e conclua a caixa de diálogo.

Configurar permissões e papéis do IAM

Nesta seção, descrevemos os papéis ou as permissões do IAM necessários para usar a análise de registros:

  • Para receber as permissões necessárias para usar a Análise de registros e consultar visualizações de registros, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

    É possível restringir um principal a uma visualização de registros específica adicionando uma condição do IAM à concessão de papel de leitor de acesso à visualização de registros feita no nível do projeto ou adicionando uma vinculação do IAM ao arquivo de política da visualização de registros. Para mais informações, consulte Controlar o acesso a uma visualização de registro.

    Essas são as mesmas permissões necessárias para visualizar entradas de registro na página Análise de registros. Para informações sobre outros papéis necessários para consultar visualizações em buckets definidos pelo usuário ou para consultar a visualização _AllLogs do bucket de registros _Default, consulte Papéis do Cloud Logging.

  • Para receber as permissões necessárias para consultar visualizações de análise, peça ao administrador para conceder a você o papel do IAM de Usuário da análise de observabilidade (roles/observability.analyticsUser) no projeto.

Salvar uma consulta

Todas as consultas executadas são salvas automaticamente por 30 dias e podem ser acessadas selecionando a guia Recente na página Análise de registros. Você pode pesquisar, visualizar, executar e compartilhar as consultas listadas na guia Recentes.

Se você quiser manter uma consulta disponível para uso futuro, anote-a com informações úteis ou permita que colegas de equipe vejam e executem sua consulta. É possível pesquisar e classificar as consultas salvas por nome, descrição e rótulo de visibilidade. Você também pode editar e excluir essas consultas. As consultas salvas são mantidas até que você as exclua.

É possível salvar 10.000 consultas por projeto do Google Cloud .

Console

Para salvar uma consulta, faça o seguinte:

  1. No console Google Cloud , acesse a página Análise de dados de registros:

    Acesse Análise de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.

  2. Preencha o painel Consulta com uma consulta.

    Para preencher o painel Consulta, insira uma nova consulta, selecione uma na guia Recente ou na guia Salvas.

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

    Quando a consulta no painel Consulta é válida, o botão Salvar é ativado.

  3. Clique em Salvar, selecione Salvar consulta e preencha os campos Nome e Descrição. Os valores definidos para esses campos são mostrados na guia Salvo.

  4. Opcional: para permitir que todos com acesso à página Análise de dados de registros da visualização do projeto Google Cloud executem a consulta salva, ative a opção Compartilhar com o projeto.

    Por padrão, essa opção fica desativada, e a visibilidade é restrita a você.

  5. Clique em Salvar consulta.

  6. Opcional: para ver, classificar e executar consultas salvas que estão visíveis para você, selecione a guia Salvas.

    É possível classificar e filtrar as consultas salvas por nome, descrição e rótulo de visibilidade. Também é possível filtrar pelo conteúdo da consulta.

É possível editar e excluir consultas criadas usando as opções na guia Salvas:

  • Para editar uma consulta, clique em Mais opções e selecione Editar. É possível modificar os valores dos campos Nome e Descrição, mas a consulta em si não pode ser modificada.

  • Para excluir uma consulta salva, clique em Mais opções e selecione Excluir.

API

Para salvar uma consulta usando a API Logging, use o método savedQueries.create. Para mais informações sobre esse método, os parâmetros dele e os dados de resposta, consulte a página de referência de savedQueries.create.

É possível executar o método savedQueries.create usando o widget APIs Explorer na página de referência do método. Para consultas do Log Analytics, especifique o campo opsAnalyticsQuery. O exemplo a seguir ilustra um corpo de solicitação de amostra, 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
            `TABLE_NAME_OF_LOG_VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
      "visibility": "PRIVATE"
   }
}

Compartilhar uma consulta

É possível compartilhar uma consulta salva com todos que têm acesso ao seu projeto do Google Cloud . No entanto, os papéis do IAM do principal determinam se a consulta pode ser executada e os dados que ela retorna.

Console

Ao resolver um problema ou quando você encontra resultados anômalos, talvez queira compartilhar uma consulta e os resultados dela com um colega de equipe. Ao visualizar os resultados da consulta na página Análise de dados de registros, você pode copiar um URL que, quando aberto, mostra a consulta executada e os resultados dela.

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

  1. No console Google Cloud , acesse a página Análise de dados de registros:

    Acesse Análise de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.

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

    Para preencher o painel Consulta, insira uma nova consulta, selecione uma na guia Recente ou na guia Salvas.

  3. Clique em Compartilhar link.

  4. Envie o link para seu colega de equipe.

    Quando seu colega abrir o link, a página Análise de dados de registros será aberta. Nela, aparecem a consulta que você executou e os resultados dela.

    Para abrir o URL, o papel do IAM do seu colega de equipe no projeto Google Cloud precisa incluir as permissões necessárias para acessar a página Análise de Registros.

API

É possível usar a API Logging para criar uma consulta compartilhada 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 de savedQueries.create.

Ver e executar consultas recentes ou salvas

Para ver ou executar uma consulta novamente, selecione a guia Recente na página Análise de dados de registros 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 salva, selecione a guia Salvas na página Análise de dados de registros e encontre a consulta:

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

A seguir