Configurar buckets de registros

Este documento descreve como criar e gerenciar buckets do Cloud Logging usando o console do Google Cloud, a Google Cloud CLI e a API Logging. Ele também fornece instruções para criar e gerenciar buckets de registro no nível do projeto do Google Cloud. Não é possível criar buckets de registro no nível da pasta ou da organização. No entanto, o Cloud Logging cria automaticamente os buckets de registro _Default e _Required no nível da pasta e da organização para você.

É possível fazer upgrade dos buckets de registros para usar a Análise de dados de registros. A Análise de dados de registros permite executar consultas SQL nos dados de registro, ajudando você a resolver problemas de aplicativo, segurança e rede.

Para usar o BigQuery para analisar seus dados de registro, você tem duas opções:

  • Faça upgrade de um bucket de registros para usar a Análise de dados de registros e crie um conjunto de dados vinculado do BigQuery. Nesse cenário, o Logging armazena seus dados de registro, mas o BigQuery pode ler esses dados.

  • Exporte as entradas de registro para o BigQuery. Nesse cenário, você precisa criar um coletor. O BigQuery armazena e gerencia os dados, e você tem a opção de usar tabelas particionadas.

Quando os dados de registro estiverem disponíveis para o BigQuery, você poderá mesclar esses dados com outros dados armazenados no BigQuery e acessar esses dados em outras ferramentas, como o Looker Studio e o Looker.

Para uma visão geral conceitual dos buckets, consulte Visão geral de roteamento e armazenamento: buckets de registros.

Este documento não descreve como criar um bucket de registros que usa uma chave de criptografia gerenciada pelo cliente (CMEK). Se você tiver interesse nesse tópico, consulte Configurar a CMEK para armazenamento de registros.

Antes de começar

Para começar a usar buckets, faça o seguinte:

  • Configure seu projeto do Google Cloud:

    1. Make sure that billing is enabled for your Google Cloud project.

    2. Para receber as permissões necessárias para criar, atualizar e vincular um bucket de registros, peça ao administrador para conceder a você o papel do IAM de Gravador de configuração de registros (roles/logging.configWriter) 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 por meio de papéis personalizados ou de outros papéis predefinidos.

      Para conferir a lista completa de permissões e papéis, consulte Controle de acesso com o IAM.

    3. Opcional: para usar o BigQuery para conferir os dados armazenados em um bucket de registros, faça o seguinte:
      1. Verifique se a API BigQuery está ativada. Você pode verificar se a API está ativada listando os serviços disponíveis.
      2. Seu papel do Identity and Access Management inclui as permissões necessárias para criar um conjunto de dados vinculado. Para mais informações, consulte Permissões para conjuntos de dados do BigQuery vinculados.
  • Entenda as regiões compatíveis em que você pode armazenar seus registros.

  • Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

    REST

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

      Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init

    Para mais informações, consulte Autenticar para usar REST na documentação de autenticação do Google Cloud.

  • Se você planeja usar a Google Cloud CLI ou a API Cloud Logging para criar ou gerenciar seus buckets de registro, entenda os requisitos de formatação do LogBucket.

Criar um bucket

É possível criar no máximo 100 buckets por projeto do Google Cloud.

Para criar um bucket de registros definido pelo usuário para seu projeto do Google Cloud, faça o seguinte:

Console do Google Cloud

Para criar um bucket de registros no seu projeto do Google Cloud, faça o seguinte:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. Clique em Criar bucket de registros.

  3. Insira um Nome e uma Descrição para o bucket.

  4. Opcional: faça upgrade do bucket para usar a Análise de dados de registros.

    1. Selecione Fazer upgrade para usar a Análise de registros.

      Ao fazer upgrade de um bucket para usar a Análise de dados de registros, é possível consultar os registros na página Análise de dados de registros usando consultas SQL. Também é possível continuar visualizando seus registros usando o Explorador de registros.

    2. Opcional: para conferir seus registros no BigQuery, selecione Criar um novo conjunto de dados do BigQuery vinculado a este bucket e insira um nome exclusivo.

      Ao selecionar essa opção, o BigQuery pode ler os dados armazenados no bucket de registros. Agora é possível consultar na interface do BigQuery, onde você pode mesclar seus dados de registro e acessar dados de outras ferramentas, como o Looker Studio e o Looker.

  5. Opcional: para selecionar a região de armazenamento dos registros, clique no menu Selecionar região do bucket de registros e selecione uma região. Se você não selecionar uma região, a região global será usada, o que significa que os registros poderão estar localizados fisicamente em qualquer região com suporte.

  6. Opcional: para definir um período de armazenamento personalizado para os registros no bucket, clique em Próxima.

    No campo Período de armazenamento, insira o número de dias, entre 1 e 3650 dias, que você quer que o Cloud Logging armazene seus registros. Se você não personalizar o período de retenção, o padrão será 30 days.

    Também é possível atualizar o bucket para aplicar a retenção personalizada após a criação.

  7. Clique em Criar bucket.

    Depois que o bucket de registros é criado, a geração de registros atualiza o bucket e cria o link do conjunto de dados, se essas opções tiverem sido selecionadas.

    Pode levar algum tempo para concluir essas etapas.

gcloud

Para criar apenas um bucket de registros, execute o comando gcloud logging buckets create. Se você quiser fazer upgrade do bucket de registros para usar a Análise de registros, inclua as flags --enable-analytics e --async e defina a variável LOCATION para uma região com suporte:

gcloud logging buckets create BUCKET_ID --location=LOCATION --enable-analytics --async OPTIONAL_FLAGS

A flag --async força o comando a ser assíncrono. O retorno de um método assíncrono é um objeto Operation, que contém informações sobre o andamento do método. Quando o método é concluído, o objeto Operation contém o status. Para mais informações, consulte Métodos de API assíncrona.

Se você não quiser fazer upgrade do bucket de registros para usar a Análise de registros, omita as flags --enable-analytics e --async.

Por exemplo, se você quiser criar um bucket com a my-bucket BUCKET_ID na região global, seu comando será semelhante ao seguinte:

gcloud logging buckets create my-bucket --location global --description "My first bucket"

Por exemplo, para criar um bucket com a my-upgraded-bucket BUCKET_ID no local global e fazer upgrade do bucket de registros para usar a Análise de registros, seu comando será semelhante ao seguinte:

gcloud logging buckets create my-upgraded-bucket --location global \
      --description "My first upgraded bucket" \
      --enable-analytics --retention-days=45

REST

Para criar um bucket, use o método projects.locations.buckets.create ou o projects.locations.buckets.createAsync. Prepare os argumentos do método da seguinte maneira:

  1. Defina o parâmetro parent como o recurso em que o bucket será criado: projects/PROJECT_ID/locations/LOCATION

    A variável LOCATION refere-se à região em que você quer que seus registros sejam armazenados.

    Por exemplo, se você quiser criar um bucket para o projeto my-project na região global, o parâmetro parent será semelhante a este: projects/my-project/locations/global

  2. Defina o parâmetro bucketId, por exemplo, my-bucket.

  3. Faça uma das seguintes ações:

    • Para criar um bucket de registros e fazer upgrade dele para usar a Análise de dados de registros:

      1. Defina o booleano LogBucket.analyticsEnabled como true.

      2. Chame o método assíncrono projects.locations.buckets.createAsync para criar o bucket.

        A resposta aos métodos assíncronos é um objeto Operation. Esse objeto contém informações sobre o progresso do método. Quando o método é concluído, o objeto Operation contém o status. Para mais informações, consulte Métodos de API assíncrona.

        O método createAsync leva alguns minutos para ser concluído. Esse método não gera uma mensagem de erro nem falha quando o booleano analyticsEnabled é definido como true.

    • Caso contrário, chame o método síncrono projects.locations.buckets.create para criar o bucket.

Depois de criar um bucket, crie um coletor para rotear as entradas de registro para o bucket e configure as visualizações de registro para controlar quem pode acessar os registros no novo bucket e quais registros podem ser acessados por eles. Também é possível atualizar o bucket para configurar a retenção personalizada e os campos restritos.

Acompanhar o volume de registros armazenados em buckets de registros

A página Armazenamento de registros no console do Google Cloud rastreia o volume de dados de registros armazenados em buckets de registros:

No console do Google Cloud, acesse a página Armazenamento de registros:

Acessar o armazenamento de registros

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

A página Armazenamento de registros mostra um resumo das estatísticas do seu projeto do Google Cloud:

As estatísticas de resumo informam a quantidade de dados de registro armazenados nos intervalos de registro do projeto selecionado.

As seguintes estatísticas são informadas:

  • Ingestão do mês atual: a quantidade de dados de registros que o projeto do Google Cloud armazenou em buckets de registro desde o primeiro dia do mês atual.

  • Ingestão do mês anterior: a quantidade de dados de registros que seu projeto do Google Cloud armazenou em buckets de registro no último mês.

  • Ingestão prevista por EOM: a quantidade estimada de dados de registros que seu projeto do Google Cloud vai armazenar em buckets de registro até o final do mês atual, com base no uso atual.

  • Armazenamento faturável do mês atual: a quantidade de dados de registros que foi retida por mais de 30 dias e que é faturada.

As estatísticas anteriores não incluem registros no bucket _Required. Não é possível excluir ou desativar os registros nesse bucket.

A página Roteador de registros no console do Google Cloud oferece ferramentas que podem ser usadas para minimizar qualquer cobrança de armazenamento de registros em buckets de registro ou que exceda sua cota mensal. Faça o seguinte:

  • Desativar o armazenamento de registros no nível do bucket.
  • Exclua determinadas entradas de registro do armazenamento em buckets de registro.

Para mais informações, consulte Gerenciar coletores.

Gerenciar buckets

Esta seção descreve como gerenciar seus buckets de registro usando a Google Cloud CLI ou o console do Google Cloud.

Atualizar um bucket

Para atualizar as propriedades do bucket, como a descrição ou o período de armazenamento, faça o seguinte:

Console do Google Cloud

Para atualizar as propriedades do bucket, faça o seguinte:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. No bucket que você quer atualizar, clique em Mais.

  3. Selecione Editar bucket.

  4. Edite o bucket conforme necessário.

  5. Clique em Atualizar bucket.

gcloud

Para atualizar as propriedades do bucket, execute o comando gcloud logging buckets update:

gcloud logging buckets update BUCKET_ID --location=LOCATION UPDATED_ATTRIBUTES

Exemplo:

gcloud logging buckets update my-bucket --location=global --description "Updated description"

REST

Para atualizar as propriedades do bucket, use projects.locations.buckets.patch na API Logging.

Fazer upgrade de um bucket para usar a Análise de dados de registros

Para fazer upgrade de um bucket para usar a Análise de dados de registros, as seguintes restrições se aplicam:

  • O bucket de registros foi criado no nível do projeto do Google Cloud.
  • O bucket de registros está desbloqueado, a menos que seja o bucket _Required.

  • Não há atualizações pendentes no bucket.

Console do Google Cloud

Para fazer upgrade de um bucket para usar a Análise de dados de registros, siga estas etapas:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. Localize o bucket que você quer atualizar.

  3. Quando a coluna Análise de registros disponível mostra Upgrade, é possível fazer upgrade do bucket de registros para usar a Análise de registros. Clique em Fazer upgrade.

    Uma caixa de diálogo é aberta. Clique em Confirmar.

gcloud

Para fazer upgrade do bucket de registros para usar a Análise de dados de registros, execute o comando gcloud logging buckets update. É necessário definir a flag --enable-analytics e recomendamos que você também inclua a flag --async:

gcloud logging buckets update BUCKET_ID --location=LOCATION --enable-analytics --async

A flag --async força o comando a ser assíncrono. O retorno de um método assíncrono é um objeto Operation e contém informações sobre o andamento do método. Quando o método é concluído, o objeto Operation contém o status. Para mais informações, consulte Métodos de API assíncrona.

REST

Para fazer upgrade de um bucket de registros para usar a Análise de dados de registros, use o método projects.locations.buckets.updateAsync da API Cloud Logging.

Prepare os argumentos do método da seguinte maneira:

  1. Defina o booleano LogBucket.analyticsEnabled como true.
  2. Para o parâmetro de consulta do comando, use updateMask=analyticsEnabled.

A resposta aos métodos assíncronos é um objeto Operation. Esse objeto contém informações sobre o progresso do método. Quando o método é concluído, o objeto Operation contém o status. Para mais informações, consulte Métodos de API assíncrona.

A updateAsync pode levar alguns minutos para ser concluída.

Quando você quiser usar os recursos do BigQuery para analisar seus dados de registro, faça upgrade de um bucket de registros para usar a Análise de dados de registros e crie um conjunto de dados vinculado. Com essa configuração, o Logging armazena seus dados de registro, mas o BigQuery pode ler esses dados.

Console do Google Cloud

Para criar um link para um conjunto de dados do BigQuery em um bucket de registros existente, faça o seguinte:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. Localize o bucket de registros e verifique se a coluna Log Analytics disponível mostra Aberto.

    Se essa coluna mostrar Upgrade, o bucket de registros não foi atualizado para usar a Análise de registros. Configure a Análise de dados de registros:

    1. Clique em Fazer upgrade.
    2. Clique em Confirmar na caixa de diálogo.

    Depois que o upgrade for concluído, prossiga para a próxima etapa.

  3. No bucket de registros, clique em Mais e em Editar bucket.

    A caixa de diálogo Edit log bucket é aberta.

  4. Selecione Criar um novo conjunto de dados do BigQuery vinculado a este bucket e insira o nome do novo conjunto de dados.

    O nome do conjunto de dados precisa ser exclusivo para cada projeto do Google Cloud. Se você inserir o nome de um conjunto de dados existente, receberá o seguinte erro: Dataset name must be unique in the selected region.

  5. Clique em Concluído e em Atualizar bucket.

    Depois que o Logging mostra o nome do conjunto de dados vinculado na página Logs Storage, pode levar alguns minutos até que o BigQuery reconheça o conjunto de dados.

gcloud

Para criar um conjunto de dados vinculado a um bucket de registros atualizado para usar a Análise de dados de registros, execute o comando gcloud logging links create:

gcloud logging links create LINK_ID --bucket=BUCKET_ID --location=LOCATION

O LINK_ID fornecido é usado como o nome do conjunto de dados do BigQuery, e o valor desse campo precisa ser exclusivo para seu projeto do Google Cloud.

O comando links create é assíncrono. O retorno de um método assíncrono é um objeto Operation e contém informações sobre o progresso do método. Quando o método é concluído, o objeto Operation contém o status. Para mais informações, consulte Métodos de API assíncrona.

O comando links create leva alguns minutos para ser concluído.

Por exemplo, o comando a seguir cria um conjunto de dados vinculado chamado mylink para o bucket de registros my-bucket:

gcloud logging links create mylink --bucket=my-bucket --location=global

O nome do conjunto de dados precisa ser exclusivo para cada projeto do Google Cloud. Se você tentar criar um conjunto de dados com o mesmo nome de um conjunto de dados existente, o seguinte erro será exibido:

BigQuery dataset with name "LINK_ID" already exists.

Se você tentar criar um conjunto de dados vinculado para um bucket de registros que não foi atualizado para usar a Análise de dados de registros, o seguinte erro será informado:

A link can only be created for an analytics-enabled bucket.

REST

Para criar um conjunto de dados do BigQuery vinculado a um bucket de registros atualizado, use a Análise de dados de registros. Chame o método assíncrono projects.locations.buckets.links.create da API Cloud Logging.

Prepare os argumentos do método da seguinte maneira:

  1. Crie o corpo da solicitação para o comando create. O corpo da solicitação é formatado como um objeto Link.
  2. Para o parâmetro de consulta do comando, use linkId=LINK_ID. O LINK_ID fornecido é usado como o nome do conjunto de dados do BigQuery, e o valor desse campo precisa ser exclusivo para seu projeto do Google Cloud.

A resposta aos métodos assíncronos é um objeto Operation. Esse objeto contém informações sobre o progresso do método. Quando o método é concluído, o objeto Operation contém o status. Para mais informações, consulte Métodos de API assíncrona.

O método links.create leva alguns minutos para ser concluído.

O nome do conjunto de dados precisa ser exclusivo para cada projeto do Google Cloud. Se você tentar criar um conjunto de dados com o mesmo nome de um conjunto de dados existente, receberá o seguinte erro:

BigQuery dataset with name "LINK_ID" already exists.

Se você tentar criar um conjunto de dados vinculado para um bucket de registros que não foi atualizado para usar a Análise de dados de registros, o seguinte erro será informado:

A link can only be created for an analytics-enabled bucket.

Bloquear um bucket

Quando você bloqueia um bucket contra atualizações, também bloqueia a política de retenção dele. Depois que uma política de retenção estiver bloqueada, você não poderá excluir o bucket até que todas as entrada de registro nele tenham atendido ao período de retenção.

Para impedir que alguém atualize ou exclua um bucket de registros, bloqueie-o. Para bloquear o bucket, faça o seguinte:

Console do Google Cloud

O console do Google Cloud não é compatível com o bloqueio de um bucket de registros.

gcloud

Para bloquear seu bucket, execute o comando gcloud logging buckets update com a flag --locked:

gcloud logging buckets update BUCKET_ID --location=LOCATION --locked

Exemplo:

gcloud logging buckets update my-bucket --location=global --locked

REST

Para bloquear os atributos do bucket, use projects.locations.buckets.patch na API Logging. Defina o parâmetro locked como true.

Listar buckets

Para listar os buckets de registros associados a um projeto do Google Cloud e conferir detalhes, como as configurações de retenção, faça o seguinte:

Console do Google Cloud

No console do Google Cloud, acesse a página Armazenamento de registros:

Acessar o armazenamento de registros

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

Uma tabela chamada Buckets de registro lista os buckets associados ao projeto atual do Google Cloud.

A tabela lista os seguintes atributos para cada bucket de registro:

  • Nome: o nome do bucket de registros.
  • Descrição: a descrição do bucket.
  • Período de armazenamento: o número de dias em que os dados do bucket são armazenados pelo Cloud Logging.
  • Região: a localização geográfica em que os dados do bucket são armazenados.
  • Status: indica se o bucket está bloqueado ou desbloqueado.

Se um bucket estiver pendente de exclusão pelo Cloud Logging, a entrada da tabela será anotada com um símbolo de aviso .

gcloud

Execute o comando gcloud logging buckets list:

gcloud logging buckets list

Você verá os seguintes atributos dos buckets de registro:

  • LOCATION: a região em que os dados do bucket são armazenados.
  • BUCKET_ID: o nome do bucket de registros.
  • RETENTION_DAYS: o número de dias em que os dados do bucket serão armazenados pelo Cloud Logging.
  • LIFECYCLE_STATE: indica se o bucket está exclusão pendente pelo Cloud Logging.
  • LOCKED: se o bucket está bloqueado ou desbloqueado.
  • CREATE_TIME: um carimbo de data/hora que indica quando o bucket foi criado.
  • UPDATE_TIME: um carimbo de data/hora que indica quando o bucket foi modificado pela última vez.

Também é possível visualizar os atributos de apenas um bucket. Por exemplo, para conferir os detalhes do bucket de registros _Default na região global, execute o comando gcloud logging buckets describe:

gcloud logging buckets describe _Default --location=global

REST

Para listar os buckets de registro associados a um projeto do Google Cloud, use projects.locations.buckets.list na API Logging.

Ver os detalhes de um intervalo

Para ver os detalhes de um único bucket de registro, faça o seguinte:

Console do Google Cloud

No console do Google Cloud, acesse a página Armazenamento de registros:

Acessar o armazenamento de registros

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

No bucket de registros, clique em Mais e selecione Ver detalhes do bucket.

A caixa de diálogo lista os seguintes atributos para o bucket de registros:

  • Nome: o nome do bucket de registros.
  • Descrição: a descrição do bucket de registros.
  • Período de armazenamento: o número de dias em que os dados do bucket são armazenados pelo Cloud Logging.
  • Região: a localização geográfica em que os dados do bucket são armazenados.
  • Análise de registros: indica se o bucket foi atualizado para usar a análise de registros.
  • Análise do BigQuery: indica se um conjunto de dados do BigQuery está vinculado ao seu bucket.
  • Conjunto de dados do BigQuery: fornece um link para seu conjunto de dados do BigQuery, que é aberto na página BigQuery Studio. A data em que a vinculação do BigQuery foi ativada também é mostrada.

gcloud

Execute o comando gcloud logging buckets describe.

Por exemplo, o comando a seguir informa os detalhes do bucket _Default:

gcloud logging buckets describe _Default --location=global

Você vai encontrar os seguintes atributos no bucket de registros:

  • createTime: um carimbo de data/hora que indica quando o bucket foi criado.
  • description: a descrição do bucket de registros.
  • lifecycleState: indica se o bucket está exclusão pendente pelo Cloud Logging.
  • name: o nome do bucket de registros.
  • retentionDays: o número de dias em que os dados do bucket serão armazenados pelo Cloud Logging.
  • updateTime: um carimbo de data/hora que indica quando o bucket foi modificado pela última vez.

REST

Para conferir os detalhes de um único bucket de registros, use projects.locations.buckets.get na API Logging.

Excluir um bucket

Para excluir um bucket de registro, faça o seguinte:

Console do Google Cloud

Para excluir um bucket de registro, faça o seguinte:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. Localize o bucket que você quer excluir e clique em Mais.

  3. Se a coluna Conjunto de dados vinculado no BigQuery mostrar um link, exclua o conjunto de dados vinculado do BigQuery:

    1. Clique em Editar bucket.

    2. Desmarque Criar um novo conjunto de dados do BigQuery vinculado a este bucket, clique em Concluído e em Atualizar bucket.

      Depois de retornar à página Armazenamento de registros, clique em Mais no bucket que você quer excluir e siga para as próximas etapas.

  4. Selecione Excluir bucket.

  5. No painel de confirmação, clique em Excluir.

  6. Na página Armazenamento de registros, o bucket tem um indicador mostrando que a exclusão está pendente. O bucket e todos os registros contidos nele são excluídos após sete dias.

gcloud

Para excluir um bucket de registros, execute o comando gcloud logging buckets delete:

gcloud logging buckets delete BUCKET_ID --location=LOCATION

Não é possível excluir um bucket de registros quando ele tem um conjunto de dados do BigQuery vinculado:

REST

Para excluir um bucket, use projects.locations.buckets.delete na API Logging.

É um erro excluir um bucket de registros se ele tiver um conjunto de dados do BigQuery vinculado. É necessário excluir o conjunto de dados vinculado antes de excluir o bucket de registros:

Um bucket excluído permanece nesse estado pendente por sete dias, e o Logging continua a rotear registros para ele durante esse período. Para interromper o roteamento de registros para um bucket excluído, exclua os coletores de registro que têm esse bucket como destino ou modifique o filtro dos coletores para interromper o roteamento para o bucket excluído.

Não é possível criar um novo bucket de registros que use o mesmo nome de um bucket excluído que esteja em estado pendente.

Restaurar um bucket excluído

É possível restaurar ou cancelar a exclusão de um bucket que esteja no estado de exclusão pendente. Para restaurar um bucket de registro, faça o seguinte:

Console do Google Cloud

Para restaurar um bucket de registros com exclusão pendente, faça o seguinte:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. No bucket que você quer restaurar, clique em Mais e selecione Restaurar bucket excluído.

  3. No painel de confirmação, clique em Restaurar.

  4. Na página Armazenamento de registros, o indicador de exclusão pendente é removido do bucket de registros.

gcloud

Para restaurar um bucket de registros com exclusão pendente, execute o comando gcloud logging buckets undelete:

gcloud logging buckets undelete BUCKET_ID --location=LOCATION

REST

Para restaurar um bucket com exclusão pendente, use projects.locations.buckets.undelete na API Logging.

Alerta sobre bytes de registro mensais armazenados em buckets de registro

Para criar uma política de alertas, na página Logs Storage no console do Google Cloud, clique em Criar alerta de uso. Esse botão abre a página Criar política de alertas no Monitoring e preenche o campo de tipo de métrica com logging.googleapis.com/billing/bytes_ingested.

Para criar uma política de alertas que seja acionada quando o número de bytes de registro gravados nos buckets de registro exceder o limite definido pelo usuário para o Cloud Logging, use as seguintes configurações.

Novo estado
Campo
Valor
Recurso e métrica No menu Recursos, selecione Global.
No menu Categorias de métrica, selecione Métrica com base em registros.
No menu Métricas, selecione Bytes de registro mensais ingeridos.
Filtrar Nenhuma.
Várias séries
Agregação de série temporal		 sum
Janela contínua 60 m
Função de janela contínua max
Campo
Configurar gatilho de alerta
Valor
Tipo de condição Threshold
Acionador de alerta Any time series violates
Posição do limite Above threshold
Valor do limite Você determina o valor aceitável.
Teste a janela novamente O valor mínimo aceitável é de 30 minutos.

Para mais informações sobre políticas de alertas, consulte Visão geral de alertas.

Gravar em um bucket

Os registros não são gravados diretamente em um bucket de registros. Em vez disso, grave registros no recurso do Google Cloud: um projeto, uma pasta ou uma organização do Google Cloud. Os coletores no recurso pai então roteiam os registros para destinos, incluindo buckets de registro. Um coletor encaminha registros para um destino de bucket de registro quando os registros correspondem ao filtro do coletor e o coletor tem permissão para rotear os registros para o bucket de registros.

Ler em um bucket

Cada bucket de registros tem um conjunto de visualizações. Para ler registros de um bucket de registro, é preciso ter acesso a uma visualização no bucket. As visualizações de registros permitem conceder a um usuário acesso apenas a um subconjunto dos registros armazenados em um bucket de registros. Para informações sobre como configurar visualizações de registro e conceder acesso a visualizações de registro específicas, consulte Configurar visualizações de registro em um bucket de registro.

Para ler registros de um bucket de registro, faça o seguinte:

Console do Google Cloud

  1. No console do Google Cloud, acesse a página Análise de registros:

    Acessar a Análise de registros

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

  2. Para personalizar quais registros são exibidos no Explorador de registros, clique em Refinar escopo e selecione uma opção. Por exemplo, é possível conferir os registros armazenados em um projeto ou pela visualização de registros.

  3. Clique em Aplicar. O painel Resultados da consulta é recarregado com registros que correspondem à opção selecionada.

Para mais informações, consulte Visão geral do Explorador de registros: refinar o escopo.

gcloud

Para ler os registros de um bucket de registros, use o comando gcloud logging read e adicione um LOG_FILTER para selecionar os dados:

gcloud logging read LOG_FILTER --bucket=BUCKET_ID --location=LOCATION --view=VIEW_ID

REST

Para ler registros de um bucket de registros, use o método entries.list. Defina resourceNames para especificar o bucket e a visualização de registro apropriados e defina filter para selecionar dados.

Para informações detalhadas sobre a sintaxe de filtragem, consulte Linguagem de consulta do Logging.

Configurar retenção personalizada

Ao criar um bucket de registro, você tem a opção de personalizar o período de armazenamento dos registros do bucket pelo Cloud Logging. É possível configurar o período de armazenamento para qualquer bucket de registros definido pelo usuário e também para o bucket de registros _Default.

Se você encurtar a retenção do bucket, haverá um período de carência de sete dias em que os registros expirados não serão excluídos. Não é possível consultar nem visualizar esses registros expirados, mas, nesses sete dias, é possível restaurar o acesso completo estendendo a retenção do bucket. Os registros armazenados durante o período de carência são contabilizados nos seus custos de retenção.

Para atualizar o período de armazenamento de um bucket de registro, siga estas etapas:

Console do Google Cloud

Para atualizar o período de armazenamento de um bucket de registros, faça o seguinte:

  1. No console do Google Cloud, acesse a página Armazenamento de registros:

    Acessar o armazenamento de registros

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

  2. No bucket que você quer atualizar, clique em Mais e selecione Editar bucket.

  3. No campo Retenção, insira o número de dias, entre 1 e 3650 dias, que você quer que o Cloud Logging armazene seus registros.

  4. Clique em Atualizar bucket. A nova duração de retenção aparece na lista Bucket de registros.

gcloud

Para atualizar o período de armazenamento de um bucket de registros, execute o comando gcloud logging buckets update depois de definir um valor para RETENTION_DAYS:

gcloud logging buckets update BUCKET_ID  --location=LOCATION --retention-days=RETENTION_DAYS

Por exemplo, para manter os registros no bucket _Default no local global por um ano, seu comando seria semelhante ao seguinte:

gcloud logging buckets update _Default --location=global --retention-days=365

Se você prolongar o período de armazenamento de um bucket, as regras de retenção serão aplicadas a partir de agora, não retroativamente. Não é possível recuperar os registros após o término do período de armazenamento aplicável.

Métodos de API assíncronos

A resposta de um método assíncrono como projects.locations.buckets.createAsync é um objeto Operation.

Os aplicativos que chamam um método de API assíncrono precisam pesquisar o endpoint operation.get até que o valor do campo Operation.done seja true:

  • Quando done é false, a operação está em andamento.

    Para atualizar as informações de status, envie uma solicitação GET para o endpoint operation.get.

  • Quando done é true, a operação é concluída e o campo error ou response está definido:

    • error: quando definida, a operação assíncrona falha. O valor desse campo é um objeto Status que contém um código de erro do gRPC e uma mensagem de erro.
    • response: quando definido, a operação assíncrona é concluída e o valor reflete o resultado.

Para consultar um comando assíncrono usando a Google Cloud CLI, execute o seguinte comando:

gcloud logging operations describe OPERATION_ID --location=LOCATION --project=PROJECT_ID

Para ver mais informações, consulte gcloud logging operations describe.

Resolver problemas comuns

Se você tiver problemas ao usar buckets de registros, consulte as etapas de solução de problemas e respostas a perguntas comuns a seguir.

Por que não consigo excluir esse bucket?

Se você estiver tentando excluir um bucket, faça o seguinte:

  • Verifique se você tem as permissões corretas para excluir o bucket. Para conferir a lista de permissões necessárias, consulte Controle de acesso com o IAM.

  • Determine se o bucket está bloqueado listando os atributos do bucket. Se o bucket estiver bloqueado, verifique o período de armazenamento do bucket. Não é possível excluir um bucket bloqueado até que todos os registros nele tenham cumprido o período de armazenamento.

  • Verifique se o bucket de registros não tem um conjunto de dados do BigQuery vinculado. Não é possível excluir um bucket de registros com um conjunto de dados vinculado.

    O erro a seguir é mostrado em resposta a um comando delete em um bucket de registros que tem um conjunto de dados vinculado:

    FAILED_PRECONDITION: This bucket is used for advanced analytics and has an active link. The link must be deleted first before deleting the bucket

    Para listar os links associados a um bucket de registros, execute o comando gcloud logging links list ou o método projects.locations.buckets.links.list da API.

Quais contas de serviço estão roteando registros para meu bucket?

Para determinar se alguma conta de serviço tem permissões de IAM para rotear registros para o bucket, faça o seguinte:

  1. No console do Google Cloud, abra a página IAM.

    Acesse o IAM

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

  2. Na guia Permissões, visualize por Papéis. Você vai encontrar uma tabela com todos os papéis e principais do IAM associados ao seu projeto do Google Cloud.

  3. No campoFiltro caixa de texto, digiteGravador de bucket de registros.

    Você verá todos os principais com o papel de Gravador de bucket de registros. Se um principal for uma conta de serviço, o ID conterá a string gserviceaccount.com.

  4. Opcional: se quiser remover uma conta de serviço para que ela não possa rotear registros para o projeto do Google Cloud, marque a caixa de seleção da conta de serviço e clique em Remover.

Por que vejo registros de um projeto do Google Cloud mesmo após excluí-los do meu coletor _Default?

É possível visualizar registros em um bucket de registros em um projeto centralizado do Google Cloud, que agrega registros de toda a organização.

Se você estiver usando o Explorador de registros para acessar esses registros e conferir os registros que você excluiu do coletor _Default, talvez sua visualização esteja definida no nível do projeto do Google Cloud.

Para corrigir esse problema, selecione Visualização de registro no menu Refinar escopo e, em seguida, selecione a visualização de registro associada ao bucket _Default no seu projeto do Google Cloud. Você não verá mais os registros excluídos.

A seguir

Para mais informações sobre os métodos da API Logs Bucket, consulte a documentação de referência de LogBucket.

Se você gerencia uma organização ou uma pasta, pode especificar o local dos buckets de registro _Default e _Required de recursos filhos. Também é possível configurar se os buckets de registro usam a CMEK e o comportamento do coletor de registros _Default. Para mais informações, consulte Definir configurações padrão para organizações e pastas.

Para informações sobre como lidar com casos de uso comuns com buckets de registro, consulte os tópicos a seguir: