Migrar para a Análise de observabilidade

Se você usa coletores para exportar dados de rastreamento para o BigQuery, então este documento é para você. O uso de coletores para exportar dados de rastreamento não é mais recomendado. Em vez disso, recomendamos que você use a Análise de observabilidade, que oferece suporte à mesma linguagem de consultaSQL do BigQuery. Este documento descreve como migrar de uma solução baseada em coletores para uma que usa a Análise de observabilidade. Ele também inclui informações sobre como consultar os dados de rastreamento usando os serviços do BigQuery.

O BigQuery oferece serviços que permitem copiar tabelas ou exportar dados. É possível copiar e exportar os dados de rastreamento usando esses serviços depois de criar um conjunto de dados vinculado do BigQuery, uma etapa opcional detalhada neste documento. Para mais informações, consulte Gerenciar tabelas e Introdução à exportação de dados.

Para começar a usar a Análise de observabilidade, consulte Consultar e analisar rastros.

Antes de começar

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.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

1. Para ter as permissões necessárias para carregar a página Observability Analytics , executar consultas e criar um conjunto de dados vinculado, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

   • Administrador do Cloud Trace (roles/cloudtrace.admin)
   • Editor de observabilidade (roles/observability.editor)
   • Usuário do BigQuery (roles/bigquery.user)

   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.

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

Migrar para a Análise de observabilidade

1. Conclua as ações listadas na seção Antes de começar deste documento. Essas ações incluem a ativação da API Observability.

2. Verifique se você tem acesso aos dados de rastreamento usando a Análise de observabilidade:

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

      O painel Esquema é atualizado e mostra o esquema.

      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 situação, consulte A inicialização do armazenamento de rastreamento falha.

   3. No painel Esquema, selecione Consulta.

      O campo do editor de consultas é atualizado. A cláusula FROM lista uma entrada semelhante a esta:

      `PROJECT_ID.us._Trace.Spans._AllSpans`
      

   4. Na barra de ferramentas, selecione Executar consulta.

      Se a barra de ferramentas mostrar Executar no BigQuery, clique em Configurações e selecione Analytics (padrão).

   Você verificou que é possível consultar os dados de rastreamento usando a página Análise de observabilidade.

3. Opcional: se você quiser mesclar os dados de trace a outros dados da empresa disponíveis para o BigQuery, crie um conjunto de dados vinculado do BigQuery. Para mais informações, consulte Consultar um conjunto de dados vinculado do BigQuery.

4. Exclua coletores de rastreamento e conjuntos de dados desnecessários:

   1. Para listar os coletores de rastreamento atuais, execute o gcloud alpha trace sinks list comando:

      gcloud alpha trace sinks list
      

   2. Para cada coletor, execute o gcloud alpha trace sinks delete comando:

      gcloud alpha trace sinks delete SINK_NAME
      

   3. Opcional: exclua todos os conjuntos de dados desnecessários do BigQuery. Para informações sobre como excluir um conjunto de dados do BigQuery, consulte Excluir conjuntos de dados.

Comparação de esquemas

Esta seção fornece informações sobre as diferenças entre a Análise de observabilidade e os esquemas de exportação baseados em coletores.

Nome	Analytics	Legado
ID do Trace	trace_id	extendedFields.traceId
ID do período	span_id	span.spanId
ID do período pai	parent_span_id	span.parentSpanId
Nome do período	name	span.displayName.value
Tipo de período	kind Para valores, consulte OpenTelemetry: SpanKind.	span.spanKind Para valores, consulte a página de referência da API Cloud Trace SpanKind.
Horário de início do período	start_time	span.startTime
Horário de término do período	end_time	span.endTime
Atributos	Os atributos de período, recurso e instrumentação têm um formato exclusivo. Esses campos têm o tipo de dados JSON do BigQuery. Exemplos: attributes["somekey"] resource.attributes["somekey"] instrumentation_scope.attributes["somekey"]	Todos os atributos usam o mesmo formato: span.attributes.attributeMap.ATTRIBUTE_KEY Exemplos: span.attributes.attributeMap._http_method span.attributes.attributeMap.g_co_agent span.attributes.attributeMap.rpc_service span.attributes.attributeMap.rpc_method

A seguir

• Consultar e analisar rastros.
• Amostras de consultas.