View audit logs for automated backups

MySQL   |  PostgreSQL   |  SQL Server

This page describes how to view an audit log for an automated backup of your Cloud SQL instance.

You can use audit logs to do the following:

• View an audit log to verify whether the backup is completed successfully.
• Configure a log-based alert to notify you of the backup's status.

View an audit log

You can use the Google Cloud console, gcloud CLI, or API to view an audit log to verify whether a backup is completed successfully within a backup window.

Console

1. In the Google Cloud console, select Logging and then select Logs Explorer.

   Go to Logs Explorer

2. To filter for audit logs for automated backups of Cloud SQL instances, run the following query:

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

   Replace PROJECT_ID with your Google Cloud project's ID.

   The first expression filters for System Event audit logs. The second expression filters for audit logs for automated backups. The final expression filters for audit logs for Cloud SQL instances.

   For more information about how to use the Google Cloud console to query for audit logs, see View logs.

3. View the status of a backup created during the backup window. This status is displayed in the windowStatus field. To view this field, complete the following steps:

   1. Click the audit log.
   2. Click the metadata field.

gcloud

1. To filter for audit logs for automated backups of Cloud SQL instances, run the following query:

   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
   

   Replace PROJECT_NAME with your Google Cloud project's name.

   The first expression filters for System Event audit logs. The second expression filters for audit logs for automated backups. The final expression filters for audit logs for Cloud SQL instances.

   For more information about how to use gcloud to query for audit logs, see View logs.

2. View the status of a backup created during the backup window. This status is displayed in the windowStatus field.

API

Before using any of the request data, make the following replacements:

• PROJECT_ID: The ID of your Google Cloud project.

For the request JSON body, the first expression filters for System Event audit logs. The second expression filters for audit logs for automated backups. The final expression filters for audit logs for Cloud SQL instances.

For more information about how to use the API to query for audit logs, see View logs.

HTTP method and URL:

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

Request JSON body:

{
     "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"
} 

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Save the request body in a file named request.json, and execute the following command:

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)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Save the request body in a file named request.json, and execute the following command:

$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

You should receive a JSON response similar to the following:

Response

{
  "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"
    },
 ],
}

For more information about LOG_ENTRY_UNIQUE_IDENTIFIER for the insertId field, see LogEntry.

View the status of a backup created during the backup window. This status is displayed in the windowStatus field.

Automated backup statuses

• STATUS_SUCCEEDED: The automated backup is completed successfully.

• STATUS_ATTEMPT_FAILED: Cloud SQL tried to create the backup, but the backup either didn't start or it failed. Reasons for this status include:

  • Another backup is running on the instance.
  • The backup location is restricted by your organization policy.
  • The backup of the instance completed, but an error occurred.
  • The instance wasn't running when Cloud SQL tried to create the backup.

• STATUS_FAILED: The automated backup of the instance either hasn't completed successfully or can't be completed within the backup window.

  For example, if you enabled automated backups and scheduled the backup window for between 1:00 am and 5:00 am, your backup might fail if you have many EXPORT operations during this time frame. Automated backups might also fail if there are too many conflicts with an EXPORT operation that runs for a long time.

  If Cloud SQL tries to create a backup multiple times during a backup window, but the backup can't be created for the reasons listed for STATUS_ATTEMPT_FAILED, Cloud SQL generates another audit log with the windowStatus field set to STATUS_FAILED.

• STATUS_SKIPPED: The Cloud SQL instance stopped running since the last successful backup. Therefore, a new automated backup wasn't created.

Configure a log-based alert

You can configure a log-based alert to notify you of the backup's status.

• If a backup has a STATUS_SUCCEEDED status, you can be notified for tracking purposes.
• If a backup has the STATUS_FAILED or STATUS_ATTEMPT_FAILED status, you can be notified to take corrective action, based on the message that appears in the log entry. You can also take an on-demand backup before the next scheduled backup window.
• If a backup has a STATUS_SKIPPED status, you can be notified to restart the Cloud SQL instance.

What's next

• Learn more about backing up your data.
• Learn more about creating and managing backups.
• Learn more about restoring data.
• Learn more about point-in-time recovery.
• See how to restore your data from a backup.
• See how to perform a point-in-time recovery.