Salvar ou compartilhar consultas SQL

É possível salvar e compartilhar consultas SQL na Análise de observabilidade, o que permite executar novamente investigações frequentes e colaborar com membros da equipe no projeto. As consultas salvas podem ser mantidas particulares para seu próprio uso ou compartilhadas com outros membros do projeto. Se você ainda não escreveu consultas na Análise de observabilidade, consulte primeiro Consultar e analisar dados de telemetria com a Análise de observabilidade.

Antes de começar

Configure seu projeto, seus papéis do IAM e selecione a interface que você planeja usar.

Configurar o projeto e os papéis

  1. Faça login na sua Google Cloud conta do. Se você começou a usar o Google Cloudagora, crie uma conta para avaliar o desempenho dos nossos produtos em situações reais. Clientes novos também recebem US $300 em créditos para executar, testar e implantar cargas de trabalho.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  8. Para conseguir as permissões que você precisa para carregar a página Análise de observabilidade, escrever, executar e salvar consultas particulares, peça ao administrador que conceda a você os seguintes papéis do IAM:

    • Acessador de visualização de observabilidade (roles/observability.viewAccessor) nas visualizações de observabilidade que você quer consultar. Esse papel oferece suporte às condições do IAM, que permitem restringir a concessão a uma visualização específica. Se você não anexar uma condição à concessão de papel, o principal poderá acessar todas as visualizações de observabilidade.
    • Usuário da Análise de observabilidade (roles/observability.analyticsUser) no seu projeto. Esse papel contém as permissões necessárias para salvar e executar consultas particulares e executar consultas compartilhadas.
    • Leitor de registros (roles/logging.viewer) on your project.
    • Acessador de exibição de registros (roles/logging.viewAccessor) no projeto que armazena as visualizações de registro que você quer consultar.

    Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

    Também é possível conseguir as permissões necessárias com papéis personalizados ou outros papéis predefinidos.

Selecionar 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 consol, ative o Cloud Shell.

Ativar o Cloud Shell

Na parte de baixo do Google Cloud consol, 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 Recentes na página Análise de observabilidade. É possível pesquisar, visualizar, executar e compartilhar as consultas listadas na guia Recentes.

Para reutilizar uma consulta, adicione descrições personalizadas ou compartilhe-a 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 consol, acesse a página Análise de observabilidade:

    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 Recentes 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 consol, acesse a página Análise de observabilidade:

    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 Recentes 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 com sucesso, o papel do IAM do seu 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 você 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 novamente uma consulta, selecione a guia Recentes 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