API Reference

This section provides a curated API reference for LoadDensity, covering the core load-test entry points, executor, parameter resolver, recording, metrics exporters, report generators, persistence layer, SLA / regression helpers, reliability controls, live dashboard, notifiers, auth helpers, callback executor, control socket, and package manager.

For the fully auto-generated Python reference (autosummary walks every module), see the Reference chapter in the English manual.

API Modules

• 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