Skip to content

docs: Add a load testing guide under Operations - #785

Merged
developerjamiu merged 5 commits into
serverpod:mainfrom
abdulawalarif:docs/add-load-testing-guide
Sep 7, 2026
Merged

docs: Add a load testing guide under Operations#785
developerjamiu merged 5 commits into
serverpod:mainfrom
abdulawalarif:docs/add-load-testing-guide

Conversation

@abdulawalarif

Copy link
Copy Markdown
Contributor

Summary

  • Adds an Operations page for measuring a production-like Serverpod server under concurrent traffic, with Locust as the default path and the generated Dart client for typed, authenticated, and streaming scenarios.
  • Makes it explicit that Serverpod does not ship a load-testing tool, and that withServerpod is for correctness tests, not throughput.
  • Covers the HTTP POST JSON call shape, what to measure in Insights, health probes, session logs, and Postgres, plus settings that silently invalidate a run (dev mode, JIT, pool of 10, session-log write amplification, single isolate).
  • Cross-links the page from Operations overview, testing get-started, logging, and health checks.

Related to serverpod/serverpod#3059. This covers the documentation ask. A first-party load-testing tool is still out of scope.

Test plan

  • Open Concepts → Operations → Load testing and confirm the sidebar label and page title.
  • Follow the Locust example against a local --mode production server and confirm POST /example/hello with a JSON body is the path shown.
  • Click every in-doc link (testing get-started, endpoints, Insights, logging, health checks, configuration, connection pool, streaming, file uploads, authentication, future calls, community Locust scripts).
  • From Get started with testing, Logging, and Health checks, confirm the new Related/Next entries land on the load testing page.

Readers had no documented path for measuring a live Serverpod server under concurrent traffic, and the test tools page is easy to mistake for that job.
Comment thread docs/06-concepts/07-operations/07-load-testing.md
Avoid the Operations 06- collision with the open scalability PR, and list load testing last in the overview so sidebar order stays stable once that page lands.
Comment thread docs/06-concepts/07-operations/07-load-testing.md Outdated
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hi, Jamiu!
Renamed to 07-load-testing.md and moved Load testing last in the overview so it follows Scalability

Comment thread docs/06-concepts/07-operations/07-load-testing.md Outdated
Use a noun-led frontmatter description and correct health probe guidance so it no longer excludes the Insights port.
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hi Jamiu, addressed the noun-led front matter and health probe wording.

…-guide

# Conflicts:
#	docs/06-concepts/07-operations/01-overview.md
@developerjamiu
developerjamiu merged commit 032174b into serverpod:main Sep 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants