Geração de registros de auditoria

Nesta página, descrevemos os registros de auditoria criados pelos complementos do Google Workspace como parte dos Registros de auditoria do Cloud.

Informações gerais

Os serviços do Google Cloud gravam registros de auditoria para que você possa determinar quem fez o quê, onde e quando. Os projetos do Cloud contêm apenas os registros de auditoria dos recursos que estão diretamente no projeto. Outras entidades, como pastas, organizações e contas de faturamento do Cloud, contêm os registros de auditoria da própria entidade.

Para uma visão geral dos registros do Cloud Audit, consulte Cloud Audit Logs. Para entender melhor os registros de auditoria do Cloud, consulte Noções básicas sobre registros de auditoria.

Os seguintes tipos de registros de auditoria estão disponíveis para complementos do Google Workspace:

  • Registros de auditoria de atividade do administrador

    Inclui operações de "gravação de administrador" que gravam metadados ou informações de configuração.

    Não é possível desativar os registros de auditoria de atividade do administrador.

Operações auditadas

Veja na tabela a seguir um resumo de quais operações da API correspondem a cada tipo de registro de auditoria nos complementos do Google Workspace:

Categoria de registro de auditoria Operações dos complementos do Google Workspace
Registros de auditoria de atividade do administrador projects.GetAuthorization
Deployments.CreateDeployment
Deployments.ReplaceDeployment
Deployments.ListDeployments
Deployments.GetDeployment
Deployments.DeleteDeployment
Deployments.InstallDeployment
Deployments.UninstallDeployment
Deployments.GetInstallStatus

Formato do registro de auditoria

As entradas de registro de auditoria, que podem ser visualizadas no Cloud Logging com o visualizador de registros, a API Cloud Logging ou a Google Cloud CLI, incluem os seguintes objetos:

  • A própria entrada de registro, que é um objeto do tipo LogEntry. Veja alguns campos úteis:

    • O logName contém a identificação do projeto e o tipo de registro de auditoria.
    • O resource contém o destino da operação auditada.
    • O timeStamp contém o horário da operação auditada.
    • O protoPayload contém as informações auditadas.
  • Os dados de registro de auditoria, que são um objeto AuditLog localizado no campo protoPayload da entrada de registro.

  • Informações de auditoria opcionais e específicas do serviço, que são um objeto específico do serviço. Para integrações anteriores, esse objeto é mantido no campo serviceData do objeto AuditLog. Integrações posteriores usam o campo metadata.

Veja outros campos nesses objetos e como interpretá-los em Noções básicas sobre registros de auditoria.

Nome do registro

Os nomes dos recursos dos registros de auditoria do Cloud indicam o projeto do Cloud ou outra entidade do Google Cloud que possui os registros de auditoria e se eles contêm dados de registro de auditoria de atividades do administrador, acesso a dados ou eventos do sistema. Por exemplo, veja abaixo os nomes dos registros de auditoria de atividades do administrador de um projeto e de acesso a dados de uma organização. As variáveis indicam identificadores de projeto e organização.

projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity
organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access

Nome do serviço

Os registros de auditoria de complementos do Google Workspace usam o nome de serviço gsuiteaddons.googleapis.com.

Para informações sobre todos os serviços de geração de registros, consulte Como mapear serviços para recursos.

Tipos de recurso

Os registros de auditoria de complementos do Google Workspace usam o tipo de recurso audited_resource para todos os registros de auditoria.

Para ver uma lista com outros tipos de recursos, consulte Tipos de recursos monitorados.

Como ativar a geração de registros de auditoria

Os registros de auditoria de atividade do administrador estão sempre ativados. Não é possível desativá-los.

Os complementos do Google Workspace não gravam registros de auditoria de acesso a dados.

Permissões de registro de auditoria

As permissões e os papéis do gerenciamento de identidade e acesso determinam quais registros de auditoria é possível ver ou exportar. Os registros residem em projetos do Cloud e em outras entidades, incluindo organizações, pastas e contas de faturamento do Cloud. Saiba mais em Noções básicas sobre papéis.

Para ver os registros de auditoria de atividade do administrador, você precisa ter um dos seguintes papéis do IAM no projeto que contém os registros de auditoria:

Os complementos do Google Workspace não gravam registros de auditoria de acesso a dados ou de eventos do sistema.

Se você estiver usando registros de auditoria de uma entidade sem projeto, como uma organização, mude os papéis do projeto do Cloud para os adequados à organização.

Como ver registros

Para encontrar e visualizar registros de auditoria, é preciso saber o identificador do projeto, da pasta ou da organização do Google Cloud. É possível especificar outros campos indexados LogEntry, como resource.type. Para mais detalhes, consulte Criar consultas no Explorador de registros.

Veja a seguir os nomes dos registros de auditoria que incluem variáveis para os identificadores do projeto, da pasta ou da organização do Cloud.

   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Factivity
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fpolicy

   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Factivity
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   folders/FOLDER_ID/logs/cloudaudit.googleapis.com%2Fpolicy

   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Factivity
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com%2Fpolicy

Você tem várias opções para ver as entradas de registro de auditoria.

Console

Use o explorador de registros no Console do Cloud para recuperar as entradas dos registro de auditoria do projeto do Cloud:

  1. No Console do Cloud, acesse a página Logging > Explorador de registros.

    Acessar a página Explorador de registros

  2. Na página Explorador de registros, selecione um projeto do Cloud.

  3. No painel Criador de consultas, faça o seguinte:

    • Em Recurso, selecione o tipo de recurso do Google Cloud que tem os registros de auditoria que você quer ver.

    • Em Nome do registro, selecione o tipo de registro de auditoria que você quer ver:

      • Para os registros de auditoria da atividade do administrador, selecione Atividade.
      • Para os registros de auditoria de acesso a dados, selecione data_access.
      • Para os registros de auditoria de eventos do sistema, selecione system_event.
      • Em "Registros de auditoria de política negada", selecione policy.

    Se você não vir essas opções, então não há registros de auditoria desses tipos disponíveis no projeto do Cloud.

    Para mais detalhes sobre como consultar usando o novo Explorador de registros, acesse Criar consultas no Explorador de registros.

gcloud

A Google Cloud CLI fornece uma interface de linha de comando para a API Cloud Logging. Insira um PROJECT_ID, FOLDER_ID ou ORGANIZATION_ID válido em cada um dos nomes de registro.

Para ler suas entradas de registro de auditoria no nível do projeto do Google Cloud, execute o comando a seguir:

gcloud logging read "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com" \
    --project=PROJECT_ID

Para ler suas entradas de registro de auditoria no nível da pasta, execute o comando a seguir:

gcloud logging read "logName : folders/FOLDER_ID/logs/cloudaudit.googleapis.com" \
    --folder=FOLDER_ID

Para ler as entradas de registro de auditoria no nível da organização, execute o seguinte comando:

gcloud logging read "logName : organizations/ORGANIZATION_ID/logs/cloudaudit.googleapis.com" \
    --organization=ORGANIZATION_ID

Saiba mais sobre como usar a CLI gcloud em gcloud logging read.

API

Ao criar consultas, substitua as variáveis por valores válidos, bem como nomes ou identificadores dos registros de auditoria adequados a nível do projeto, da pasta ou da organização, conforme listado nos nomes dos registros de auditoria. Por exemplo, se a consulta incluir um PROJECT_ID, o identificador do projeto que você fornecer precisará fazer referência ao projeto do Cloud selecionado.

Para usar a API Logging para analisar suas entradas de registro de auditoria, siga estas instruções:

  1. Acesse a seção Testar esta API da documentação do método entries.list.

  2. Digite o seguinte na parte do Corpo da solicitação do formulário Teste esta API. Clique nesse formulário preenchido automaticamente para preencher automaticamente o corpo da solicitação, mas é necessário inserir um PROJECT_ID válido em cada um dos nomes de registro.

    {
      "resourceNames": [
        "projects/PROJECT_ID"
      ],
      "pageSize": 5,
      "filter": "logName : projects/PROJECT_ID/logs/cloudaudit.googleapis.com"
    }
    
  3. Clique em Executar.

Para mais detalhes sobre consultas, acesse Linguagem de consulta do Logging.

Para ver um exemplo de entrada de registro de auditoria e instruções sobre como encontrar as informações mais importantes nesse registro, acesse Noções básicas sobre registros de auditoria.

Como exportar registros de auditoria

Você pode exportar registros de auditoria da mesma forma que exporta outros tipos de registros. Para ver detalhes sobre como exportar registros, consulte este link. Veja a seguir algumas aplicações da exportação de registros de auditoria.

  • Para manter registros de auditoria por mais tempo ou usar recursos de pesquisa mais eficientes, exporte cópias desses registros para o Cloud Storage, o BigQuery ou o Pub/Sub. Com o Pub/Sub, faça exportações para outros aplicativos e repositórios ou para terceiros.

  • Para gerenciar seus registros de auditoria em toda a organização, crie coletores agregados que podem exportar registros de qualquer ou todos os projetos do Cloud na organização.

Preços

O Cloud Logging não gera cobranças por registros de auditoria que não podem ser desativados, incluindo todos aqueles de atividades do administrador.

Para mais informações sobre os preços dos registros de auditoria, consulte Preços do Pacote de operações do Google Cloud.