Salvar e compartilhar consultas SQL

Este documento descreve como salvar e compartilhar consultas criadas na Análise de observabilidade.

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

Para saber como representar graficamente os resultados da consulta e como salvar esses gráficos em um painel personalizado, consulte Representar graficamente os resultados da consulta 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 observabilidade e salva como uma consulta. A ação de salvar permite que você execute essa consulta novamente quando quiser. Ao salvar a consulta, você tem a opção de torná-la particular ou visível para outras pessoas que tenham as permissões necessárias para usar a Análise de observabilidade. Não é possível gravar uma consulta SQL em que a cláusula FROM especifica uma consulta salva.

Uma visualização de análise contém uma consulta que você pode ser executada novamente quando quiser. Você cria uma visualização de análise gravando uma consulta SQL em uma visualização de registro e salvando o resultado como uma visualização. Ao contrário das consultas salvas, não é possível tornar uma visualização de análise particular. É possível consultar uma visualização de análise. Esse recurso permite transformar os dados de registro do formato LogEntry em outro mais adequado para você. Em seguida, em vez de gravar as consultas em uma visualização de registro, você consulta a visualização de análise.

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

Antes de começar

Esta seção descreve as etapas que você precisa concluir antes de usar a Análise de observabilidade.

configurar buckets de registros

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

  1. No Google Cloud console, 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 tenha uma visualização de registro que você quer consultar, verifique se a coluna Análise de observabilidade disponível mostra Abrir. Se Fazer upgrade for mostrado, clique em Fazer upgrade e conclua a caixa de diálogo.

Configurar papéis e permissões do IAM

Esta seção descreve os papéis ou permissões do IAM necessários para usar a Análise de observabilidade:

  • Para receber as permissões necessárias para usar a Análise de observabilidade e consultar visualizações de registro, 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 registro específica adicionando uma condição do IAM à concessão de papel do Acessador de 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 registro. 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 de usuário da Análise de observabilidade (roles/observability.analyticsUser) do IAM no projeto.

Selecione a interface que você planeja usar

Console

Quando você usa o Google Cloud console para acessar Google Cloud serviços e APIs, não é necessário configurar a autenticação.

gcloud

No Google Cloud console, ative o Cloud Shell.

Ativar o Cloud Shell

Na parte de baixo do Google Cloud console, uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a Google Cloud CLI já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

REST

Para usar as amostras da API REST desta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.

    Instale a Google Cloud CLI.

    Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

Saiba mais em Autenticar para usar REST na documentação de autenticação do Google Cloud .

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 observabilidade. É possível pesquisar, visualizar, executar e compartilhar as consultas listadas na guia Recente.

Para reutilizar uma consulta, adicionar descrições personalizadas ou compartilhar com colegas de equipe, salve a consulta. É possível pesquisar e classificar as consultas salvas pelo nome, descrição e rótulo de visibilidade. Também é possível editar e excluir essas consultas. As consultas salvas são mantidas até que você as exclua.

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

Console

Para salvar uma consulta, faça o seguinte:

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

    Acessar a análise de observabilidade

    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.

    É possível preencher o painel Consulta inserindo uma nova consulta, selecionando uma consulta na guia Recente ou selecionando uma consulta na guia Salvas.

    A consulta pode incluir qualquer visualização válida, várias visualizações e visualizações de análise.

    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 Salvas.

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

    Por padrão, essa opção está desativada 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 Salvas.

    É possível classificar e filtrar as consultas salvas pelo 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; no entanto, a consulta em si não pode ser modificada.

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

gcloud

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

  1. Antes de usar os dados do comando abaixo, faça estas substituições:

    • DISPLAY_NAME: o nome de exibição da consulta salva.
    • LOCATION: o local da consulta salva.
    • VISIBILITY: definido como private ou shared.
    • SQL_QUERY: uma consulta SQL. Se as aspas simples (`) envolverem o caminho ou os campos dentro do caminho, será necessário escapar dessas aspas: 
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"

      ou

          "SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"

      As aspas simples (`) são necessárias quando um elemento de caminho contém um caractere de ponto (.).

    • ID: o ID da consulta salva. Esse ID é uma entrada obrigatória para comandos que descrevem, atualizam ou excluem uma consulta salva. Se você não fornecer o ID ao criar uma consulta salva, o sistema vai gerar um ID numérico.
    • DESCRIPTION: uma descrição de texto da consulta. Opcional.
    • PROJECT_ID: o identificador do projeto.

    Execute o gcloud logging saved-queries create comando:

    Linux, macOS ou Cloud Shell

    gcloud logging saved-queries create --display-name=DISPLAY_NAME \
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY \
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (PowerShell)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME `
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY `
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (cmd.exe)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME ^
 --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ^
 --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Confira a seguir um exemplo de resposta quando o ID fornecido no comando era my-saved-query:

    Created saved query [projects/PROJECT_ID/locations/LOCATION/savedQueries/my-saved-query].

    A resposta ao comando create lista o nome completo da consulta, que inclui o ID dela. O ID da consulta, que neste exemplo é my-saved-query, é uma entrada obrigatória para comandos da Google Cloud CLI que descrevem, excluem ou atualizam uma consulta salva.

  2. Para inspecionar a consulta salva, execute o seguinte comando:

     gcloud logging saved-queries list --location=- --project=PROJECT_ID

    Na expressão anterior, o valor do local é um hífen (-), que funciona como um caractere curinga. Também é possível fornecer um local específico.

Há comandos da Google Cloud CLI para excluir, listar, descrever e atualizar consultas salvas. Para mais informações, consulte a visão geral de gcloud logging saved-queries.

REST

É possível salvar uma consulta usando a API Cloud Logging. Para salvar uma consulta, use o savedQueries.create método.

Para executar esse método, faça o seguinte:

  1. Selecione savedQueries.create.
  2. Na página de referência, use a APIs Explorer para emitir um comando. É necessário especificar 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
            `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 Google Cloud projeto. No entanto, os papéis do IAM do principal determinam se a consulta pode ser executada e os dados que ela retorna.

Console

Ao solucionar um problema ou quando você encontrar resultados anômalos, 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 observabilidade, é 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 Google Cloud console, acesse a Análise de observabilidade página:

    Acessar a análise de observabilidade

    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.

    É possível preencher o painel Consulta inserindo uma nova consulta, selecionando uma consulta na guia Recente ou selecionando uma consulta na guia Salvas.

  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 observabilidade será aberta e mostrará, mas não executará, a consulta. Seu colega de equipe precisa executar a consulta manualmente.

    A página Análise de observabilidade mostra uma caixa de diálogo de aviso quando a consulta é executada no mecanismo do BigQuery e os recursos consultados não estão no mesmo limite de propriedade. Os limites de propriedade são determinados por vários fatores, um dos quais é a hierarquia dos recursos usados pela consulta.

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

gcloud

Quando quiser criar uma consulta salva que possa ser executada por outras pessoas, defina o valor do campo visibility como shared:

--visibility=shared

Para mudar a visibilidade de uma consulta salva, use o comando update. Para mais informações sobre os comandos disponíveis, consulte a gcloud logging saved-queries visão geral.

REST

É 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.

Visualizar e executar consultas recentes ou salvas

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

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

Para visualizar, editar ou executar uma consulta salva, selecione a guia Salvas na página Análise de observabilidade e encontre a consulta:

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

A seguir