Skip to content

Commit c15e213

Browse files
committed
docs: add related projects section with pg_perf_bench distinction
1 parent 737e28c commit c15e213

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,24 @@ The distribution name and command are `pg-workload`; the import package is `pg_w
1818
wheel contains immutable profile templates and a public `pg_workload/v1` JSON Schema. Runtime
1919
state, logs, credentials, and generated table contents are never packaged.
2020

21+
## Related projects
22+
23+
pg_workload is conceptually different from a benchmark tool such as
24+
[pg_perf_bench](https://github.com/O2eg/pg_perf_bench): a benchmark measures a system
25+
(maximum TPS across a controlled load sweep, with a recreated database and captured
26+
environment evidence for every point), while pg_workload does not measure anything — it
27+
emulates diverse background activity so that an otherwise empty database starts to "live":
28+
queries, plans, locks, WAL, autovacuum, errors, and logs. That living database is then
29+
observed from the other side: diagnostic reports, log parsing, dashboards, and monitoring
30+
pipelines are tested against it.
31+
32+
| Project | How it is used together with pg_workload |
33+
|---|---|
34+
| [pg_stand](https://github.com/O2eg/pg_stand) | Deploys the disposable Docker stands (PostgreSQL 10–18, replication topologies, diagnostic extensions preloaded) that pg_workload loads — the canonical `pg-stand -> pg-workload -> pg-diag` target. |
35+
| [pg_diag](https://github.com/O2eg/pg_diag) | Captures JSON/HTML diagnostic reports of the activity pg_workload generates. Bundled profile READMEs document which pg_diag sections each profile exercises, and `prepare-db` installs the matching default extensions (`pg_stat_statements`, `pg_buffercache`). |
36+
| [pg_play](https://github.com/O2eg/pg_play) | Orchestrates pg_workload through the versioned machine contract `pg_play/component/v1` (plan hashes, desired-state scheduler control) — see [docs/pg_play-integration.md](docs/pg_play-integration.md). |
37+
| [pg_configurator](https://github.com/O2eg/pg_configurator) | Generates versioned PostgreSQL configuration candidates; apply a candidate to the stand and rerun the same pg_workload profiles to observe how behavior changes with the settings. |
38+
2139
## Installation
2240

2341
### Install from PyPI

0 commit comments

Comments
 (0)