Informações sobre a geração de registros de auditoria do Firestore

Neste documento, descrevemos os registros de auditoria criados pelo Firestore como parte dos Registros de auditoria do Cloud.

Visão geral

Os serviços do Google Cloud gravam registros de auditoria para ajudar você a responder às perguntas: "Quem fez o quê, onde e quando?" nos recursos do Google Cloud.

Seus projetos do Google Cloud contêm apenas os registros de auditoria dos recursos que estão diretamente no projeto. Outros recursos do Google Cloud, como pastas, organizações e contas de faturamento, contêm os registros de auditoria da própria entidade.

Para uma visão geral dos registros de auditoria do Cloud, consulte este link. Para entender melhor o formato do registro de auditoria, consulte Noções básicas dos registros de auditoria.

Registros de auditoria disponíveis

Os seguintes tipos de registros de auditoria estão disponíveis para O Firestore:

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 esses registros.
Registros de auditoria de acesso a dados

Inclui operações de "leitura do administrador" que leem metadados ou informações de configuração. Também inclui operações de "leitura de dados" e "gravação de dados" que leem ou gravam dados fornecidos pelo usuário.

Para receber registros de auditoria de acesso a dados, é necessário ativá-los explicitamente.

Para ver descrições mais completas dos tipos de registros de auditoria, consulte Tipos de registros de auditoria.

Operações auditadas

Veja na tabela a seguir um resumo de quais operações da API correspondem a cada tipo de registro de auditoria no Firestore:

Categoria de registro de auditoria	Operações do Firestore
Registros de atividade do administrador (`ADMIN_WRITE`)	`ExportDocuments` `ImportDocuments` `CreateIndex` `DeleteIndex` `UpdateField` `CreateDatabase` `DeleteDatabase` `UpdateDatabase` `RestoreDatabase` `DeleteBackup` `CreateBackupSchedule` `UpdateBackupSchedule` `DeleteBackupSchedule` `CancelOperation` `DeleteOperation`
Registros de auditoria de acesso a dados (`ADMIN_READ`)	`GetIndex` `ListIndexes` `GetField` `ListFields` `GetDatabase` `ListDatabases` `GetBackup` `ListBackups` `GetBackupSchedule` `ListBackupSchedules` `GetOperation` `ListOperations` `GetLocation` `ListLocations`
Registros de auditoria de acesso a dados (`DATA_READ`)	`GetDocument` `ListDocuments` `BatchGetDocuments` `BeginTransaction` `Commit` sem gravações `Rollback` `RunQuery` (streaming) `RunQuery` é um RPC de streaming de curta duração e emite uma entrada de registro quando a última mensagem (documento) é enviada. `RunAggregationQuery` `PartitionQuery` `ListCollectionIds` `Listen` (streaming) `Listen` é uma RPC de longa duração que combina vários destinos de streaming. Cada destino é uma consulta ou um conjunto de chaves de documentos. O stream de cada destino inclui um conjunto de resultados inicial e uma sequência de atualizações, adições e remoções no conjunto de resultados. As metas são a unidade de auditoria relevante. O Firestore audita cada destino da seguinte maneira: Quando o destino for adicionado, emita uma entrada de registro com a consulta do destino ou a chave do documento definida. Nessas entradas, `operation.first` é verdadeiro. Esse registro de auditoria é omitir quando o stream é uma retomada de um stream de destino de detecção anterior. Emite atualizações periódicas informando a contagem de atualizações desde o último registro de auditoria desse destino. Emite uma entrada de registro quando o destino é removido do stream, seja explicitamente ou devido ao encerramento da RPC `Listen`. Esta entrada de registro informa a contagem de atualizações desde o último registro de auditoria para esse destino. Nessas entradas, `operation.last` é verdadeiro. As entradas de registro emitidas usam o mesmo `operation.id`. O Firestore também inclui as seguintes operações como parte da ferramenta de diagnóstico Key Visualizer: `google.cloud.keyvisualizer.KeyVisualizer.GetScan` `google.cloud.keyvisualizer.KeyVisualizer.ListScans`
Registros de auditoria de acesso a dados (`DATA_WRITE`)	`CreateDocument` `UpdateDocument` `DeleteDocument` `Commit` com gravações `BatchWrite` `Write` (streaming) `Write` emite uma entrada de registro para cada mensagem recebida, visto que cada mensagem corresponde a uma gravação independente no banco de dados. As entradas de registro emitidas usam o mesmo `operation.id`.

Identificar autores de chamadas da solicitação

As entradas do registro de auditoria incluem informações sobre a identidade que executou a operação registrada. Para identificar um autor de chamada de solicitação, consulte os seguintes campos em um objeto AuditLog:

A identidade do autor da chamada é mantida no campo AuthenticationInfo. Isso pode incluir o principalEmail do usuário. Essas informações às vezes são editadas.

Se um JSON Web Token (JWT, na sigla em inglês) for usado para a autenticação de terceiros, o campo thirdPartyPrincipal vai conter o cabeçalho e o payload do token. Por exemplo, os registros de auditoria para solicitações autenticadas com o Firebase Authentication incluem o token de autenticação dessa solicitação.
O campo callerIp no objeto requestMetadata de uma entrada AuditLog inclui o endereço IP do autor da chamada.

Duração do processamento

Para ver o tempo necessário para processar uma solicitação DATA_READ ou DATA_WRITE, consulte o campo processing_duration no objeto metadata de uma AuditLog.

processing_duration descreve o tempo que o banco de dados levou para processar uma solicitação. Isso é menor que a latência do usuário final. Em especial, isso não inclui a sobrecarga de rede.

Para solicitações Listen, processing_duration está presente apenas no registro de auditoria do conjunto de resultados inicial retornado. Ele não tem os registros de auditoria subsequentes para o mesmo destino Listen.

Formato do registro de auditoria

As entradas de registro de auditoria incluem os seguintes objetos:

A própria entrada de registro, que é um objeto do tipo LogEntry. Veja alguns campos úteis:
- O logName contém o ID do recurso 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.

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

Nome do registro

Os nomes dos Registros de auditoria do Cloud incluem identificadores de recursos que indicam o projeto do Google Cloud ou outra entidade do Google Cloud proprietária dos registros de auditoria e se o registro tem dados de registro de auditoria de atividade do administrador, acesso a dados, política negada ou evento do sistema.

Estes são os nomes dos registros de auditoria, que incluem variáveis para os identificadores de recursos:

   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

   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Factivity
   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Fdata_access
   billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event
   billingAccounts/BILLING_ACCOUNT_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

Nome do serviço

Os registros de auditoria do Firestore usam o nome de serviço firestore.googleapis.com.

Veja uma lista de todos os nomes de serviço da API Cloud Logging e o tipo de recurso monitorado correspondente em Mapear serviços para recursos.

Tipos de recurso

Os registros de auditoria do Firestore usam os tipos de recurso datastore_database e datastore_index.

Confira uma lista de todos os tipos de recursos monitorados do Cloud Logging e informações descritivas em Tipos de recursos monitorados.

Identidades de autor da chamada

O endereço IP do autor da chamada é mantido no campo RequestMetadata.caller_ip do objeto AuditLog. O Logging pode encobrir determinadas identidades e endereços IP de autor da chamada.

Para saber quais informações são editadas nos registros de auditoria, consulte Identidades de autores de chamadas nos registros de auditoria.

Ativar registros de auditoria

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

Por padrão, os registros de auditoria de acesso a dados são desativados e não são gravados, a menos que essa opção seja ativada. Os registros de auditoria de acesso a dados do BigQuery são uma exceção e não podem ser desativados.

Para informações sobre como ativar alguns ou todos os registros de auditoria de acesso a dados, consulte Habilitar registros de auditoria de acesso a dados.

Permissões e papéis

As permissões e papéis do IAM determinam a capacidade de acessar dados de registros de auditoria nos recursos do Google Cloud.

Ao decidir as permissões e papéis específicos do Logging que se aplicam ao seu caso de uso, considere o seguinte:

O papel Visualizador de registros (roles/logging.viewer) fornece acesso somente leitura aos registros de auditoria de atividade do administrador, política negada e eventos do sistema. Se você tiver apenas esse papel, não será possível acessar os registros de auditoria de acesso a dados que estão no bucket _Default.
O papel Visualizador de registros particulares (roles/logging.privateLogViewer inclui as permissões contidas em roles/logging.viewer, além da capacidade de ler os registros de auditoria de acesso a dados no bucket _Default.

Observe que, se esses registros privados forem armazenados em buckets definidos pelo usuário, qualquer usuário que tenha permissões para ler registros nesses intervalos poderá ler os registros privados. Para mais informações sobre buckets de registro, consulte Visão geral de roteamento e armazenamento.

Para mais informações sobre as permissões e os papéis do IAM que se aplicam aos dados de registros de auditoria, consulte Controle de acesso com IAM.

Mostrar registros

É possível consultar todos os registros de auditoria ou fazer consultas individuais pelo nome do registro de auditoria. O nome do registro de auditoria inclui o identificador de recurso do projeto, da pasta, da conta de faturamento ou da organização do Google Cloud com as informações de registro de auditoria que você quer consultar. Suas consultas podem especificar campos LogEntry indexados e, se você usar a página Análise de dados de registros, que é compatível com consultas SQL, será possível conferir os resultados da consulta como um gráfico.

Para mais informações sobre como consultar seus registros, consulte as seguintes páginas:

É possível conferir os registros de auditoria no Cloud Logging usando o console do Google Cloud, a CLI do Google Cloud ou a API Logging.

Console

No Console do Google Cloud, é possível usar a Análise de Registros para recuperar as entradas de registro de auditoria do projeto do Google Cloud, da pasta ou da organização:

No painel de navegação do console do Google Cloud, selecione Logging e clique em Análise de registros:
Acessar a Análise de registros
Selecione um projeto do Google Cloud, uma pasta ou uma organização.
Para exibir todos os registros de auditoria, insira uma das seguintes consultas no campo do editor de consultas e clique em Executar consulta:
```
logName:"cloudaudit.googleapis.com"
```
```
protoPayload."@type"="type.googleapis.com/google.cloud.audit.AuditLog"
```
Para exibir os registros de auditoria de um recurso e tipo de registro específicos, no painel Criador de consultas, faça o seguinte:
- Em Tipo de recurso, selecione o recurso do Google Cloud com os registros de auditoria que você quer consultar.
- Em Nome do registro, selecione o tipo de registro de auditoria que você quer consultar.
  - 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.
- Clique em Executar consulta.
Se você não encontrar essas opções, isso significa que não há registros de auditoria desse tipo disponíveis no projeto do Google Cloud, na pasta ou na organização.

Se você estiver com problemas para conferir registros na Análise de registros, consulte as informações de solução de problemas.

Para mais informações sobre como consultar usando a Análise de Registros, consulte Criar consultas na Análise de Registros. Para informações sobre como resumir entradas na Análise de registros usando o Gemini, consulte Resumir entradas de registro com a assistência do Gemini.

gcloud

A Google Cloud CLI fornece uma interface de linha de comando para a API Logging. Insira um identificador de recurso válido em cada um dos nomes de registro. Por exemplo, se a consulta incluir um PROJECT_ID, o identificador do projeto que você fornecer precisará fazer referência ao projeto do Google Cloud selecionado.

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 este comando:

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

Para ler as entradas de registro de auditoria na conta do Cloud Billing, execute este comando:

gcloud logging read "logName : billingAccounts/BILLING_ACCOUNT_ID/logs/cloudaudit.googleapis.com" \
    --billing-account=BILLING_ACCOUNT_ID

Adicione a sinalização --freshness ao comando para ler registros com mais de um dia.

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

API

Ao criar consultas, informe um identificador de recurso válido em cada um dos nomes de registro. Por exemplo, se a consulta incluir um PROJECT_ID, o identificador do projeto que você fornecer precisará fazer referência ao projeto do Google Cloud selecionado.

Por exemplo, para usar a API Logging para visualizar as entradas de registro de auditoria para envolvidos no projeto:

Acesse a seção Testar esta API da documentação do método entries.list.
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"
}
```
Clique em Executar.

Encaminhar registros de auditoria

É possível encaminhar registros de auditoria para destinos suportados da mesma maneira que é possível rotear outros tipos de registros. Confira alguns motivos para Encaminhar 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 encaminhar registros de qualquer ou todos os projetos do Google Cloud na organização.

Se os registros ativados de auditoria de acesso a dados estiverem enviando seus projetos do Google Cloud para as cotas de registros, você poderá criar coletores que excluam os registros de auditoria de acesso a dados do Logging.

Para instruções sobre o roteamento de registros, consulte Rotear registros para destinos compatíveis.

Preços

Para mais informações sobre preços, consulte o Resumo de preços do Cloud Logging.