Criar e gerenciar escopos de rastreamento

Este documento descreve como criar e gerenciar um escopo de trace, que permite que a página do Explorador de trace encontre os períodos de trace que você quer visualizar ou analisar. Se você quiser apenas ver e analisar os intervalos que se originam no projeto do Google Cloud , não é necessário configurar nenhum escopo de rastreamento. No entanto, se os dados de rastreamento forem armazenados em vários projetos, como pode acontecer ao usar uma arquitetura de microsserviços, será necessário realizar algumas atividades de configuração para ver todos os intervalos de um único projeto Google Cloud .

Este documento não descreve como visualizar seus rastreamentos e intervalos. Para informações sobre esse tópico, consulte Encontrar e explorar traces.

Esse recurso só está disponível para projetos Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

Sobre os escopos de trace

Os escopos de trace são recursos persistentes para envolvidos no projeto que listam visualizações, que fornecem acesso aos dados de trace. É possível configurar a página do Explorador de trace para pesquisar por escopo de trace, o que significa que ela pesquisa as visualizações listadas no escopo selecionado. Seus papéis do Identity and Access Management (IAM) na visualização pesquisada e a configuração de período determinam quais dados o sistema busca no armazenamento e mostra.

Você pode criar escopos de rastreamento, além de modificar e excluir qualquer um deles. Você quer criar um escopo de rastreamento quando tem um serviço que grava dados de extensão em vários projetos do Google Cloud .

Um escopo de rastreamento lista visualizações, não projetos Google Cloud . Embora você selecione projetos ao configurar um escopo de rastreamento, o sistema adiciona ao escopo a visualização de rastreamento padrão desses projetos. A visualização de rastreamento padrão de um projeto corresponde à visualização com o caminho _Trace/Spans/_AllSpans, em que os campos _Trace, Spans e _AllSpans se referem a um bucket, um conjunto de dados e uma visualização de observabilidade. O conjunto de dados Spans armazena seus dados de rastreamento.

A menos que você abra a página Explorador de traces com um URL que inclua um escopo de trace ou um ID de trace e período, a página Explorador de traces pesquisa os dados de trace nas visualizações listadas no escopo de trace padrão. Quando você cria um projeto, o escopo de rastreamento chamado _Default é definido como o padrão. No entanto, é possível selecionar um escopo de rastreamento diferente para usar como padrão.

Sobre o escopo de observabilidade

O escopo de observabilidade especifica quais dos seus escopos de trace e de registro usar quando as páginas do explorador correspondentes forem abertas. Se você não configurar o escopo de observabilidade para listar os recursos que armazenam seus dados, talvez não seja possível correlacionar os dados de trace e de registro. Para saber mais, consulte Configurar escopos de observabilidade para consultas de vários projetos.

Aplicativos do App Hub e escopos de rastreamento

Seus aplicativos do App Hub podem gravar dados de rastreamento em vários projetos. Para ter uma visão agregada desses dados, crie um escopo de trace, configure-o para listar a visualização de trace padrão de todos os projetos que armazenam dados de trace e, em seguida, configure-o como o escopo de trace padrão. Quando você concluir essas etapas, a página Explorador de rastreamentos vai mostrar automaticamente os dados gravados pelo aplicativo, mesmo que eles estejam armazenados em projetos diferentes.

Crie o escopo de rastreamento personalizado no projeto em que você vai ver os dados de rastreamento. Esse projeto é o host do App Hub ou de gerenciamento. Por exemplo, se o nome de exibição de uma pasta for My Folder, o nome de exibição do projeto de gerenciamento da pasta será My Folder-mp.

Antes de começar

  1. Faça login na sua conta do Google Cloud . Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho de 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. Para receber as permissões necessárias para criar e visualizar escopos de trace, peça ao administrador para conceder a você o papel do IAM de Editor de escopos de observabilidade (roles/observability.scopesEditor) no projeto. 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.

    O papel de editor de escopos de observabilidade inclui permissões particulares que permitem criar e visualizar escopos de rastreamento. Essas permissões não estão disponíveis para inclusão em papéis personalizados do IAM.

  9. Selecione a guia para como planeja usar as amostras nesta página:

    Console

    Quando você usa o console Google Cloud para acessar serviços Google Cloud e APIs, 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.

    Terraform

    Para usar os exemplos do Terraform nesta página em um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e configure o Application Default Credentials com suas credenciais de usuário.

    1. Instale a CLI do Google Cloud.

    2. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

    3. Se você estiver usando um shell local, crie credenciais de autenticação local para sua conta de usuário:

      gcloud auth application-default login

      Não é necessário fazer isso se você estiver usando o Cloud Shell.

      Se um erro de autenticação for retornado e você estiver usando um provedor de identidade (IdP) externo, confirme se você fez login na CLI gcloud com sua identidade federada.

    Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento local na documentação de autenticação do Google Cloud .

    REST

    Para usar as amostras da API REST desta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para gcloud CLI.

      Instale a CLI do Google Cloud.

      Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

    Saiba mais em Autenticar para usar REST na documentação de autenticação do Google Cloud .

Listar escopos de trace

Console

Para listar os escopos de rastreamento, faça o seguinte:

  1. No Google Cloud console, acesse a página  Configurações:

    Acessar Configurações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  3. Selecione a guia Escopos de rastreamento.

    A janela mostra uma lista dos seus escopos de rastreamento. A entrada que inclui um ícone "Padrão", , é o escopo de rastreamento padrão.

  4. Para conferir os detalhes de um escopo de rastreamento, expanda-o.

    Se você expandir um escopo de rastreamento, poderá ver a lista de visualizações que ele inclui. Cada linha lista um ID do projeto com uma entrada como _Trace/Spans/_AllSpans, que identifica o local de armazenamento padrão dos dados de rastreamento. Os campos _Trace, Spans e _AllSpans se referem ao bucket, ao conjunto de dados e à visualização de observabilidade dos seus dados de rastreamento. A visualização _AllSpans corresponde a todas as entradas no bucket:

    Nome Descrição Tipo Recursos
    _Default Trace scope 1
    myscope My description Trace scope 2
      _Trace/Spans/_AllSpans myproject Trace view
      _Trace/Spans/_AllSpans project-b Trace view

gcloud

Antes de usar os dados do comando abaixo, faça estas substituições:

  • LOCATION: o local do escopo de rastreamento. Esse campo precisa ter um valor de global.
  • PROJECT_ID: o identificador do projeto.

Execute o comando gcloud observability trace-scopes list:

Linux, macOS ou Cloud Shell

gcloud observability trace-scopes list \
 --location=LOCATION --project=PROJECT_ID

Windows (PowerShell)

gcloud observability trace-scopes list `
 --location=LOCATION --project=PROJECT_ID

Windows (cmd.exe)

gcloud observability trace-scopes list ^
 --location=LOCATION --project=PROJECT_ID

Os dados de resposta são uma lista de escopos de rastreamento. Para cada escopo, o nome e as informações relevantes são mostrados. Por exemplo, o seguinte ilustra o resultado do comando list para um projeto com dois escopos de rastreamento:

name: projects/my-project/locations/global/traceScopes/_Default
resourceNames:
- projects/my-project
---
createTime: '2026-03-26T13:43:54.772326947Z'
description: a test
name: projects/my-project/locations/global/traceScopes/my-test-scope
resourceNames:
- projects/another-project
- projects/my-project
updateTime: '2026-03-26T13:43:54.772326947Z'

Terraform

É possível usar o Terraform para criar e modificar um escopo de rastreamento. No entanto, não é possível usar o Terraform para listar escopos de rastreamento.

REST

Para listar todos os escopos de rastreamento em um projeto Google Cloud , use o comando projects.locations.traceScopes.list. É necessário especificar um parâmetro de caminho.

O parâmetro de caminho para esse endpoint tem a seguinte sintaxe:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes

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

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • LOCATION_ID precisa ser definido como global.

A resposta é uma matriz de objetos TraceScope. Cada objeto inclui um nome e uma lista de recursos.

Para informações sobre um escopo de rastreamento específico, use o comando projects.locations.traceScopes.get.

Criar um escopo de rastreamento

Os intervalos mostrados na página do Explorador de trace dependem das visualizações pesquisadas, dos seus papéis do IAM nessas visualizações, da configuração de período e dos filtros aplicados.

É possível criar 100 escopos de rastreamento por projeto. Um escopo de trace pode incluir um total de 20 visualizações.

Console

Para criar um escopo de rastreamento, faça o seguinte:

  1. No Google Cloud console, acesse a página  Configurações:

    Acessar Configurações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  3. Selecione a guia Escopos de rastreamento e clique em Criar escopo de rastreamento.
  4. Clique em Adicionar projetos e preencha a caixa de diálogo.

  5. Na seção Nome do escopo de rastreamento, insira o nome e a descrição que você quer que apareçam na guia Escopos de rastreamento.

    O nome de um escopo de rastreamento não pode ser modificado e precisa ser exclusivo no projeto.

  6. Clique em Criar escopo de rastreamento.

    Por padrão, a tabela Escopos de rastreamento lista seus escopos de rastreamento de forma recolhida. Para cada escopo, a tabela lista um nome, uma descrição, um tipo e um número de recursos.

    Se você expandir um escopo de rastreamento, poderá ver a lista de visualizações que ele inclui. Cada linha lista um ID do projeto com uma entrada como _Trace/Spans/_AllSpans, que identifica o local de armazenamento padrão dos dados de rastreamento. Os campos _Trace, Spans e _AllSpans se referem ao bucket, conjunto de dados e visualização de observabilidade dos seus dados de rastreamento. A visualização _AllSpans corresponde a todas as entradas no bucket:

    Nome Descrição Tipo Recursos
    _Default Trace scope 1
    myscope My description Trace scope 2
      _Trace/Spans/_AllSpans myproject Trace view
      _Trace/Spans/_AllSpans project-b Trace view

gcloud

Antes de usar os dados do comando abaixo, faça estas substituições:

  • TRACE_SCOPE_NAME: o nome de um escopo de rastreamento. Por exemplo, my-trace-scope.
  • DESCRIPTION: opcional. A descrição do escopo do trace. Formate a descrição como uma string.
  • RESOURCE_NAMES: uma lista separada por vírgulas dos nomes totalmente qualificados dos projetos. Por exemplo, projects/my-project.
  • LOCATION: o local do escopo de rastreamento. Esse campo precisa ter um valor de global.
  • PROJECT_ID: o identificador do projeto.

Execute o comando gcloud observability trace-scopes create:

Linux, macOS ou Cloud Shell

gcloud observability trace-scopes create TRACE_SCOPE_NAME \
 --description=DESCRIPTION \
 --resource-names=RESOURCE_NAMES \
 --location=LOCATION --project=PROJECT_ID

Windows (PowerShell)

gcloud observability trace-scopes create TRACE_SCOPE_NAME `
 --description=DESCRIPTION `
 --resource-names=RESOURCE_NAMES `
 --location=LOCATION --project=PROJECT_ID

Windows (cmd.exe)

gcloud observability trace-scopes create TRACE_SCOPE_NAME ^
 --description=DESCRIPTION ^
 --resource-names=RESOURCE_NAMES ^
 --location=LOCATION --project=PROJECT_ID

Quando bem-sucedida, a resposta do comando create inclui o nome do novo escopo de rastreamento:

Created traceScope [my-test-scope].

Terraform

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform. Para mais informações, consulte a documentação de referência do provedor do Terraform.

Para criar um escopo de rastreamento em um projeto usando o Terraform, use o recurso google_observability_trace_scope.

No comando, defina os seguintes campos:

  • project: o nome do projeto, da pasta ou da organização. Por exemplo, my-project. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

  • trace_scope_id: defina como um ID de escopo. Por exemplo, my-trace-scope.

  • Defina location como "global".

  • resource_names: uma matriz de projetos, em que cada projeto é especificado usando o nome totalmente qualificado.

  • description: uma breve descrição. Por exemplo, "Escopo para recursos de produção".

REST

Para criar um escopo de rastreamento, use o comando projects.locations.traceScopes.create. É necessário especificar um parâmetro de caminho e fornecer um objeto TraceScope. A resposta é um objeto TraceScope.

O parâmetro de caminho para esse endpoint tem a seguinte sintaxe:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes

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

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • LOCATION_ID precisa ser definido como global.

Modificar um escopo de trace

Não é possível modificar o escopo de rastreamento chamado _Default. É possível modificar todos os outros escopos de rastreamento.

Console

Para modificar um escopo de rastreamento, faça o seguinte:

  1. No Google Cloud console, acesse a página  Configurações:

    Acessar Configurações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  3. Selecione a guia Escopos de rastreamento.
  4. Encontre o escopo de rastreamento que você quer modificar, clique em  Mais, selecione Editar escopo e conclua a caixa de diálogo.

gcloud

Antes de usar os dados do comando abaixo, faça estas substituições:

  • TRACE_SCOPE_NAME: o nome de um escopo de rastreamento. Por exemplo, my-trace-scope.
  • DESCRIPTION: opcional. A descrição do escopo do trace. Formate a descrição como uma string.
  • RESOURCE_NAMES: uma lista separada por vírgulas dos nomes totalmente qualificados dos projetos. Por exemplo, projects/my-project.
  • LOCATION: o local do escopo de rastreamento. Esse campo precisa ter um valor de global.
  • PROJECT_ID: o identificador do projeto.

Execute o comando gcloud observability trace-scopes update:

Linux, macOS ou Cloud Shell

gcloud observability trace-scopes update TRACE_SCOPE_NAME \
 --description=DESCRIPTION \
 --resource-names=RESOURCE_NAMES \
 --location=LOCATION --project=PROJECT_ID

Windows (PowerShell)

gcloud observability trace-scopes update TRACE_SCOPE_NAME `
 --description=DESCRIPTION `
 --resource-names=RESOURCE_NAMES `
 --location=LOCATION --project=PROJECT_ID

Windows (cmd.exe)

gcloud observability trace-scopes update TRACE_SCOPE_NAME ^
 --description=DESCRIPTION ^
 --resource-names=RESOURCE_NAMES ^
 --location=LOCATION --project=PROJECT_ID

Quando bem-sucedidos, os dados de resposta de um comando update mostram o escopo de rastreamento atualizado:

Updated traceScope [my-test-scope].
createTime: '2026-03-26T13:43:54.772326947Z'
description: A scope for testing
name: projects/my-project/locations/global/traceScopes/my-test-scope
resourceNames:
- projects/another-project
- projects/my-project
updateTime: '2026-03-26T13:48:05.262142872Z'

Terraform

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform. Para mais informações, consulte a documentação de referência do provedor do Terraform.

Para modificar um escopo de rastreamento em um projeto usando o Terraform, use o recurso google_observability_trace_scope.

REST

Para modificar um escopo de rastreamento, use o comando projects.locations.traceScopes.patch. É necessário especificar um parâmetro de caminho, parâmetros de consulta e fornecer um objeto TraceScope. Os parâmetros de consulta identificam quais campos foram alterados. A resposta é um objeto TraceScope.

O parâmetro de caminho para esse endpoint tem a seguinte sintaxe:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes/TRACE_SCOPE_NAME

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

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • LOCATION_ID precisa ser definido como global.
  • TRACE_SCOPE_NAME: o nome de um escopo de rastreamento. Por exemplo, my-trace-scope.

Excluir um escopo de trace

Não é possível excluir o escopo de rastreamento chamado _Default. Você pode excluir todos os outros escopos de rastreamento.

Console

Para excluir um escopo de rastreamento, faça o seguinte:

  1. No Google Cloud console, acesse a página  Configurações:

    Acessar Configurações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  3. Selecione a guia Escopos de rastreamento.
  4. Encontre o escopo de rastreamento que você quer excluir, clique em  Mais, selecione Excluir escopo e conclua a caixa de diálogo.

gcloud

Antes de usar os dados do comando abaixo, faça estas substituições:

  • TRACE_SCOPE_NAME: o nome de um escopo de rastreamento. Por exemplo, my-trace-scope.
  • LOCATION: o local do escopo de rastreamento. Esse campo precisa ter um valor de global.
  • PROJECT_ID: o identificador do projeto.

Execute o comando gcloud observability trace-scopes delete:

Linux, macOS ou Cloud Shell

gcloud observability trace-scopes delete TRACE_SCOPE_NAME \
 --location=LOCATION --project=PROJECT_ID

Windows (PowerShell)

gcloud observability trace-scopes delete TRACE_SCOPE_NAME `
 --location=LOCATION --project=PROJECT_ID

Windows (cmd.exe)

gcloud observability trace-scopes delete TRACE_SCOPE_NAME ^
 --location=LOCATION --project=PROJECT_ID

Se você emitir um comando delete, será necessário confirmar a ação. Confira um exemplo de execução:

You are about to delete traceScope [my-test-scope]

Do you want to continue (Y/n)?  Y

Deleted traceScope [my-test-scope].

Terraform

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform. Para mais informações, consulte a documentação de referência do provedor do Terraform.

Para excluir um escopo de rastreamento em um projeto usando o Terraform, use o recurso google_observability_trace_scope.

REST

Para excluir um escopo de rastreamento, use o comando projects.locations.traceScopes.delete. É necessário especificar um parâmetro de caminho.

O parâmetro de caminho para esse endpoint tem a seguinte sintaxe:

projects/PROJECT_ID/locations/LOCATION_ID/traceScopes/TRACE_SCOPE_NAME

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

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • LOCATION_ID precisa ser definido como global.
  • TRACE_SCOPE_NAME: o nome de um escopo de rastreamento. Por exemplo, my-trace-scope.

Configurar o escopo de rastreamento padrão

Quando a página Explorador de traces é aberta, ela pesquisa os dados de trace nas visualizações listadas no escopo de trace padrão. Se esse escopo de rastreamento não estiver acessível, a página Explorador de rastreamento consultará a visualização _AllSpans do projeto no conjunto de dados padrão.

Quando os projetos são criados, o escopo de rastreamento chamado _Default é criado e designado como o escopo de rastreamento padrão. No entanto, é possível criar seu próprio escopo de rastreamento e designá-lo como o padrão.

Console

Para definir o escopo de rastreamento padrão, faça o seguinte:

  1. No Google Cloud console, acesse a página  Configurações:

    Acessar Configurações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  3. Selecione a guia Escopos de rastreamento.

    A guia mostra seus escopos de rastreamento e inclui um botão para criar um escopo de rastreamento personalizado. O escopo de rastreamento mostrado com um ícone "Padrão", , é o escopo de rastreamento padrão atual.

  4. Para mudar o escopo de rastreamento padrão, encontre o escopo que você quer designar como padrão, clique em  Mais e selecione Definir como padrão.

    O escopo de rastreamento selecionado é mostrado com um ícone "Padrão", .

gcloud

Para conferir e atualizar o escopo de observabilidade, faça o seguinte:

  1. Para conferir as configurações do escopo de observabilidade, execute o comando gcloud observability scopes describe.

    Antes de usar os dados do comando abaixo, faça estas substituições:

    • OBSERVABILITY_SCOPE_ID: o nome de um objeto Scope. Esse valor precisa ser definido como _Default.
    • LOCATION: o campo de local precisa ser definido como global.
    • PROJECT_ID: o identificador do projeto.

    Execute o comando gcloud observability scopes describe:

    Linux, macOS ou Cloud Shell

    gcloud observability scopes describe OBSERVABILITY_SCOPE_ID \
       --location=LOCATION\
       --project=PROJECT_ID

    Windows (PowerShell)

    gcloud observability scopes describe OBSERVABILITY_SCOPE_ID `
       --location=LOCATION`
       --project=PROJECT_ID

    Windows (cmd.exe)

    gcloud observability scopes describe OBSERVABILITY_SCOPE_ID ^
       --location=LOCATION^
       --project=PROJECT_ID

    A resposta ao comando é semelhante a esta:

    logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default
    traceScope: projects/my-project/locations/global/traceScopes/_Default
    name: projects/my-project/locations/global/scopes/_Default
    
  2. Para atualizar o escopo de observabilidade, execute o comando gcloud observability scopes update. No comando update, é possível incluir a flag --log-scope, a flag --trace-scope ou ambas.

    Antes de usar os dados do comando abaixo, faça estas substituições:

    • OBSERVABILITY_SCOPE_ID: o nome de um objeto Scope. Esse valor precisa ser definido como _Default.
    • LOG_SCOPE_FQN_ID: o nome totalmente qualificado do recurso do escopo de registro. Esse campo tem o seguinte formato:
      logging.googleapis.com/projects/PROJECT_ID/locations/LOCATION/logScopes/LOG_SCOPE_ID

      Na expressão anterior, LOG_SCOPE_ID é o ID do escopo do registro. Por exemplo, my-scope.

    • TRACE_SCOPE_FQN_ID: o nome totalmente qualificado do recurso do escopo de rastreamento. Esse campo tem o seguinte formato:
      projects/PROJECT_ID/locations/LOCATION/traceScopes/TRACE_SCOPE_NAME

      Na expressão anterior, TRACE_SCOPE_NAME é o nome do escopo de rastreamento. Por exemplo, my-trace-scope.

    • LOCATION: o campo de local precisa ser definido como global.
    • PROJECT_ID: o identificador do projeto.

    Execute o comando gcloud observability scopes update:

    Linux, macOS ou Cloud Shell

    gcloud observability scopes update OBSERVABILITY_SCOPE_ID \
       --log-scope=LOG_SCOPE_FQN_ID\
       --trace-scope=TRACE_SCOPE_FQN_ID\
       --location=LOCATION\
       --project=PROJECT_ID

    Windows (PowerShell)

    gcloud observability scopes update OBSERVABILITY_SCOPE_ID `
       --log-scope=LOG_SCOPE_FQN_ID`
       --trace-scope=TRACE_SCOPE_FQN_ID`
       --location=LOCATION`
       --project=PROJECT_ID

    Windows (cmd.exe)

    gcloud observability scopes update OBSERVABILITY_SCOPE_ID ^
       --log-scope=LOG_SCOPE_FQN_ID^
       --trace-scope=TRACE_SCOPE_FQN_ID^
       --location=LOCATION^
       --project=PROJECT_ID

    Por exemplo, se o valor de LOG_SCOPE_ID for my-log-scope e o valor de TRACE_SCOPE_NAME for my-trace-scope, a resposta será semelhante a esta:

    Updated scope [_Default].
    logScope: logging.googleapis.com/projects/my-project/locations/global/logScopes/my-log-scope
    traceScope: projects/my-project/locations/global/traceScopes/my-trace-scope
    name: projects/my-project/locations/global/scopes/_Default
    

Terraform

É possível usar o Terraform para criar e modificar um escopo de rastreamento. No entanto, não é possível usar o Terraform para definir o escopo de rastreamento padrão.

REST

Para receber e definir o escopo de registro ou de rastreamento padrão usando uma chamada de API, configure o escopo de observabilidade. O escopo de observabilidade lista o escopo de registro e o escopo de rastreamento padrão:

  • Para receber o escopo de observabilidade padrão de um projeto, envie uma solicitação ao endpoint projects.locations.scopes.get. É necessário especificar um parâmetro de caminho. A resposta é um objeto Scope que lista o escopo do registro padrão e o escopo de rastreamento padrão.
  • Para atualizar o escopo de observabilidade padrão de um projeto, envie uma solicitação ao endpoint projects.locations.scopes.patch. É necessário especificar um parâmetro de caminho, parâmetros de consulta e fornecer um objeto Scope. Os parâmetros de consulta identificam quais campos foram alterados. A resposta é um objeto Scope.

O parâmetro de caminho para ambos os endpoints tem o seguinte formato:

projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID

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

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • LOCATION: o campo de local precisa ser definido como global.
  • OBSERVABILITY_SCOPE_ID: o nome de um objeto Scope. Esse campo precisa ser definido como _Default. O objeto Scope com o nome _Default, que é criado automaticamente, armazena informações sobre o escopo de registro e o escopo de rastreamento padrão.

Para enviar um comando a um endpoint de API, use o APIs Explorer, que permite emitir um comando em uma página de referência. Por exemplo, para receber o escopo padrão atual, faça o seguinte:

  1. Clique em projects.locations.scopes.get.
  2. No widget Testar este método, insira o seguinte no campo name:
        projects/PROJECT_ID/locations/global/scopes/_Default
        

    Antes de copiar o campo anterior, substitua PROJECT_ID pelo nome do seu projeto.

  3. Selecione Executar.
  4. Na caixa de diálogo de autorização, conclua as etapas necessárias.

    O resultado parecido com este:

        {
        "name": "projects/my-project/locations/global/scopes/_Default",
        "logScope": "logging.googleapis.com/projects/my-project/locations/global/logScopes/_Default"
        "traceScope": "projects/my-project/locations/global/traceScopes/_Default"
        }
        

Limites nos escopos de trace

Limites nos escopos de trace Valor
Número máximo de escopos de rastreamento por projeto 100
Número máximo de visualizações por escopo de rastreamento 20

A seguir