Registros de atividade

Neste documento, descrevemos como usar o Cloud Logging para geração de registros de atividades com o Identity Platform.

Como ativar a geração de registros de atividades

O registro de atividades é desativado por padrão. É possível ativar o registro de atividades pelo console do Google Cloud ou pela API REST:

Console

  1. Acesse a página Configurações no console do Google Cloud.
    Acesse as configurações

  2. Em Registro de atividade do usuário, selecione Ativar.

  3. Clique em Salvar.

REST

curl -d "{'monitoring':{'requestLogging':{'enabled':true}}}" \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -X PATCH -H 'Content-Type: application/json' \
  https://identitytoolkit.googleapis.com/admin/v2/projects/PROJECT_ID/config?updateMask=monitoring.requestLogging.enabled

Substitua PROJECT_ID pelo ID do projeto.

Ativar o registro de atividades pode afetar seu faturamento. Consulte os Preços da Observabilidade do Google Cloud para saber mais.

Como ativar o registro de atividades para projetos de locatário

A geração de registros de atividades para projetos de locatário está desativada por padrão. É possível ativar a geração de registros de atividades para projetos de locatário usando a API REST executando o seguinte comando:

curl -d "{'monitoring':{'requestLogging':{'enabled':true}}}" \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -X PATCH -H 'Content-Type: application/json' \
  https://identitytoolkit.googleapis.com/v2/projects/PROJECT_ID/tenants/TENANT_ID?updateMask=monitoring.requestLogging.enabled

Substitua:

  • PROJECT_ID: o ID do projeto;
  • TENANT_ID: o ID do locatário.

A ativação desse recurso pode afetar seu faturamento. Consulte Preços do Google Cloud Observability para saber mais.

Como visualizar registros de atividades

Quando o Logging está ativado, uma entrada de registro é gerada para cada solicitação do usuário. Cada entrada de registro inclui os seguintes campos:

Campo Descrição
logName projects/PROJECT_ID/logs/identitytoolkit.googleapis.com/requests
resource identitytoolkit_project or identitytoolkit_tenant
serviceName identitytoolkit.googleapis.com
protoPayload A solicitação ou resposta registrada.

É possível conferir os registros de atividades do seu projeto ou locatário usando o Explorador de registros. Para ver os registros:

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

    Acessar a página Análise de registros

  2. Selecione Identity Toolkit Project ou Identity Toolkit Tenant na lista suspensa de recursos. Se você estiver usando a multilocação, poderá mostrar todos os locatários ou filtrar a um específico.

Operações registradas

A tabela a seguir lista as operações de API que podem produzir registros de atividades:

Serviço Método
google.cloud.identitytoolkit.v1.AccountManagementService DeleteAccount
GetAccountInfo
GetOobCode
ResetPassword
SetAccountInfo
google.cloud.identitytoolkit.v1.AuthenticationService CreateAuthUri
GetRecaptchaParam
SendVerificationCode
SignInWithCustomToken
SignInWithEmailLink
SignInWithGameCenter
SignInWithIdp
SignInWithPassword
SignInWithPhoneNumber
SignUp
VerifyIosClient
google.cloud.identitytoolkit.v1.ProjectConfigService GetProjectConfig

Como excluir operações

O Logging fornece ferramentas para desativar o processamento de registros ou excluir as entradas de registro que você não quer. Para saber mais informações sobre como excluir determinados registros, consulte Exclusões de registros.

O exemplo a seguir mostra como excluir registros para os métodos somente leitura GetAccountInfo() e GetProjectConfig():

resource.type="identitytoolkit_project"
(
 jsonPayload.methodName="google.cloud.identitytoolkit.v1.AccountManagementService.GetAccountInfo"
 OR
 jsonPayload.methodName="google.cloud.identitytoolkit.v1.ProjectConfigService.GetProjectConfig"
)