LoadDensity English Documentation

The English manual is split into chapters that follow a typical reader journey: install → run a load test → author actions → harden → scale → integrate. Use the table of contents on the left, or jump straight to a chapter below.


Chapter 1 — Getting Started

Install LoadDensity, run your first load test, and scaffold a project.

Chapter 2 — Core API

The Locust-facing facade: environments, runners, and user proxies. Read this once and the rest of the framework stops feeling magical.

Chapter 3 — Action Authoring & Execution

Compose JSON-driven action scripts, parameterise data, build scenarios, and chain post-test callbacks.

Chapter 4 — User Templates

The protocol drivers: HTTP, FastHttp, Async HTTP/2, WebSocket, SSE, gRPC (unary + streaming), MQTT, raw TCP/UDP, SQL, Redis, Kafka, and MongoDB. Each template registers as a Locust user with the same task contract.

Chapter 5 — Reporting & Observability

Generate HTML / JSON / XML / CSV / JUnit / percentile-summary / chart reports, ship metrics to Prometheus, InfluxDB, OTLP, or Datadog DogStatsD, and stream live progress to a browser.

Chapter 6 — Orchestration & Scale

Run distributed master/worker fleets, share state through the parameter resolver, gate execution on extracted variables, and steer ramps with built-in load shapes.

Chapter 7 — Reliability

Adaptive retry, failure budget / circuit breaker, network conditioner, and process supervisor — the controls that make unattended CI runs safe.

Chapter 8 — Recording, Data & Importers

Convert real browser traffic (HAR), Postman v2.1 collections, OpenAPI 3.x specs, standalone cURL commands, k6 scripts, and JMeter JMX plans into runnable action JSON. Persist test records to SQLite, compare runs over time.

Chapter 9 — Auth

OAuth2 token helpers with cache, JWT signing (HS / RS), AWS Signature v4, and mTLS client-cert support on every HTTP user template.

Chapter 10 — Tooling, CLI & Diagnostics

Command-line subcommands, the hardened control socket server, exception hierarchy, plus the editor & CI integrations: linter, schema, LSP, VS Code extension, GitHub Action, and pre-commit.

Chapter 11 — Integrations

The optional GUI and the Model Context Protocol (MCP) server that lets Claude drive LoadDensity.

Chapter 12 — API Reference

Auto-generated Python API reference.

Reference