Repository files navigation

Ptrack is a block-level incremental backup engine for PostgreSQL. You caneffectively useptrack engine for taking incremental backups withpg_probackup backup and recovery manager for PostgreSQL.

It is designed to allow false positives (i.e. block/page is marked in theptrack map, but actually has not been changed), but to never allow false negatives (i.e. loosing anyPGDATA changes, excepting hint-bits).

Currently,ptrack codebase is split between small PostgreSQL core patch and extension. All public SQL API methods and main engine are placed in theptrack extension, while the core patch contains only certain hooks and modifies binary utilities to ignoreptrack.map.* files.

This extension is compatible with PostgreSQL11,12,13,14.

1. Get latestptrack sources:

git clone https://github.com/postgrespro/ptrack.git

2. Get latest PostgreSQL sources:

git clone https://github.com/postgres/postgres.git -b REL_14_STABLE&&cd postgres

3. Apply PostgreSQL core patch:

git apply -3 ../ptrack/patches/REL_14_STABLE-ptrack-core.diff

4. Compile and install PostgreSQL

5. Setptrack.map_size (in MB)

echo"shared_preload_libraries = 'ptrack'">> postgres_data/postgresql.confecho"ptrack.map_size = 64">> postgres_data/postgresql.conf

6. Compile and installptrack extension

USE_PGXS=1 make -C /path/to/ptrack/ install

7. Run PostgreSQL and createptrack extension

postgres=# CREATE EXTENSION ptrack;

The only one configurable option isptrack.map_size (in MB). Default is0, which meansptrack is turned off. In order to reduce number of false positives it is recommended to setptrack.map_size to1 / 1000 of expectedPGDATA size (i.e.1000 for a 1 TB database).

To disableptrack and clean up all remaining service files setptrack.map_size to0.

• ptrack_version() — returns ptrack version string.
• ptrack_init_lsn() — returns LSN of the last ptrack map initialization.
• ptrack_get_pagemapset(start_lsn pg_lsn) — returns a set of changed data files with a number of changed blocks and their bitmaps since specifiedstart_lsn.
• ptrack_get_change_stat(start_lsn pg_lsn) — returns statistic of changes (number of files, pages and size in MB) since specifiedstart_lsn.

Usage example:

postgres=# SELECT ptrack_version(); ptrack_version----------------2.3(1 row)postgres=# SELECT ptrack_init_lsn(); ptrack_init_lsn-----------------0/1814408(1 row)postgres=# SELECT * FROM ptrack_get_pagemapset('0/185C8C0');path         | pagecount |                pagemap---------------------+-----------+---------------------------------------- base/16384/1255     |3 | \x001000000005000000000000 base/16384/2674     |3 | \x0000000900010000000000000000 base/16384/2691     |1 | \x00004000000000000000000000 base/16384/2608     |1 | \x000000000000000400000000000000000000 base/16384/2690     |1 | \x000400000000000000000000(5 rows)postgres=# SELECT * FROM ptrack_get_change_stat('0/285C8C8'); files | pages |        size, MB-------+-------+------------------------20 |25 |0.19531250000000000000(1 row)

Usually, you have to only install new version ofptrack and doALTER EXTENSION 'ptrack' UPDATE;. However, some specific actions may be required as well:

• Putshared_preload_libraries = 'ptrack' intopostgresql.conf.
• Renameptrack_map_size toptrack.map_size.
• DoALTER EXTENSION 'ptrack' UPDATE;.
• Restart your server.

Since version 2.2 we use a different algorithm for tracking changed pages. Thus, data recorded in theptrack.map using pre 2.2 versions ofptrack is incompatible with newer versions. After extension upgrade and server restart oldptrack.map will be discarded withWARNING and initialized from the scratch.

• Stop your server
• Update ptrack binaries
• Remove global/ptrack.map.mmap if it exist in server data directory
• Start server
• DoALTER EXTENSION 'ptrack' UPDATE;.

1. You can only useptrack safely withwal_level >= 'replica'. Otherwise, you can lose tracking of some changes if crash-recovery occurs, sincecertain commands are designed not to write WAL at all if wal_level is minimal, but we only durably flushptrack map at checkpoint time.

2. The only one production-ready backup utility, that fully supportsptrack ispg_probackup.

3. You cannot resizeptrack map in runtime, only on postmaster start. Also, you will loose all tracked changes, so it is recommended to do so in the maintainance window and accompany this operation with full backup.

4. You will need up toptrack.map_size * 2 of additional disk space, sinceptrack uses additional temporary file for durability purpose. SeeArchitecture section for details.

Briefly, an overhead of usingptrack on TPS usually does not exceed a couple of percent (~1-3%) for a database of dozens to hundreds of gigabytes in size, while the backup time scales down linearly with backup size with a coefficient ~1. It means that an incrementalptrack backup of a database with only 20% of changed pages will be 5 times faster than a full backup. More detailshere.

We use a single shared hash table inptrack. Due to the fixed size of the map there may be false positives (when some block is marked as changed without being actually modified), but not false negative results. However, these false postives may be completely eliminated by setting a high enoughptrack.map_size.

All reads/writes are made using atomic operations onuint64 entries, so the map is completely lockless during the normal PostgreSQL operation. Because we do not use locks for read/write access,ptrack keeps a map (ptrack.map) since the last checkpoint intact and uses up to 1 additional temporary file:

• temporary fileptrack.map.tmp to durably replaceptrack.map during checkpoint.

Map is written on disk at the end of checkpoint atomically block by block involving the CRC32 checksum calculation that is checked on the next whole map re-read after crash-recovery or restart.

To gather the whole changeset of modified blocks inptrack_get_pagemapset() we walk the entirePGDATA (base/**/*,global/*,pg_tblspc/**/*) and verify using map whether each block of each relation was modified since the specified LSN or not.

Feel free tosend pull requests,fill up issues, or just reach one of us directly (e.g. <Alexey Kondratov,@ololobus>) if you are interested inptrack.

Everything is tested automatically withtravis-ci.com andcodecov.io, but you can also run tests locally viaDocker:

export PG_BRANCH=REL_14_STABLEexport TEST_CASE=allexport MODE=paranoia./make_dockerfile.shdocker-compose builddocker-compose run tests

Available test modes (MODE) arebasic (default) andparanoia (per-block checksum comparison ofPGDATA content before and after backup-restore process). Available test cases (TEST_CASE) aretap (minimalistic PostgreSQLtap test),all or any specificpg_probackup test, e.g.test_ptrack_simple.

• Should we introduceptrack.map_path to allowptrack service files storage outside ofPGDATA? Doing that we will avoid patching PostgreSQL binary utilities to ignoreptrack.map.* files.
• Can we resizeptrack map on restart but keep the previously tracked changes?
• Can we write a formal proof, that we never loose any modified page withptrack? With TLA+?