Salvar e compartilhar consultas

Com a Análise de observabilidade, é possível salvar e compartilhar consultas SQL para executar novamente investigações frequentes do Cloud Trace e colaborar com membros da equipe em todo o projeto. As consultas salvas podem ser mantidas em particular 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 Consultar e analisar traces.

Antes de começar

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

Configurar o projeto e as funções

  1. Faça login na sua conta do Google Cloud . 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, if it is not already enabled.

    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, if it is not already enabled.

    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 ter as permissões necessárias para carregar a página Análise de observabilidade, escrever, executar e salvar consultas particulares nos dados de rastreamento, peça ao administrador para conceder 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 aceita 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 função, o principal poderá acessar todas as visualizações de observabilidade.
    • Usuário do Analytics de observabilidade (roles/observability.analyticsUser) no seu projeto. Esse papel contém as permissões necessárias para salvar e executar consultas particulares e compartilhadas.

    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 usando papéis personalizados ou outros papéis predefinidos.

Selecione a interface que você quer usar.

Console

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

gcloud

No console do Google Cloud , ative o Cloud Shell.

Ativar o Cloud Shell

Na parte de baixo do console Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud 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 nesta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.

    Instale a CLI do Google Cloud.

    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 na guia Recente da página Análise de observabilidade. Você pode pesquisar, visualizar, executar e compartilhar as consultas listadas na guia Recente.

Para reutilizar, adicionar descrições personalizadas ou compartilhar uma consulta com colegas de equipe, salve-a. É possível pesquisar e classificar as consultas salvas por nome, descrição e marcador 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 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 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.

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

    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 observabilidade do projeto Google Cloud vejam e executem sua 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 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 não a consulta em si.

  • 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: defina como private ou shared.
    • SQL_QUERY: uma consulta SQL. Se as crases simples (`) envolverem o caminho ou os campos dentro dele, será necessário usar caracteres de escape:
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"
          

      ou

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

      As crases (`) são obrigató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 textual da consulta. Opcional.
    • PROJECT_ID: o identificador do projeto.

    Execute o comando gcloud logging saved-queries create:

    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

    Este é 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 informar 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 do gcloud logging saved-queries.

REST

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

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

  1. Selecione savedQueries.create.
  2. Na página de referência, use o 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 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 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 console Google Cloud , 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.

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

  3. Clique em Compartilhar link.

  4. Envie o link para seu colega de equipe.

    Quando seu colega de equipe abre o link, a página Análise de Observabilidade é aberta e mostra, mas não executa, a consulta. Seu colega 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 deles é a hierarquia dos recursos usados pela consulta.

    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 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 visão geral do gcloud logging saved-queries.

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 para 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 Observabilidade 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 observabilidade 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