Skip to content

Add recommended benchmark profiles to README #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sokovmd merged 1 commit into from
Apr 19, 2026
Merged

Add recommended benchmark profiles to README #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,11 @@ This command is responsible for preparing the database completely. In most proje
The query file paths are resolved relative to the directory that contains `pgcompare.yaml`.
For steadier hot-path measurements, prefer setting `warmup_iterations` to a small positive value instead of leaving the first cold execution inside the measured sample.

Recommended profiles:

- Smoke test: `iterations: 100`, `warmup_iterations: 5`, `repeats: 1`, `concurrency: 1`
- Full benchmark: `iterations: 1000`, `warmup_iterations: 500`, `repeats: 5`, `concurrency: 1`

### `report`

- `description`: optional list rendered at the top of the report
Expand Down
5 changes: 5 additions & 0 deletions RU.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ services:
Пути к SQL-файлам считаются относительно директории, в которой лежит `pgcompare.yaml`.
Для более стабильного измерения steady-state лучше задавать `warmup_iterations` как небольшое положительное значение, а не оставлять первый холодный запуск внутри измеряемой выборки.

Рекомендуемые профили:

- Smoke-тест: `iterations: 100`, `warmup_iterations: 5`, `repeats: 1`, `concurrency: 1`
- Полный бенчмарк: `iterations: 1000`, `warmup_iterations: 500`, `repeats: 5`, `concurrency: 1`

### `report`

- `description`: необязательный список блоков, который показывается в начале отчёта
Expand Down