n8n/packages/quality/efficiency/README.md

1.2 KiB

Efficiency tooling

This area owns resource measurements, microbenchmarks, and load-test tools. The root @n8n/efficiency workspace uses Playwright with shared reporting from n8n-playwright. Its configuration owns the efficiency projects and their scopes. Suites live in folders such as images/.

Tool Use it to Guide
@n8n/efficiency Measure Docker image size and layer waste with Dive Image measurements
@n8n/efficiency Measure idle memory with fixed container profiles Idle memory baselines
@n8n/performance Compare code paths without building an n8n Docker image Microbenchmarks
@n8n/n8n-benchmark Run load scenarios against an n8n instance Benchmark CLI

For memory retention, canvas performance, throughput, and local soak tests, use the Playwright suite map.

Run image measurements with pnpm --filter @n8n/efficiency test:images. Run idle memory baselines with pnpm --filter @n8n/efficiency test:memory. The nested microbenchmark and benchmark CLI workspaces keep their own commands and configurations.