Strategy ONE

Archive Historical Platform Analytics Transaction-Level Data to Cloud Storage

Beginning in Strategy One (October 2025), you can move unused, old data from an environment’s historical tables to cloud storage to reduce the size of the Platform Analytics warehouse. If needed, you can restore the historical data. The benefits of archiving old data include:

  • Reducing the database size

  • Improving query performance

Archiving is supported for both instance-based and container-based deployments in AWS Cloud.

Configuration

The environment must have cloud upload capability (to S3).

  • For container-based environments, configure using the following environment variables:

    Variable

    Description

    Example Default
    HISTORICAL_RETENTION_CUTOFF_DAYS Number of days of historical data to retain in the database 365 365
    DEPLOYMENT_TYPE

    Deployment type

    • MCE only

    mce

     

    DEPLOYMENT_MODE Cloud provider aws  
    BUCKET_NAME Target cloud storage bucket name mci-prod-archive

     

    ENV_ID Unique environment ID test2  
  • For instance-based environments, use the archive-config.yaml file as shown below:

    Copy
    configuration:
      historicalRetentionCutoffDays: 365
      deploymentType: mce
      deploymentMode: aws
      bucketName: mci-dev-pa
      envId: test2

Backup Process

The backup process is triggered as part of the daily Extract, Transform, Load (ETL) process which is scheduled in the PAConsumerConfig.yaml file. Even though the process is triggered on daily basis, the backup is taken on a weekly basis for last 7 days.

Restore Process

The restore API allows you to restore data for a certain time frame. You provide the start and end date. The restore process restores for a whole week of data, including the start date and end date.

Required Privileges

You must have the following privileges:

  • Bypass all object security access check

  • Administer environment

Status API

Check if a restore is running and how many backups are completed.

Request:

Copy
GET /api/telemetry/admin/restore/status

Restore API

Trigger a restore between a date range.

Request:

Copy
POST /api/telemetry/admin/restore

Body:

Copy
{
  "startDate": "2023-12-04",
  "endDate": "2024-10-01"
}

Tracking and Monitoring

The historical_table_backup_tracker table inside the Platform Analytics Warehouse is used to monitor backup and restore operations. The important fields to track in the table are:

Field

Description

Notes
zip_address Location of archived backup file in cloud Primary reference
downloaded true when a backup has been restored to the database Key restore check
uploaded 1 when the backup is successfully uploaded to the cloud Key backup check
processing_status Current status of the job First indicator of an error
last_error Captures the error message if a backup fails Critical for troubleshooting
file_size Size of the archived file Useful for capacity planning
md5_checksum Integrity check for archive Ensures no corruption