LoadDensity
English manual
LoadDensity English Documentation
Chapter 1 — Getting Started
Installation
Requirements
Base install (CLI & library)
Optional extras
Development install
Verify
Getting Started
User types
Run a test (Python API)
Launch the Locust Web UI
Run a JSON action script
Next steps
Create Project
Overview
Python API
CLI
Layout
Chapter 2 — Core API
Architecture
Overview
System overview
Action lifecycle
User dispatch
Module map
Module responsibilities
Action lifecycle, step by step
start_test & prepare_env
Overview
Signature
Supported user types
prepare_env
Distributed mode
Locust Environment
Overview
create_env
prepare_env
Web UI
Stats greenlets
Chapter 3 — Action Authoring & Execution
Action Executor
Overview
Action format
Quick example
LD_* commands
Adding custom commands
Parameter Resolver
Overview
Supported placeholders
Registering data
Action-JSON usage
Extracting values from responses
Clearing
Scenario Modes
Overview
Shape
Weighted picks
Conditional flow
Assertions & Extractors
Overview
Assertions
Extractors
Callback Executor
Basic Usage
How It Works
Available Trigger Functions
Passing Parameters to Callbacks
Parameters
Error Handling
Dynamic Package Loading
Basic Usage
How It Works
PackageManager API
Example: Using a Custom Package
Using in JSON Scripts
Chapter 4 — User Templates
HTTP Users
Overview
Task fields
Example
WebSocket User
Overview
Task fields
Example
gRPC User
Overview
Task fields
Example
MQTT User
Overview
Task fields
Example
Raw TCP / UDP User
Overview
Task fields
Example
Chapter 5 — Reporting & Observability
Report Generation
Overview
HTML
JSON (split by outcome)
XML (split by outcome)
CSV (one row per request)
JUnit XML (CI-friendly)
Summary (percentiles)
Action JSON
Metrics Exporters
Overview
Prometheus
InfluxDB
OpenTelemetry
Stop helpers
Action JSON
Test Record
Overview
Record fields
Clearing between runs
SQLite persistence
Live Dashboard
Overview
Endpoints
Start / stop
Action JSON
Notifiers
Overview
Slack (Block Kit)
Teams (MessageCard)
Datadog DogStatsD
Action JSON commands
Chapter 6 — Orchestration & Scale
Distributed Master / Worker
Overview
Master
Worker
Tips
Chapter 7 — Reliability
Reliability
Overview
Adaptive retry
Failure budget
Network conditioner
Process supervisor
Action JSON commands
Chapter 8 — Recording, Data & Importers
HAR Record / Replay
Overview
Python API
Filters
Mapping rules
Action JSON
Importers
Overview
cURL
HAR
Postman v2.1
OpenAPI 3.x
k6
JMeter JMX
Action JSON commands
SQLite Persistence
Overview
Python API
Schema
Action JSON
Chapter 9 — Auth
Auth
Overview
OAuth2
JWT
AWS SigV4
mTLS
Chapter 10 — Tooling, CLI & Diagnostics
CLI (Command Line Interface)
Subcommands
run
run-dir
run-str
init
serve
Legacy flags
TCP Control Socket Server
Overview
Modes
Auth
Starting the server
Sending commands (framed mode)
Shutdown
Notes
Exceptions
Hierarchy
When to catch what
Editor & CI Integration
Overview
Linter
JSON Schema
LSP server
VS Code extension
GitHub Action
pre-commit hook
Chapter 11 — Integrations
GUI (Graphical User Interface)
Overview
Install
Launch
Layout
Languages
Architecture
MCP Server (for Claude)
Overview
Install
Run the server
Exposed tools
Chapter 12 — API 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
繁體中文手冊
LoadDensity 繁體中文手冊
第 1 章 — 入門
安裝
需求
基本安裝（CLI 與函式庫）
選用 extras
開發安裝
驗證
入門
User 類型
以 Python API 執行
啟動 Locust Web UI
以 JSON 動作腳本執行
下一步
建立專案
概觀
Python API
CLI
結構
第 2 章 — 核心 API
架構
概觀
系統總覽
動作生命週期
User 派發
模組地圖
模組職責
逐步說明
start_test 與 prepare_env
概觀
簽章
支援的 user 類型
prepare_env
分散式模式
Locust 環境
概觀
create_env
prepare_env
Web UI
Stats greenlets
第 3 章 — 動作撰寫與執行
動作 Executor
概觀
動作格式
範例
LD_* 指令
新增自訂指令
參數解析器
概觀
支援的占位符
註冊資料
動作 JSON 用法
從回應擷取值
清除
情境模式
概觀
格式
加權挑選
條件流程
斷言與擷取
概觀
斷言
擷取
回呼執行器
基本用法
運作原理
可用的觸發函式
傳遞參數給回呼函式
參數說明
錯誤處理
動態套件載入
基本用法
運作原理
PackageManager API
範例：使用自訂套件
在 JSON 腳本中使用
第 4 章 — 使用者模板
HTTP 使用者
概觀
Task 欄位
範例
WebSocket 使用者
概觀
Task 欄位
範例
gRPC 使用者
概觀
Task 欄位
範例
MQTT 使用者
概觀
Task 欄位
範例
原生 TCP / UDP 使用者
概觀
Task 欄位
範例
第 5 章 — 報告與可觀測性
產生報告
概觀
HTML
JSON（依結果分檔）
XML（依結果分檔）
CSV（每筆請求一列）
JUnit XML（CI 友善）
Summary（百分位）
動作 JSON
指標 Exporter
概觀
Prometheus
InfluxDB
OpenTelemetry
Stop helpers
動作 JSON
測試紀錄
概觀
紀錄欄位
清除
SQLite 持久化
即時 Dashboard
概觀
Endpoints
啟動 / 停止
Action JSON
通知器
概觀
Slack(Block Kit)
Teams(MessageCard)
Datadog DogStatsD
Action JSON 指令
第 6 章 — 編排與擴展
分散式 Master / Worker
概觀
Master
Worker
提示
第 7 章 — 可靠度
可靠度
概觀
自適應重試
失敗預算
網路條件器
Process supervisor
Action JSON 指令
第 8 章 — 錄製、資料與匯入器
HAR 錄製／重放
概觀
Python API
過濾
對應規則
動作 JSON
匯入器
概觀
cURL
HAR
Postman v2.1
OpenAPI 3.x
k6
JMeter JMX
Action JSON 指令
SQLite 持久化
概觀
Python API
Schema
動作 JSON
第 9 章 — Auth
Auth
概觀
OAuth2
JWT
AWS SigV4
mTLS
第 10 章 — 工具、CLI 與診斷
CLI 命令列介面
子指令
run
run-dir
run-str
init
serve
舊式旗標
TCP 控制 Socket Server
概觀
模式
驗證
啟動 server
傳送指令（framed 模式）
關閉
注意事項
例外
階層
何時該攔截何者
編輯器與 CI 整合
概觀
Linter
JSON Schema
LSP server
VS Code 擴充套件
GitHub Action
pre-commit hook
第 11 章 — 整合
GUI 圖形介面
概觀
安裝
啟動
版面
語言
架構
MCP Server（給 Claude）
概觀
安裝
啟動
提供的工具
第 12 章 — API 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.metrics.prometheus_exporter
je_load_density.utils.metrics.influxdb_sink
je_load_density.utils.metrics.opentelemetry_exporter
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.socket_server.load_density_socket_server
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.websocket_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.socket_user_template
je_load_density.mcp_server.server
API reference
API Reference
LoadDensity Core API
start_test()
prepare_env()
create_env()
TestRecord
locust_wrapper_proxy
request_hook
Executor API
Executor Class
execute_action()
execute_files()
add_command_to_executor()
Built-in Actions
Global Convenience Functions
Callback Function API
CallbackFunctionExecutor Class
callback_function()
Available Trigger Functions
Parameter Resolver API
Resolver
Public helpers
Supported placeholders
Extractors
Action-JSON commands
HAR Recording API
load_har()
har_to_tasks()
har_to_action_json()
Other importers
Action-JSON commands
Metrics Exporters API
Prometheus
InfluxDB
Datadog DogStatsD
OpenTelemetry
Action-JSON commands
Report Generation API
HTML
generate_html()
generate_html_report()
JSON (split by outcome)
generate_json()
generate_json_report()
XML (split by outcome)
generate_xml()
generate_xml_report()
CSV (one row per request)
JUnit XML (CI-friendly)
Summary (percentiles)
Action-JSON commands
SQLite Persistence API
persist_records()
list_runs()
fetch_run_records()
Schema
Action-JSON commands
Socket Server API
start_load_density_socket_server()
Modes
Sending commands (framed mode)
Shutdown
Notes
Package Manager API
PackageManager Class
load_package_if_available()
add_package_to_executor()
File Processing API
get_dir_files_as_list()
read_action_json()
write_action_json()
Reliability API
Adaptive retry
Failure budget
Network conditioner
Process supervisor
Action-JSON commands
Live Dashboard API
start_dashboard()
stop_dashboard()
snapshot_metrics()
Endpoints
Action-JSON commands
Notifier API
Slack
Teams
Action-JSON commands
Auth API
OAuth2
JWT
AWS SigV4
mTLS
LoadDensity
LoadDensity English Documentation
API Reference
je_load_density
je_load_density.utils
je_load_density.utils.get_data_structure
View page source
je_load_density.utils.get_data_structure
Modules
get_api_data