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ê usa coletores de registros para rotear registros para outros projetos ou para buckets de registro definidos pelo usuário, ou se você usa visualizações de registro, as informações neste documento podem ajudar a encontrar entradas de registro específicas de maneira eficiente.

Este documento não descreve como acessar os registros. Para saber mais sobre esse assunto, consulte Conferir registros usando o Explorador de registros.

Sobre os escopos de registro

Os escopos de registro são recursos persistentes do projeto que listam um conjunto de recursos. Esses recursos podem ser 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 criada. Quando o recurso pesquisado é um projeto, uma pasta ou uma organização do Google Cloud, os resultados incluem as entradas de registro que se originam no recurso e são armazenadas em um bucket de registro. Quando um projeto é pesquisado, os resultados 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. Também é possível editar e excluir os escopos de registro criados. No entanto, não é possível editar ou excluir o escopo de registro _Default.

Use um escopo de registro para controlar quais recursos A página Análise de registros procura dados de registro. Quando você abre essa página e seleciona um escopo de registro, ela pesquisa os recursos listados nesse escopo e atualiza a exibição.

Também é possível usar um escopo de registro para controlar quais recursos um painel de registros procura dados de registro. Um painel de registros é um widget de painel personalizado que exibe dados de registro. Cada painel de registros tem a própria padrão, que permite criar um painel com várias painéis de registros, em que cada painel exibe dados de registro diferentes. Para mais informações, consulte Exibir registros e erros em um painel personalizado.

Para projetos, o escopo de registro padrão determina o conjunto de recursos que a página Análise de registros pesquisa ao abrir. 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 de registro _Default é designado como escopo de registro padrão. É possível definir qual escopo de registro escopo de registro padrão.

Práticas recomendadas

Como os escopos de registro oferecem uma maneira de definir e salvar uma configuração para uso futuro, recomendamos que você crie 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 você quer acessar estão armazenadas em vários buckets de registro e em vários projetos. Para a maioria dos buckets de registro, existe uma visualização de registro que inclui as entradas de registro 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 Refinar escopo para selecionar seu 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 encontrar 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 oferecem suporte a 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 Google Cloud CLI para criar ou para gerenciar escopos de registro.
  • Os escopos de registro são criados no local global.

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 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 permissões a seguir são necessárias para criar e visualizar escopos de registro e 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 de registro

Console

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 Log Scopes.

    A tabela lista os escopos do registro. Quando você seleciona um projeto do Google Cloud, uma entrada na tabela é mostrada com um ícone "Padrão", , que indica que esse escopo de registro lista os recursos que o Logs Explorer procura quando essa página é aberta.

Terraform

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

API

A API Cloud Logging contém comandos que listam os escopos de registro em um recurso ou que informam os detalhes de um escopo de registro específico. Para uma lista completa de comandos, consulte a documentação de referência da API.

Para projetos do Google Cloud, use os seguintes comandos:

No comando da API, defina o campo locations como global.

Definir o escopo de registro padrão

O escopo de registro padrão lista os recursos pesquisados pela página Análise de registros quando ela é 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 intervalo de tempo e das suas funções do IAM nos recursos pesquisados.

Quando os projetos são criados, o escopo de registro chamado _Default é criado e designado como o escopo de registro padrão. No entanto, você pode criar seu próprio escopo de registro e designá-lo como o escopo de registro padrão.

Console

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 padrão, clique em Mais e selecione Definir como padrão.

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

Terraform

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

API

Incompatível.

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.

Console

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, suas funções do IAM nesse projeto determinam quais entradas de registro você pode visualizar. 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 Papéis do Logging.

  4. Para adicionar uma ou mais visualizações de registros, clique em Adicionar visualizações de registros e conclua as 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 nenhum coletor, essa caixa de diálogo vai listar as visualizações de registro no seu projeto atual.

    Para listar as visualizações de registros armazenadas em outro projeto do Google Cloud, faça o seguinte: Clique em  Importar projeto e selecione no 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 Nome do escopo do registro, digite o nome e a descrição que você aparecer na guia Escopos do registro.

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

  6. Clique em Criar escopo do registro.

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

Para criar um escopo de registro em um projeto, pasta ou organização usando o Terraform, use o recurso google_logging_log_scope do Terraform.

No comando, defina os seguintes campos:

  • parent: o nome completo do projeto, da pasta ou da organização. Por exemplo, defina esse campo como "projects/PROJECT_ID", em que PROJECT_ID é o ID do seu projeto do Google Cloud.
  • Defina locations como "global".

  • name: definido como o nome totalmente qualificado do escopo do registro. Para projetos, o formato desse campo é:

    "projects/PROJECT_ID/locations/global/logScopes/LOG_SCOPE"

    Na expressão anterior, LOG_SCOPE é o nome de um escopo de registro, como "produção".

  • resource_names: uma matriz de projetos e visualizações de registro, em que cada projeto e visualização de registro é especificado usando o nome totalmente qualificado.

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

API

A API Cloud Logging também permite criar escopos de registro em uma pasta ou organização. Para mais informações, consulte a documentação de referência da API.

Para projetos do Google Cloud, use o seguinte comando:

No comando da API, defina o campo locations como global.

Modificar ou excluir um escopo de registro

Console

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 Log Scopes.

  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.

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

Para modificar um escopo de registro em um projeto, pasta ou organização usando o Terraform, use o recurso google_logging_log_scope do Terraform.

API

A API Cloud Logging contém comandos que podem modificar ou excluir uma escopo de registro. Para uma lista completa de comandos, consulte a documentação de referência da API.

Para projetos do Google Cloud, use os seguintes comandos:

No comando da API, defina o campo locations como global.

A seguir