Salvar e compartilhar consultas SQL

Este documento descreve como salvar e compartilhar consultas que você cria no a Análise de dados de registros.

Ele pressupõe que você tenha familiaridade com a Análise de dados de registros e como usar a página Análise de dados de registros para consultar seus dados de registro. Se você não familiarizados com esses tópicos, consulte Consultar e analisar registros.

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

Antes de começar

Antes de usar a Análise de dados de registros, faça o seguinte:

  • Para receber as permissões necessárias a fim de usar a Log Analytics, peça que o administrador conceda a você os seguintes papéis do IAM no projeto:

    Você pode restringir um principal a uma visualização de registro específica adicionando um A condição do IAM para a concessão do papel de Acessador de visualização de registros feita em para envolvidos no projeto ou adicionando uma vinculação do IAM ao do arquivo de política da visualização de registros. Para mais informações, consulte Controlar o acesso a uma visualização de registros

    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.

  • Verifique se os buckets de registro foram atualizados para usar a Análise de dados de registros:

    1. No console do 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 que tem uma visualização de registro que você quer consultar, a garantir que A coluna Análise de dados de registros disponível exibe Abrir. Se a opção Upgrade for exibida, clique em Upgrade e conclua a caixa de diálogo.

Salvar uma consulta

Todas as consultas executadas são salvas automaticamente por 30 dias e podem ser acessadas selecionando a guia Recentes na página Análise de Registros. É possível 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 para você, ou permitir que colegas de equipe visualizem e executem sua consulta, e salve a consulta. Você pode pesquisar e classificar suas consultas salvas pelos 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 do 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 consulta na guia Recente ou selecione uma consulta na guia Salvo.

    Quando a consulta no painel Consulta for válida, o Salvar será ativado.

  3. Clique em Salvar e preencha o Nome e a Descrição. campos. Os valores definidos para esses campos são mostrados na página Salvos .

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

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

  5. Clique em Salvar consulta.

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

    Você pode classificar e filtrar suas consultas salvas por nome, descrição e marcador de visibilidade. Também é possível filtrar pelo conteúdo da consulta.

Você pode editar e excluir as consultas que criou usando as opções em na guia Salvos:

  • Para editar uma consulta, clique em Mais opções e selecione Editar. Você pode modificar os valores do atributo nos campos Nome e Descrição; No entanto, a consulta em si não pode ser modificado.

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

API

Para salvar uma consulta usando a API Logging, use o savedQueries.create. Para mais informações sobre esse método, sua parâmetros e dados de resposta, consulte a página de referência para 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 da Análise de dados de registros, especifique o campo opsAnalyticsQuery. O exemplo a seguir ilustra um corpo de solicitação 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
           `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

Console

Ao resolver um problema ou quando você notar resultados anormais, talvez seja necessário 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, é possível 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 do 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 consulta na guia Recente ou selecione uma consulta na guia Salvo.

  3. Clique em Compartilhar link.

  4. Envie o link para seu colega de equipe.

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

    Para abrir o URL, a função de gerenciamento de identidade e acesso do colega de equipe no projeto do Google Cloud precisa incluir as permissões necessárias para visualizar as páginas de geração 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 no campo visibility. Para mais informações, consulte a página de referência de savedQueries.create.

Consultar e executar consultas recentes ou salvas

Para conferir ou executar novamente uma consulta, selecione a guia Recente na página Análise de dados de registro e encontre a consulta:

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

Para visualizar, 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