Welcome to Yandex.Tank’s documentation!

Author:Alexey Lavrenuke Version:1.15.12 Date:May 24, 2023 Homepage:Yandex.Tank Homepage on Github Download:Launchpad PPA Pypi Documentation:PDF Documentation License:GNU LGPLv3 Issue tracker:GitHub Issues

Contents:

• Getting started
  • Getting Help
  • What are the Yandex.Tank components?
  • Running Yandex.Tank
  • See also
• Installation
  • Docker container
  • Installation from PyPi
  • Installation .deb packages
• Routing and firewall
  • Firewall
  • Routing
  • Tuning
• Tutorials
  • Preparing requests
    • URI-style, URIs in load.yaml
    • URI-style, URIs in file
    • URI+POST-style
    • Request-style
  • Run Test!
  • Results
  • Tags
  • SSL
  • Autostop
    • HTTP and Net codes conditions
    • Average time conditions
  • Logging
  • Results in phout
  • Graph and statistics
  • Thread limit
  • Dynamic thread limit
  • Custom stateless protocol
  • Gatling
• Advanced usage
  • Command line options
  • Advanced configuration
    • Default configuration files
    • Multiline options
    • Time units
  • Artifacts
  • Sources
  • load.yaml example
• Modules
  • TankCore
    • Architecture
    • Test lifecycle
    • Options
    • consoleworker
    • apiworker
    • exit codes
  • Load Generators
    • Phantom
    • JMeter
    • BFG
    • Pandora
  • Artifact uploaders
    • Yandex.Overload
    • InfluxDB
  • Handy tools
    • Auto-stop
    • Telegraf
    • Console on-line screen
    • Aggregator
    • ShellExec
    • Resource Check
    • RC Assert
• Ammo generators
• Config reference
  • Core
    • core (dict)
    • version (string)
  • OpenTSDBUploader
    • address (string)
    • chunk_size (integer)
    • custom_tags (dict)
    • histograms (boolean)
    • labeled (boolean)
    • password (string)
    • port (integer)
    • prefix_metric (string)
    • ssl (boolean)
    • tank_tag (string)
    • username (string)
    • verify_ssl (boolean)
  • Bfg
    • address (string)
    • ammo_limit (integer)
    • ammo_type (string)
    • ammofile (string)
    • autocases (integer or string)
    • cache_dir (string)
    • cached_stpd (boolean)
    • chosen_cases (string)
    • enum_ammo (boolean)
    • file_cache (integer)
    • force_stepping (integer)
    • green_threads_per_instance (integer)
    • gun_config (dict)
    • gun_type (string)
    • header_http (string)
    • headers (list of string)
    • instances (integer)
    • load_profile (dict)
    • loop (integer)
    • pip (string)
    • uris (list of string)
    • use_caching (boolean)
    • worker_type (string)
  • ShootExec
    • cmd (string)
    • output_path (string)
    • stats_path (string)
  • JsonReport
    • monitoring_log (string)
    • test_data_log (string)
  • OfflineReport
    • offline_data_log (string)
    • offline_json_report (string)
    • offline_text_report (string)
    • print_report (boolean)
  • JMeter
    • affinity (string)
    • args (string)
    • buffer_size (integer)
    • buffered_seconds (integer)
    • exclude_markers (list of string)
    • ext_log (string)
    • extended_log (string)
    • jmeter_path (string)
    • jmeter_ver (float)
    • jmx (string)
    • shutdown_timeout (integer)
    • variables (dict)
  • ResourceCheck
    • disk_limit (integer)
    • interval (string)
    • mem_limit (integer)
  • Autostop
    • autostop (list of string)
    • report_file (string)
  • ShellExec
    • catch_out (boolean)
    • end (string)
    • poll (string)
    • post_process (string)
    • prepare (string)
    • start (string)
  • InfluxUploader
    • address (string)
    • chunk_size (integer)
    • custom_tags (dict)
    • database (string)
    • histograms (boolean)
    • labeled (boolean)
    • password (string)
    • port (integer)
    • prefix_measurement (string)
    • tank_tag (string)
    • username (string)
  • DataUploader
    • api_address (string)
    • api_attempts (integer)
    • api_timeout (integer)
    • chunk_size (integer)
    • component (string)
    • connection_timeout (integer)
    • ignore_target_lock (boolean)
    • job_dsc (string)
    • job_name (string)
    • jobno_file (string)
    • jobno (string)
    • lock_targets (list or string)
    • log_data_requests (boolean)
    • log_monitoring_requests (boolean)
    • log_other_requests (boolean)
    • log_status_requests (boolean)
    • maintenance_attempts (integer)
    • maintenance_timeout (integer)
    • meta (dict)
    • network_attempts (integer)
    • network_timeout (integer)
    • notify (list of string)
    • operator (string)
    • send_status_period (integer)
    • strict_lock (boolean)
    • target_lock_duration (string)
    • task (string)
    • threads_timeout (integer)
    • token_file (string)
    • upload_token (string)
    • ver (string)
    • writer_endpoint (string)
  • Pandora
    • affinity (string)
    • buffered_seconds (integer)
    • config_content (dict)
    • config_file (string)
    • expvar (boolean)
    • pandora_cmd (string)
    • report_file (string)
    • resource (dict)
    • resources (list)
  • NeUploader
    • api_address (string)
    • db_name (string)
    • max_df_len (integer)
    • meta (dict)
    • test_name (string)
  • Phantom
    • additional_libs (list of string)
    • address (string)
    • affinity (string)
    • ammo_limit (integer)
    • ammo_type (string)
    • ammofile (string)
    • autocases (integer or string)
    • buffered_seconds (integer)
    • cache_dir (string)
    • chosen_cases (string)
    • client_certificate (string)
    • client_cipher_suites (string)
    • client_key (string)
    • config (string)
    • connection_test (boolean)
    • enum_ammo (boolean)
    • file_cache (integer)
    • force_stepping (integer)
    • gatling_ip (string)
    • header_http (string)
    • headers (list of string)
    • instances (integer)
    • load_profile (dict)
    • loop (integer)
    • method_options (string)
    • method_prefix (string)
    • multi (list of dict)
    • name (string)
    • phantom_http_entity (string)
    • phantom_http_field_num (integer)
    • phantom_http_field (string)
    • phantom_http_line (string)
    • phantom_modules_path (string)
    • phantom_path (string)
    • phout_file (string)
    • port (string)
    • source_log_prefix (string)
    • ssl (boolean)
    • tank_type (string)
    • threads (integer)
    • timeout (string)
    • uris (list of string)
    • use_caching (boolean)
    • writelog (string)
  • Console
    • cases_max_spark (integer)
    • cases_sort_by (string)
    • disable_all_colors (boolean)
    • disable_colors (string)
    • info_panel_width (integer)
    • max_case_len (integer)
    • short_only (boolean)
    • sizes_max_spark (integer)
    • times_max_spark (integer)
  • RCAssert
    • fail_code (integer)
    • pass (string)
  • Telegraf
    • config_contents (string)
    • config (string)
    • default_target (string)
    • disguise_hostnames (boolean)
    • kill_old (boolean)
    • ssh_timeout (string)

Indices and tables

• Index
• Module Index
• Search Page