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 apenas monitorar ou visualizar 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. Um escopo define os recursos que são pesquisados para um tipo específico de dados. Com exceção dos dados de métricas, seus papéis de gerenciamento de identidade e acesso (IAM) nos projetos pesquisados e nas visualizações de registro determinam quais dados são exibidos.

É possível configurar os seguintes escopos:

Escopo de observabilidade

Esse escopo controla como as páginas do explorador e do painel procuram os dados a serem exibidos. Cada projeto do Google Cloud contém um único escopo de observabilidade, que lista o escopo de registro padrão, o escopo de métricas e o escopo de rastreamento padrão.

Recomendamos configurar os componentes do escopo de observabilidade nos seguintes cenários:

  • Você registra aplicativos no App Hub. Podem ser aplicativos que você mesmo registrou ou os implantados usando a Central de design de aplicativos.
  • Quando você quer uma visualização unificada dos dados de telemetria armazenados em diferentes projetos do Google Cloud.

Se você não configurar os componentes do escopo de observabilidade de um projeto, a página Logs Explorer vai mostrar os dados de registro que se originam no projeto. As páginas Metrics Explorer e Trace Explorer só podem mostrar dados armazenados no projeto. Além disso, as políticas de alerta só podem monitorar dados armazenados no projeto.

Escopos de registros

Configure o escopo de registro padrão de um projeto para que, quando você abrir a página Logs Explorer, os dados que você normalmente quer visualizar sejam mostrados. Um escopo de registro pode listar projetos, pastas, organizações e visualizações de registro. Por exemplo, você pode definir o escopo de registro padrão para listar uma visualização de registro, que, quando consultada, retorna os dados de registro de um aplicativo do App Hub.

É possível criar vários escopos de registro. Ao usar a página Análise de registros, é possível selecionar um escopo de registro diferente, o que faz com que a página pesquise os recursos listados no escopo selecionado e atualize a exibição.

Recomendamos configurar o escopo de registro padrão nos seguintes cenários:

  • Você encaminha os dados de registro para um bucket de registros centralizado.
  • Você encaminha dados de registro para outros projetos ou para buckets de registro armazenados por outro projeto.
  • Você usa visualizações de registro.

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

Escopo de métricas

Configure o escopo de métricas para listar todos os projetos que armazenam dados de métricas, para que os gráficos e as políticas de alerta possam mostrar ou monitorar uma visualização agregada dos dados de métricas.

Cada projeto do Google Cloud contém um único escopo de métricas, e esse escopo é definido como "Listar apenas o projeto" por padrão.

Recomendamos configurar o escopo de métricas quando uma das seguintes condições for verdadeira:

  • Você quer criar um gráfico com dados armazenados em projetos diferentes.
  • Você quer uma política de alertas para monitorar dados armazenados em projetos diferentes.
  • Você registra aplicativos no App Hub. Para mais informações sobre esse cenário, consulte Escopos de métricas para projetos de gerenciamento.

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

Escopos de trace

Configure o escopo de trace padrão para listar todos os projetos que armazenam dados de trace. Assim, quando você abrir a página Trace Explorer, terá uma visualização agregada dos dados de trace.

É possível criar vários escopos de rastreamento. Ao usar a página Trace Explorer, você pode selecionar um escopo de trace diferente, o que faz com que a página pesquise os projetos listados no escopo selecionado e atualize a exibição.

Recomendamos configurar os escopos de rastreamento quando você quiser uma visão unificada dos dados de rastreamento armazenados em projetos diferentes.

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

Antes de começar

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.

Configurar o escopo de observabilidade

Esta seção não se aplica a pastas ou organizações.

Se você não configurar os componentes do escopo de observabilidade de um projeto, a página Logs Explorer vai mostrar os dados de registro que se originam no projeto. As páginas Metrics Explorer e Trace Explorer só podem mostrar dados armazenados no projeto. Além disso, as políticas de alerta só podem monitorar dados armazenados no seu projeto.

Para dados de registro e rastreamento, suas funções de gerenciamento de identidade e acesso (IAM) no projeto que você está visualizando e todos os projetos pesquisados e visualizações de registro determinam quais dados são exibidos. Seu papel do IAM no projeto que você está visualizando determina se você pode acessar os dados de métricas.

Console

Para configurar o escopo de observabilidade, você configura os componentes, que são o escopo de registro padrão, o escopo de métricas e o escopo de rastreamento padrão:

  1. Enable the Observability API.

    Enable the API

    Antes de ativar a API, verifique se o projeto correto está selecionado. Para as configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta ativada por apps.

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

  3. Na barra de ferramentas do console do Google Cloud, selecione seu projeto. Para as configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta ativada por apps.

  4. Configure o escopo de registro padrão:

    1. Selecione a guia Log Scopes.

      Os escopos de registro atuais são listados. A entrada com o ícone "Padrão", , é o escopo de registro padrão. Se você quiser criar um escopo de registro, clique em Criar escopo de registro e conclua a caixa de diálogo. Para mais informações, consulte Criar e gerenciar escopos de registro.

    2. Encontre a entrada que você quer definir como padrão, clique em  Mais e selecione Definir como padrão.

  5. Configure o escopo das métricas:

    1. Selecione a guia "Escopo das métricas".
    2. No painel Google Cloud Projects, clique em Add Projects e preencha a caixa de diálogo. Para mais informações, consulte Configurar escopos de métricas.

  6. Configure o escopo de rastreamento padrão:

    1. Selecione a guia Trace Scopes e faça o seguinte:

      Os escopos de rastreamento atuais são listados. A entrada com o ícone "Padrão", , é o escopo de rastreamento padrão. Se você quiser criar um escopo de rastreamento, clique em Criar escopo de registro e conclua a caixa de diálogo. Para mais informações, consulte Criar e gerenciar escopos de rastreamento.

    2. Encontre a entrada que você quer definir como padrão, clique em  Mais e selecione Definir como padrão.

REST

Não há suporte para definir o escopo de rastreamento padrão.

Para usar a API Observability para receber ou definir o escopo de registro padrão, faça o seguinte:

  1. Verifique se a API Observability está ativada:

    1. After installing the Google Cloud CLI, initialize it by running the following command: 

      gcloud init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    2. Defina o projeto padrão para a Google Cloud CLI:

      gcloud config set project PROJECT_ID

      Antes de executar o comando anterior, substitua o seguinte:

      • PROJECT_ID: o identificador do projeto. Para as configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta ativada por apps.

    3. Enable the Observability API: 

      gcloud services enable observability.googleapis.com

  2. Escolha uma destas opções:

    • Para receber o escopo de registro padrão de um projeto, envie uma solicitação para o endpoint projects.locations.scopes.get. É necessário especificar um parâmetro de caminho. A resposta é um objeto Scope, que lista o escopo de registro padrão.

    • Para atualizar o escopo de registro padrão de um projeto, envie uma solicitação para o 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 são 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 as configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta ativada por apps.
      • 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 armazena informações sobre o escopo de registro padrão e é criado automaticamente.