Run a few sanity checks on your logical PostgreSQL replica to make sure its the same as the primary.
Project description
pg-replica-auditor
Features
Assumptions
These tests assume that id
and updated_at
(or column specified in --lag-column
) columns exist and have indexes for efficient querying and that the table exists on both databases.
Row comparison
Runs row comparisons between primary and replica using two methods:
- select 8128 rows (or number of rows given to
--rows
) at random betweenMIN(id)
andMAX(id)
- select the last 1000 rows.
Replica lag
Checks for "replica lag" by comparing MAX(updated_at)
on the given table on both databases.
MinMax
Checks that the minimum id
and the maximum id
match on both replica and primary. These can drift a little because of replica lag.
Bulk 1000 Sum
Take the sum of the id
column in chunks of 1000 and compare it between databases. This assumes that retrieving rows in bulk is easier than at random and runs faster than the row comparison and can scan more rows.
Requirements
- Python 3
- Postgres development files (required by psycopg2). On Mac OS, use
brew install postgresql
. On Ubuntu, installlibpq-dev
.
Installation
Development
Using virtualenv, pip install -r requirements.txt
Production
Using Pypi, pip install pg-replica-auditor
.
Usage
This script requires three arguments:
--primary
, any acceptable Postgres connection string (incl. DSN),--replica
, same as--primary
but for the replica database,
Optional arguments:
--exclude-tables
, excludes the comma-separated tables from the scan,--table
, only scans this table,--debug
, will print debugging information,--rows
, will scan this many rows in the row comparisons check,--lag-column
, will use this column for the replica lag check,--show-skipped
, will print the skipped rows in the Last 1000 check.
Example:
$ pgreplicaauditor --primary=postgres://primary-db.amazonaws.com:5432/my_db --replica=postgres://replica-db.amazonaws.com:5432/my_db --table=immutable_items --lag-column created_at
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pg_replica_auditor-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87744fd4ae68ee30209d75c9367f831b47ef442fc7178a55f8f8e98704074313 |
|
MD5 | 12682790e70073628f3f7d8e1773076d |
|
BLAKE2b-256 | a3345fd1875064b89e9848b16b8b28ceea496629887dbdab523160b76e2f26ad |