Visão geral dos escopos de observabilidade

Este documento descreve como configurar um projeto do Google Cloud para monitorar ou exibir dados de telemetria de vários projetos do Google Cloud. Se você quiser monitorar ou visualizar apenas os dados armazenados em um projeto do Google Cloud, não será necessário fazer nenhuma configuração, porque as ferramentas de visualização e análise são configuradas para usar os dados armazenados no projeto do Google Cloud selecionado pelo seletor de projeto. No entanto, se os dados de telemetria que você quer visualizar ou analisar forem de vários projetos, para ter uma visualização agregada desses dados, será necessário realizar algumas atividades de configuração.

Sobre os escopos de observabilidade

As ferramentas de análise e visualização do Google Cloud Observability dependem de escopos específicos de tipo de dados para determinar quais dados serão mostrados ou analisados. Há dois escopos que você pode configurar: de registros e de métricas.

Escopos de registros

Lista os projetos, pastas, organizações e visualizações de registro cujos dados de registro podem ser lidos pela página Explorador de registros. Quando você cria um projeto, uma pasta ou uma organização, um escopo de registro chamado _Default também é criado e contém apenas o projeto, a pasta ou a organização que foi criada. Não é possível excluir esse escopo nem modificar a lista de recursos que ele contém.

É possível criar escopos de registro usando o console do Google Cloud e a API Cloud Logging. É possível adicionar projetos e exibições de registro a esses escopos.

Recomendamos que você configure os escopos de registro ao rotear registros para outros projetos, para buckets de registro em outro projeto ou ao usar visualizações de registro para controlar o acesso aos dados em um bucket de registro.

Para mais informações, consulte Criar e gerenciar escopos de registro.

Escopo de métricas

Lista os projetos do Google Cloud cujos dados de métrica podem ser lidos pelo projeto atual do Google Cloud. Gráficos, painéis e políticas de alerta consultam dados de métricas armazenados em todos os projetos listados no escopo de métricas. Por padrão, o escopo de métricas de um projeto lista apenas o projeto. No entanto, você pode adicionar outros projetos.

Cada projeto do Google Cloud contém um único escopo de métricas. É possível configurar esse escopo usando o console do Google Cloud, a CLI do Google Cloud ou a API Cloud Monitoring.

Se você quiser uma visualização combinada dos dados de métricas armazenados em vários projetos ou se quiser uma única política de alerta para monitorar dados armazenados em vários projetos, selecione um projeto e configure o escopo de métricas para incluir todos os projetos cujos dados você quer visualizar ou monitorar.

Para mais informações, consulte Visão geral dos escopos de métricas.

Escopos de trace

Lista os projetos cujos dados de trace podem ser lidos pela página Trace Explorer. Quando você cria um projeto, um escopo de rastreamento chamado _Default também é criado e contém apenas o projeto que foi criado. Não é possível excluir esse escopo nem modificar a lista de projetos que ele contém.

É possível criar e adicionar projetos a esses escopos usando o console do Google Cloud.

Recomendamos que você configure os escopos de rastreamento quando seus aplicativos gerarem dados de rastreamento em vários projetos, como pode ocorrer quando você tem uma arquitetura de microsserviços.

Para mais informações, consulte Criar e gerenciar escopos de rastreamento.

Um escopo define os recursos que são pesquisados para um tipo específico de dados. Seus papéis de gerenciamento de identidade e acesso (IAM) nesses recursos determinam quais dados são retornados. Por exemplo, um escopo de registro, que define os recursos que são pesquisados para dados de registro, não afeta os dados mostrados nos gráficos ou os dados mostrados pela página Trace Explorer. Além disso, se um escopo de registro listar uma visualização de registro à qual você não tem acesso, você não vai encontrar entradas de registro dessa visualização.

Escopo padrão

O escopo de registro padrão é o que a página Análise de registros usa para determinar quais recursos pesquisar em entradas de registro. Se a página Logs Explorer não conseguir identificar o escopo de registro padrão, ela vai pesquisar dados de registro no projeto atual.

Da mesma forma, o escopo de trace padrão é o que a página Explorador de trace usa para determinar quais recursos pesquisar.

Quando um projeto é criado, os escopos com o nome _Default são definidos como o escopo padrão para o tipo de dados. Portanto, se você não fizer nenhuma alteração de configuração no seu projeto do Google Cloud, quando navegar até as páginas do Explorer para esses tipos de dados, o projeto atual será pesquisado para encontrar dados.

É possível definir qual dos seus escopos de registro é o padrão. Da mesma forma, é possível definir qual dos seus escopos de trace é o padrão. Para mais informações, consulte Criar e gerenciar escopos de registro e Criar e gerenciar escopos de rastreamento.

Como há apenas um escopo de métricas por projeto do Google Cloud, ele é usado automaticamente para fins de criação de gráficos e monitoramento.

Para identificar o escopo de registro padrão, use o console do Google Cloud:

  1. No console do Google Cloud, abra 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 Monitoramento.

  2. Selecione a guia Escopos de registro e encontre o escopo de registro que tem o ícone "Padrão", .
  3. Selecione a guia Trace Scopes e encontre o escopo de rastreamento que tem o ícone "Default", .

Papéis e permissões

Para ter as permissões necessárias para criar e visualizar escopos, peça ao administrador para conceder a você os seguintes papéis do IAM:

  • Para criar e conferir os escopos de registro e receber o escopo de registro padrão: Gravador de configuração de registros (roles/logging.configWriter) no seu projeto
  • Para modificar um escopo de métricas: Administrador do Monitoring (roles/monitoring.admin) no seu projeto e em cada projeto que você quer adicionar aos escopos de métricas
  • Para criar e conferir os escopos de trace e receber o escopo de trace padrão: Usuário do Cloud Trace (roles/cloudtrace.user) no seu projeto
  • Para acessar e definir escopos padrão: Editor de Observabilidade (roles/observability.editor) no seu projeto

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para criar e visualizar escopos. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para criar e visualizar escopos:

  • Para configurar os escopos de registro: logging.logScopes.{create, delete, get, list, update}
  • Para configurar um escopo de métricas: monitoring.metricsscopes.{link, get, list}
  • Para configurar os escopos de rastreamento: cloudtrace.traceScopes.{create, delete, get, list, update}
  • Para receber e definir escopos padrão: observability.scopes.{get, update}

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.