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 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.
Orchestration
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
- API Reference
- je_load_density
- je_load_density.utils.executor.action_executor
- je_load_density.utils.parameterization.parameter_resolver
- je_load_density.utils.recording.har_importer
- je_load_density.utils.recording.postman_importer
- je_load_density.utils.recording.openapi_importer
- je_load_density.utils.recording.curl_importer
- je_load_density.utils.recording.k6_importer
- je_load_density.utils.recording.jmeter_importer
- je_load_density.utils.metrics.prometheus_exporter
- je_load_density.utils.metrics.influxdb_sink
- je_load_density.utils.metrics.opentelemetry_exporter
- je_load_density.utils.metrics.statsd_sink
- je_load_density.utils.test_record.test_record_class
- je_load_density.utils.test_record.sqlite_persistence
- je_load_density.utils.generate_report.generate_html_report
- je_load_density.utils.generate_report.generate_json_report
- je_load_density.utils.generate_report.generate_xml_report
- je_load_density.utils.generate_report.generate_csv_report
- je_load_density.utils.generate_report.generate_junit_report
- je_load_density.utils.generate_report.generate_summary_report
- je_load_density.utils.generate_report.generate_chart_report
- je_load_density.utils.socket_server.load_density_socket_server
- je_load_density.utils.sla.sla_gates
- je_load_density.utils.regression.diff
- je_load_density.utils.load_shapes.shapes
- je_load_density.utils.throttle.rps_throttle
- je_load_density.utils.linter.action_linter
- je_load_density.utils.schema.action_schema
- je_load_density.utils.ci_annotations.github_actions
- je_load_density.utils.graphql.graphql_task
- je_load_density.utils.reliability.adaptive_retry
- je_load_density.utils.reliability.failure_budget
- je_load_density.utils.reliability.network_conditioner
- je_load_density.utils.reliability.process_supervisor
- je_load_density.utils.dashboard.live_dashboard
- je_load_density.utils.notifier.slack
- je_load_density.utils.notifier.teams
- je_load_density.utils.auth.oauth2
- je_load_density.utils.auth.jwt_signer
- je_load_density.utils.auth.aws_sigv4
- je_load_density.wrapper.create_locust_env.create_locust_env
- je_load_density.wrapper.start_wrapper.start_test
- je_load_density.wrapper.user_template.request_executor
- je_load_density.wrapper.user_template.scenario_runner
- je_load_density.wrapper.user_template.http_user_template
- je_load_density.wrapper.user_template.fast_http_user_template
- je_load_density.wrapper.user_template.async_http_user_template
- je_load_density.wrapper.user_template.websocket_user_template
- je_load_density.wrapper.user_template.sse_user_template
- je_load_density.wrapper.user_template.grpc_user_template
- je_load_density.wrapper.user_template.mqtt_user_template
- je_load_density.wrapper.user_template.kafka_user_template
- je_load_density.wrapper.user_template.socket_user_template
- je_load_density.wrapper.user_template.sql_user_template
- je_load_density.wrapper.user_template.redis_user_template
- je_load_density.wrapper.user_template.mongo_user_template
- je_load_density.action_lsp.server
- je_load_density.mcp_server.server