Consultar e analisar rastreamentos

Neste documento, descrevemos como consultar e analisar os dados de trace usando o Observability Analytics, que oferece uma interface de consulta baseada em SQL. O SQL permite realizar análises agregadas, o que pode ajudar a gerar insights e identificar tendências. Para conferir os resultados da consulta, use tabelas ou gráficos. Você também pode salvar essas tabelas e gráficos nos seus painéis personalizados.

Se você quiser conferir ou explorar traces ou períodos individuais ou visualizar atributos anexados a períodos, use a página Trace Explorer. Para mais informações sobre essa página, consulte Encontrar e explorar traces.

Para o trace, é possível consultar um bucket de observabilidade chamado _Trace. Uma visualização, _AllSpans, está disponível para consulta. Para saber mais sobre como os dados de trace são armazenados, consulte Visão geral do armazenamento.

Sobre conjuntos de dados vinculados do BigQuery

Não é necessário um conjunto de dados vinculado do BigQuery para consultar os dados de trace ou os dados de trace e registro. Para esses cenários, use a página Observability Analytics. Para informações sobre como consultar dados de registro, consulte Consultar e analisar registros com o Observability Analytics.

Você precisa de um conjunto de dados vinculado do BigQuery quando quiser fazer o seguinte:

Este documento não descreve como criar um conjunto de dados vinculado ou como configurar o Observability Analytics para executar consultas em slots reservados. Para informações sobre esses tópicos, consulte Consultar um conjunto de dados vinculado do BigQuery.

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 conseguir as permissões que você precisa para carregar a página do Observability Analytics, escrever, executar e salvar consultas particulares nos dados de trace, 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.
    • Usuário do Observability Analytics (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.

    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.

Mostrar o esquema

O esquema define como os dados são armazenados, incluindo os campos e os tipos de dados. Essas informações são importantes porque o esquema determina os campos que você consulta e se é necessário transmitir campos para diferentes tipos de dados. Por exemplo, para escrever uma consulta que calcula a latência média de solicitações HTTP, é necessário saber como acessar o campo de latência e se ele está armazenado como um número inteiro, como 100, ou como uma string, como "100". Se os dados de latência forem armazenados como uma string, a consulta precisará transmitir o valor para um valor numérico antes de calcular uma média.

Para identificar o esquema, faça o seguinte:

  1. No Google Cloud console, acesse a Observability Analytics page:

    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. No menu Visualizações, acesse a seção Traces, e selecione _Trace.Spans._AllSpans.

    O painel Esquema é atualizado. O Observability Analytics infere automaticamente os campos de uma coluna quando o tipo de dados é JSON. Para conferir a frequência com que esses campos inferidos aparecem nos seus dados, clique Opções e selecione Visualizar informações e descrição.

    Para saber mais sobre o esquema, consulte Esquema de armazenamento de dados de trace.

    Se você não encontrar uma visualização chamada _Trace.Spans._AllSpans, seu Google Cloud projeto não contém um bucket de observabilidade chamado _Trace. Para informações sobre como resolver essa falha, consulte A inicialização do armazenamento de trace falha.

Consultar dados de trace

Esta seção descreve as abordagens que você pode usar para consultar os dados de trace:

  • Carregue uma consulta definida pelo sistema, edite-a e execute-a.
  • Insira e execute uma consulta personalizada. Por exemplo, você pode colar uma consulta que tem ou escrever uma. As consultas personalizadas podem incluir combinações, consultas aninhadas e outras instruções SQL complexas. Para exemplos, consulte Amostras de consultas SQL.
  • Crie uma consulta fazendo seleções de menu e execute-a. O Observability Analytics converte suas seleções em uma consulta SQL, que você pode visualizar e editar.

Carregar, editar e executar a consulta definida pelo sistema

  1. No Google Cloud console, acesse a Observability Analytics page:

    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. No menu Visualizações, acesse a seção Traces, e selecione _Trace.Spans._AllSpans.

    Se você não encontrar uma visualização chamada _Trace.Spans._AllSpans, seu Google Cloud projeto não contém um bucket de observabilidade chamado _Trace. Para informações sobre como resolver essa falha, consulte A inicialização do armazenamento de trace falha.

  3. Escolha uma destas opções:

    • Para carregar uma consulta definida pelo sistema que depende do Criador de consultas, que permite definir a consulta com seleções de menu, verifique se o painel Consulta mostra o Criador de consultas. Se um editor de SQL for mostrado, então clique em  Criador.

    • Para carregar uma consulta definida pelo sistema que extrai valores JSON, verifique se o painel Consulta mostra o editor de SQL. Se esse painel mostrar Criador de consultas, clique em  SQL.

  4. No painel Esquema, selecione Consulta e clique em Substituir.

    O painel Consulta mostra uma consulta definida pelo sistema. Se você selecionou o Criador de consultas modo, mas quer visualizar a consulta SQL, clique em  SQL.

  5. Opcional: modifique a consulta.

  6. Para executar a consulta, acesse a barra de ferramentas e selecione Executar consulta.

    O Observability Analytics apresenta os resultados da consulta em uma tabela. No entanto, é possível criar um gráfico e também salvar a tabela ou o gráfico em um painel personalizado. Para mais informações, consulte Representar os resultados da consulta SQL em um gráfico.

    Se a barra de ferramentas mostrar Executar no BigQuery, será necessário mudar o Observability Analytics para usar o mecanismo de consulta padrão. Para fazer essa mudança, na barra de ferramentas do painel Consulta, clique em Configurações e selecione Analytics (padrão).

Inserir e executar uma consulta personalizada

Para inserir uma consulta SQL, faça o seguinte:

  1. No Google Cloud console, acesse a Observability Analytics page:

    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. No painel Consulta, clique em  SQL.

    • Para especificar um período, recomendamos que você use o seletor de período. Se você adicionar uma cláusula WHERE que especifica o campo timestamp, esse valor vai substituir a configuração no seletor de período, e esse seletor será desativado.

    • Para exemplos, consulte Amostras de consultas SQL.

    • O editor de SQL mostra o nome totalmente qualificado da visualização _Trace.Spans._AllSpans, que tem o seguinte formato:

      FROM `PROJECT_ID.LOCATION._Trace.Spans._AllSpans`

      Os campos na expressão anterior têm o seguinte significado:

      Se o painel de consulta mostrar uma mensagem de erro que faz referência à instrução FROM, a visualização não poderá ser encontrada. Para informações sobre como resolver essa falha, consulte Mensagem de erro informando que uma visualização não existe.

  3. Para executar a consulta, acesse a barra de ferramentas e selecione Executar consulta.

    O Observability Analytics apresenta os resultados da consulta em uma tabela. No entanto, é possível criar um gráfico e também salvar a tabela ou o gráfico em um painel personalizado. Para mais informações, consulte Representar os resultados da consulta SQL em um gráfico.

    Se a barra de ferramentas mostrar Executar no BigQuery, será necessário mudar o Observability Analytics para usar o mecanismo de consulta padrão. Para fazer essa mudança, na barra de ferramentas do painel Consulta, clique em Configurações e selecione Analytics (padrão).

Criar, editar e executar uma consulta

A interface do Criador de consultas permite criar uma consulta fazendo seleções nos menus. O Observability Analytics converte suas seleções em uma consulta SQL, que você pode visualizar e editar. Por exemplo, você pode começar usando a interface do Criador de consultas e mudar para o editor de SQL para refinar a consulta.

O Observability Analytics sempre pode converter as seleções de menu da interface do Criador de consultas em uma consulta SQL. No entanto, nem todas as consultas SQL podem ser representadas pela interface do Criador de consultas. Por exemplo, as consultas com combinações não podem ser representadas por essa interface.

Para criar uma consulta, faça o seguinte:

  1. No Google Cloud console, acesse a Observability Analytics page:

    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. Se o painel Consulta mostrar um editor de SQL, selecione Criador, que abre o painel Criador de consultas.

  3. Use o menu Origem para selecionar a visualização que você quer consultar. Suas seleções são mapeadas para a cláusula FROM na consulta SQL.

  4. Opcional: use os menus a seguir para restringir ou formatar a tabela de resultados:

    • Pesquisar todos os campos: pesquisa strings correspondentes. Suas seleções são mapeadas para a cláusula WHERE na consulta SQL.

    • Colunas: selecione as colunas que aparecem na tabela de resultados. Suas seleções são mapeadas para as cláusulas SELECT na consulta SQL.

      Quando você seleciona um nome de campo nesse menu, uma caixa de diálogo é aberta. Nessa caixa de diálogo, você pode fazer o seguinte:

      • Use o menu para agregar ou agrupar seus dados.

        Para evitar erros de sintaxe, qualquer agregação e agrupamento aplicado a uma coluna também é aplicado automaticamente a outras colunas. Para um exemplo de como agregar e agrupar entradas, consulte Agrupar e agregar dados usando o Criador de consultas.

      • Transmita um valor de qualquer tipo para outro tipo de dados especificado. Para mais informações, consulte a CAST documentação.

      • Extraia uma substring de valores usando expressões regulares. Para mais informações, consulte a REGEXP_EXTRACT documentação.

    • Filtros: adicione filtros quando quiser restringir a consulta a períodos que contêm um atributo ou ID de período específico. O menu lista todas as opções de filtro disponíveis. Suas seleções são mapeadas para a cláusula WHERE na consulta SQL.

    • Classificar por: defina as colunas a serem classificadas e se a classificação é crescente ou decrescente. Suas seleções são mapeadas para a cláusula ORDER BY na consulta SQL.

    • Limite: defina o número máximo de linhas na tabela de resultados. Suas seleções são mapeadas para a cláusula LIMIT na consulta SQL.

  5. Para executar a consulta, acesse a barra de ferramentas e selecione Executar consulta.

    O Observability Analytics apresenta os resultados da consulta em uma tabela. No entanto, é possível criar um gráfico e também salvar a tabela ou o gráfico em um painel personalizado. Para mais informações, consulte Representar os resultados da consulta SQL em um gráfico.

    Se a barra de ferramentas mostrar Executar no BigQuery, será necessário mudar o Observability Analytics para usar o mecanismo de consulta padrão. Para fazer essa mudança, na barra de ferramentas do painel Consulta, clique em Configurações e selecione Analytics (padrão).

Exemplo: agrupar e agregar dados usando o Criador de consultas

Quando você seleciona uma coluna no Criador de consultas, cada campo inclui um menu em que é possível adicionar agrupamento e agregação. O agrupamento permite organizar os dados em grupos com base no valor de uma ou mais colunas, e a agregação permite realizar cálculos nesses grupos para retornar um único valor.

Cada campo selecionado no elemento Colunas tem um menu anexado com as seguintes opções:

  • Nenhum: não agrupe nem agregue por esse campo.
  • Agregar: agrupe os campos listados no elemento Colunas, exceto quando o campo tiver uma seleção Agregar. Para esses campos, calcule o valor realizando uma operação em todas as entradas de cada agrupamento. A operação pode ser para calcular a média de um campo ou para fazer algo como contar o número de entradas em cada agrupamento.
  • Agrupar por: agrupe as entradas por todos os campos listados no elemento Colunas.

Este exemplo mostra como usar o Criador de consultas para agrupar períodos por horário de início, nome e tipo de período e, em seguida, calcular a duração média em nanossegundos para cada grupo:

  1. No menu Colunas , selecione os campos start_time, name, kind e duration_nano.
  2. Para truncar o horário de início, expanda o menu na coluna start_time e selecione Agrupar por. Verifique se o menu de granularidade está definido como Hora.

  3. Clique em Aplicar.

    Quando você seleciona Agrupar por para qualquer coluna, o sistema agrupa as entradas por todas as colunas. Neste exemplo, as entradas são agrupadas pelo valor truncado de start_time, o nome do período, o tipo de período e o valor da duração.

    No entanto, o objetivo deste exemplo é agrupar as entradas pelo horário truncado, o nome do período e o tipo de período e, para cada grupo, calcular a duração média. Na próxima etapa, você modifica o agrupamento e adiciona uma agregação.

  4. Expanda o menu no campo duration_nano, selecione Agregar e defina o campo Agregação como Média.

    Quando você executa a consulta, cada linha corresponde a um grupo, que consiste em um horário truncado, um nome de período e um tipo de período. A entrada final em cada linha é a duração média de todas as entradas nesse grupo.

    Os resultados dessa consulta são semelhantes aos seguintes:

    +-----------------------------------+----------------+----------+-----------------------+
| Row | hour_timestamp              | span_name      | kind     | average_duation_nano  |
|     | TIMESTAMP                   | STRING         | INTEGER  | FLOAT                 |
+-----+-----------------------------+-----------+---------------+-----------------------+
| 1   | 2025-10-09 13:00:00.000 EDT | http.receive   | 3        | 122138.22813990474
| 2   | 2025-10-09 13:00:00.000 EDT | query.request  | 1        | 6740819304.390297
| 3   | 2025-10-09 13:00:00.000 EDT | client.handler | 2        | 6739339098.409376

  5. A consulta pode incluir várias agregações. Por exemplo, para adicionar uma coluna que conta o número de entradas em cada grupo, faça o seguinte:

    1. No elemento Colunas, clique em Adicionar coluna.
    2. Selecione Todas (*).
    3. Na caixa de diálogo, selecione Agregar, selecione Contagem para a Agregação e, em seguida, selecione Aplicar.

    Com essa mudança, o agrupamento permanece o mesmo. As entradas são agrupadas pelo horário de início truncado, o nome do período e o tipo de período. No entanto, para cada grupo, a consulta calcula a duração média e o número de entradas.

A consulta SQL correspondente ao exemplo anterior é a seguinte:

WITH
  scope_query AS (
  SELECT
    *
  FROM
    `PROJECT_ID.global._Trace._AllSpans` )
SELECT
  -- Report the truncated start time, span name, span kind, average duration and number
  -- of entries for each group.
  TIMESTAMP_TRUNC( start_time, HOUR ) AS hour_start_time,
  name AS span_name,
  kind,
  AVG( duration_nano ) AS average_duration_nano,
  COUNT( * ) AS count_all
FROM
  scope_query
GROUP BY
  TIMESTAMP_TRUNC( start_time, HOUR ),
  name,
  kind
LIMIT
  100

A seguir