Acessar registros de auditoria para backups automatizados

MySQL   |  PostgreSQL   |  SQL Server

Nesta página, descrevemos como acessar um registro de auditoria para um backup automatizado da sua instância do Cloud SQL.

Use os registros de auditoria para fazer o seguinte:

• Acessar um registro de auditoria para verificar se o backup foi concluído.
• Configurar um alerta baseado em registro para notificar sobre o status do backup.

Acessar um registro de auditoria

É possível usar o console do Google Cloud, gcloud CLI ou a API para acessar um registro de auditoria para verificar se um backup foi concluído em uma janela de backup.

Console

1. No console do Google Cloud, selecione Logging e depois Explorador de registros.

   Acessar o Explorador de registros

2. Para filtrar registros de auditoria de backups automatizados de instâncias do Cloud SQL, execute a seguinte consulta:

   logName="projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event"
   protoPayload.methodName="cloudsql.instances.automatedBackup"
   resource.type="cloudsql_database"
   

   Substitua PROJECT_ID pelo ID do projeto do Google Cloud.

   A primeira expressão filtra registros de auditoria de eventos do sistema.. A segunda expressão filtra registros de auditoria de backups automatizados. Os filtros de expressão final filtram os registros de auditoria das instâncias do Cloud SQL.

   Para mais informações sobre como usar o console do Google Cloud para consultar registros de auditoria, consulte Acessar registros.

3. Acesse o status de um backup criado durante a janela de backup. Esse status é exibido no campo windowStatus. Para acessar esse campo, siga estas etapas:

   1. clique no registro de auditoria;
   2. clique no campo metadata.

gcloud

1. Para filtrar registros de auditoria de backups automatizados de instâncias do Cloud SQL, execute a seguinte consulta:

   gcloud logging read \
   "logName=projects/PROJECT_NAME/logs/cloudaudit.googleapis.com%2Fsystem_event
   AND protoPayload.methodName=cloudsql.instances.automatedBackup AND
   resource.type=cloudsql_database" \
       --project=PROJECT_NAME
   

   Substitua PROJECT_NAME pelo nome do seu projeto do Google Cloud.

   A primeira expressão filtra registros de auditoria de eventos do sistema.. A segunda expressão filtra registros de auditoria de backups automatizados. Os filtros de expressão final filtram os registros de auditoria das instâncias do Cloud SQL.

   Para mais informações sobre como usar gcloud para consultar registros de auditoria, consulte Acessar registros.

2. Acesse o status de um backup criado durante a janela de backup. Esse status é exibido no campo windowStatus.

API

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do projeto do Google Cloud.

Para o corpo JSON da solicitação, a primeira expressão filtra Registros de auditoria de eventos do sistema. A segunda expressão filtra registros de auditoria de backups automatizados. Os filtros de expressão final filtram os registros de auditoria das instâncias do Cloud SQL.

Para mais informações sobre como usar a API para consultar registros de auditoria, consulte Acessar registros.

Método HTTP e URL:

POST https://logging.googleapis.com/v2/entries:list

Corpo JSON da solicitação:

{
     "resourceNames": [
     "projects/PROJECT_ID"
      ],
     "pageSize": 5,
     "filter": "logName=projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event AND protoPayload.methodName = cloudsql.instances.automatedBackup AND resource.type=cloudsql_database",
     "orderBy": "timestamp desc"
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://logging.googleapis.com/v2/entries:list"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://logging.googleapis.com/v2/entries:list" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

Resposta

{
  "entries": [
    {
      "protoPayload": {
        "@type": "type.googleapis.com/google.cloud.audit.AuditLog",
        "status": {
          "message": "OK"
        },
        "authenticationInfo": {},
        "requestMetadata": {
          "requestAttributes": {},
          "destinationAttributes": {}
        },
        "serviceName": "cloudsql.googleapis.com",
        "methodName": "cloudsql.instances.automatedBackup",
        "resourceName": "projects/PROJECT_ID/instances/INSTANCE_NAME",
        "metadata": {
          "windowStartTime": "2022-12-15T13:00:00Z",
          "message": "",
          "windowStatus": "STATUS_SUCCEEDED",
          "@type": "type.googleapis.com/speckle.AutomatedBackupEventLog",
          "windowEndTime": "2022-12-15T17:00:00Z",
          "backupCompletionTime": "2022-12-15T14:11:57.347Z",
          "backupStartTime": "2022-12-15T14:11:16.631Z"
        }
      },
      "insertId": "LOG_ENTRY_UNIQUE_IDENTIFIER",
      "resource": {
        "type": "cloudsql_database",
        "labels": {
          "region": "REGION_NAME",
          "project_id": "PROJECT_ID",
          "database_id": "DATABASE_ID"
        }
      },
      "timestamp": "2022-12-15T14:11:57.391565Z",
      "severity": "INFO",
      "logName": "projects/PROJECT_ID/logs/cloudaudit.googleapis.com%2Fsystem_event",
      "receiveTimestamp": "2022-12-15T14:11:57.785814800Z"
    },
 ],
}

Para mais informações sobre LOG_ENTRY_UNIQUE_IDENTIFIER para o campo insertId, consulte LogEntry.

Acesse o status de um backup criado durante a janela de backup. Esse status é exibido no campo windowStatus.

Status de backup automatizado

• STATUS_SUCCEEDED: o backup automático foi concluído.

• STATUS_ATTEMPT_FAILED: o Cloud SQL tentou criar o backup, mas ele não foi iniciado ou falhou. Os motivos para esse status incluem:

  • Outro backup está em execução na instância.
  • O local do backup é restrito pela política da sua organização.
  • O backup da instância foi concluído, mas ocorreu um erro.
  • A instância não estava em execução quando o Cloud SQL tentou criar o backup.

• STATUS_FAILED: o backup automático da instância não foi concluído com êxito ou não pode ser concluído na janela de backup.

  Por exemplo, se você ativou backups automáticos e programou a janela de backup entre 1h e 5h, seu backup pode falhar se você tiver muitas operações EXPORT durante esse período. Os backups automatizados também podem falhar se houver muitos conflitos com uma operação EXPORT que é executada por muito tempo.

  Se o Cloud SQL tentar criar um backup várias vezes durante uma janela de backup, mas não for possível criar o backup pelos motivos listados para STATUS_ATTEMPT_FAILED, o Cloud SQL gera outro registro de auditoria com o campo windowStatus definido como STATUS_FAILED.

• STATUS_SKIPPED: a instância do Cloud SQL deixou de ser executada desde o último backup bem-sucedido. Por isso, um novo backup automático não foi criado.

Configurar um alerta baseado em registros

É possível configurar um alerta baseado em registro para notificar você sobre o status do backup.

• Se um backup tiver o status STATUS_SUCCEEDED, você poderá receber uma notificação para fins de rastreamento.
• Se um backup tiver o status STATUS_FAILED ou STATUS_ATTEMPT_FAILED, você poderá receber uma notificação para realizar ações corretivas com base na mensagem que aparece na entrada de registro. Também é possível fazer um backup sob demanda antes da próxima janela de backup programada.
• Se um backup tiver o status STATUS_SKIPPED, você pode receber uma notificação para reiniciar a instância do Cloud SQL.

A seguir

• Aprenda a fazer backup dos dados.
• Saiba mais sobre como criar e gerenciar backups.
• Aprenda a restaurar dados.
• Saiba como restaurar dados de um backup.
• Saiba como executar uma recuperação pontual.