Criar e gerenciar escopos de registro

Neste documento, descrevemos como criar e gerenciar escopos de registro, que você pode usar para encontrar com eficiência as entradas de registro que quer para visualizar ou analisar. Se você só quiser visualizar e analisar as entradas de registro que tiver origem em um projeto, pasta ou organização, então este documento não será para você. No entanto, se você depende coletores de registros para rotear os registros a eles outros projetos ou buckets de registros definidos pelo usuário, ou se você usa visualizações de registro, as informações neste documento podem ajudar você a encontrar entradas de registro específicas com eficiência.

Este documento não descreve como visualizar seus registros. Para informações sobre a esse tópico, consulte Veja os registros usando a Análise de registros.

Sobre os escopos de registro

Os escopos de registro são recursos persistentes para envolvidos no projeto que listam de recursos para pesquisar entradas de registro. Um escopo de registro pode incluir projetos, pastas, organizações e visualizações de registros. Por exemplo, é possível definir um escopo de registro que liste os projetos que contêm recursos usados para produção ou que liste as visualizações de registro que incluem entradas de registro para um tipo de recurso específico.

Ao criar um projeto, uma pasta ou um recurso da organização do Google Cloud, O Logging cria um escopo de registro chamado _Default. Esse escopo inclui o projeto, a pasta ou a organização que foi criado. Os resultados de uma pesquisa desses recursos incluem as entradas de registro que se originam no recurso e são armazenados em um bucket de registros. Para projetos, os resultados da pesquisa também incluem entradas de registro que são roteadas para o projeto por um coletor em outro projeto e armazenadas em um bucket de registro.

É possível criar escopos de registro. Você também pode editar e excluir os escopos de registro criados. No entanto, não é possível editar ou excluir o escopo de registro _Default.

Para projetos, o escopo de registro padrão determina o conjunto de recursos que a página Análise de registros pesquisa quando é aberta. No entanto, seus papéis de gerenciamento de identidade e acesso (IAM) nos recursos pesquisados e a configuração do período determinam quais entradas de registro são extraídas do armazenamento. Quando os projetos são criados, o escopo do registro _Default é designado como escopo de registro padrão. É possível definir qual escopo de registro escopo de registro padrão.

Práticas recomendadas

Os escopos de registro permitem definir e salvar configuração para uso futuro, recomendamos que você e criar escopos de registro para configurações de pesquisa complexas.

Por exemplo, suponha que você esteja solucionando um problema e queira visualizar os para todas as instâncias de máquina virtual (VM) da sua equipe. Para realizar essa tarefa, faça o seguinte:

  1. Você determina que as entradas de registro que quer visualizar são armazenadas vários buckets de registros e em diversos projetos. Na maioria dos buckets de registros, há uma visualização de registros que inclui as entradas que você quer analisar. É possível criar uma visualização de registros nos casos em que ela não existe.

  2. Você decide criar um escopo de registro porque espera ter uma tarefa de solução de problemas semelhante no futuro.

  3. Abra a página Análise de registros no console do Google Cloud e use o menu Refine scope para selecionar o novo escopo de registro.

  4. Você analisa as entradas de registro e encontra as informações necessárias para resolver o problema que estava investigando.

  5. Depois de resolver o problema, você compartilha a causa da falha com seus colegas. Você também informou que espera ver falhas semelhantes no futuro, então você criou um escopo de registro que vai permitir que você ou qualquer pessoa investigar a falha, encontrar rapidamente as entradas de registro relevantes.

Limitações

  • Não é possível excluir ou modificar o escopo de registro chamado _Default.
  • Somente projetos do Google Cloud aceitam um escopo de registro padrão.
  • Não é possível adicionar pastas ou organizações a um escopo de registro definido pelo usuário.
  • Não há suporte para a API Cloud Logging ou a Google Cloud CLI para criar ou para gerenciar escopos de registro.

Antes de começar

Para ter as permissões necessárias para criar e acessar escopos de registro e definir o escopo padrão, faça o seguinte: peça ao administrador para conceder a você os seguintes papéis do IAM:

  • Para criar e conferir os escopos de registro ou receber o escopo de registro padrão: Gravador de configuração de registros (roles/logging.configWriter) no projeto, na pasta ou na organização
  • Para definir o escopo de registro padrão: Editor de observabilidade (roles/observability.editor) no seu projeto, pasta ou organização

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 têm as permissões necessárias para criar e visualizar escopos de registro e para definir o escopo de registro padrão. 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 ver escopos de registro e para definir o escopo de registro padrão:

  • Para receber e definir o escopo de registro padrão: observability.scopes.[get, update]

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

Listar escopos do registro

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

  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 do registro.

    A tabela lista os escopos do registro. Depois de selecionar um projeto do Google Cloud, uma entrada na tabela é anotada com um ícone rotulado Default, que indica do registro lista os recursos que a Análise de registros pesquisa quando essa página é aberta.

Definir o escopo do registro padrão

O escopo de registro padrão lista os recursos pesquisados pelo Análise de registros quando ela for aberta. Se um o escopo de registro padrão não existir ou não estiver acessível, essa página procura automaticamente entradas de registro originadas no projeto, pasta ou organização selecionada. As entradas de registro exibidas pela página Logs Explorer dependem dos recursos pesquisados, da configuração do período e das suas funções do IAM nos recursos pesquisados.

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

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

  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 do registro.
  3. Encontre o escopo de registro que você quer designar como escopo de registro padrão, clique em  Mais, e selecione Definir como padrão.

    O escopo do registro selecionado é anotado com um ícone rotulado Default:

Criar um escopo de registro

É possível criar 100 escopos de registro por projeto. Um escopo de registro pode incluir um total de 100 visualizações de registro e projetos. No entanto, ele só pode incluir 50 projetos. Não é possível adicionar pastas ou organizações a um escopo de registro.

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

  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 do registro e clique em Criar escopo do registro.
  3. Para adicionar um ou mais projetos, clique em Adicionar projetos e conclua as caixa de diálogo.

    Depois de adicionar um projeto, os papéis do IAM nele determinar quais entradas de registro podem ser exibidas. Por exemplo, seu o papel do IAM permite que você visualize apenas as entradas de registro são acessíveis por uma visualização de registro específica em um bucket de registros. Para mais informações sobre papéis, consulte Registro de papéis.

  4. Para adicionar uma ou mais visualizações de registro, clique em Adicionar visualizações de registro e preencha a caixa de diálogo.

    A caixa de diálogo lista todas as visualizações de registro que têm entradas de registro projeto atual, ou que foram encaminhados para o projeto atual por um se afundar em outro projeto. Por exemplo, se você não tiver configurado coletores, a caixa de diálogo listará as visualizações de registro do projeto atual.

    Para listar as visualizações de registro armazenadas em outro projeto do Google Cloud, clique em  Import project e selecione o projeto do Google Cloud.

    Depois de adicionar uma visualização de registros, seus papéis do IAM na uma visualização de registro ou o projeto que a armazena determinar quais entradas de registro podem ser acessadas. Para mais informações, consulte Controlar o acesso a uma visualização de registro.

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

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

  6. Clique em Aplicar.

Modificar ou excluir um escopo de registro

Para modificar ou excluir um escopo de registro criado por você ou por um colega, faça o seguinte:

  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 do registro.
  3. Encontre os escopos de registro que você quer modificar ou excluir. Clique em  Mais e execute uma das seguintes ações:

    • Para fazer mudanças, selecione Editar escopo e preencha a caixa de diálogo.
    • Para excluir, selecione Excluir escopo e preencha a caixa de diálogo.

A seguir