Salvar ou compartilhar consultas SQL

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

Para informações sobre como representar suas consultas em gráficos ou exemplos de consultas, consulte os documentos listados na A seguir seção deste documento.

Antes de começar

  1. Faça login na sua Google Cloud conta do. Se você começou a usar o Google Cloud, 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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

  8. Para ter 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 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 oferece suporte a 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. As visualizações de observabilidade estão no Acesso antecipado.
    • 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) no seu projeto.
    • 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 usando personalizados papéis ou outros predefinidos papéis.

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.

Se você quiser manter uma consulta disponível para uso futuro, anote-a com informações úteis ou permita que os colegas de equipe visualizem e executem sua 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 dados de registros página:

    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.

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

    Sua 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 Salvos.

  4. Opcional: para permitir que todos com acesso à página Análise de observabilidade do Google Cloud projeto visualizem 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 visualizar, classificar e executar consultas salvas que estão visíveis para você, selecione a guia Salvos.

    É 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 Salvos:

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

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 dados de registros página:

    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.

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

  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 seu colega de equipe no Google Cloud projeto precisa incluir as permissões necessárias para visualizar a página Análise de observabilidade.

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 Salvos 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