Configuration Reference¶

This section provides a comprehensive reference for all configuration options in Veeksha. Configuration can be provided via YAML files or CLI arguments.

Tip

Export a JSON schema for IDE autocompletion:

uvx veeksha benchmark --export-json-schema

Quick links¶

BenchmarkConfig - Configuration for standard benchmark runs
CapacitySearchConfig - Configuration for capacity search experiments
API Reference - Full API reference for all config classes

Understanding the config system¶

Veeksha uses a polymorphic configuration system. Many options have a type field that determines which variant is used, each with its own set of options.

For example, the traffic_scheduler can be either rate or concurrent:

# Rate-based traffic
traffic_scheduler:
  type: rate
  interval_generator:
    type: poisson
    rate: 10.0  # 10 requests per second

# Concurrency-based traffic
traffic_scheduler:
  type: concurrent
  target_concurrent_sessions: 8
  rampup_seconds: 10

IDE autocompletion¶

See Configuration System for instructions on how to set up YAML autocompletion and validation in your IDE.