Hyperfoil Setup

This guide helps you deploy the Hyperfoil Controller.

Requirements

To use a version that hasn't been officially released (from your local machine), you need to have Hyperfoil built already.

Dependencies

This setup depends on the hyperfoil-shutdown role.

Role Variables

• hyperfoil_distribution (optional): The path to the Hyperfoil distribution zip file or folder on your local machine. If you don’t specify this, it will download the distribution from GitHub.
• hyperfoil_version (optional): The version you want to use. It defaults to the latest version available on GitHub.
• hyperfoil_dir (optional): The directory on the remote server for Hyperfoil (where the unpacked files and logs will go).
• hyperfoil_controller_group (optional): The Ansible group that includes the controller. The default group is hyperofoil-controller.
• hyperfoil_controller_port (optional): The port that Hyperfoil will listen on.
• hyperfoil_controller_start_timeout (optional): Time to wait for Hyperfoil to start, measured in seconds (default is 15 seconds).
• hyperfoil_controller_args (optional): Extra arguments to be sent to the controller JVM.
• hyperfoil_trigger_url (optional): Set up the controller to start runs from a Continuous Integration (CI) tool; this URL will be returned to the Command Line Interface (CLI) with some extra info, and the CLI will make a GET request to that URL.
• hyperfoil_log_config (optional): A configuration file for Log4j2.
• hyperfoil_jfr (optional): Set this to true if you want to collect Flight Recordings (Oracle JDK is required).
• hyperfoil_controller_debug_port (optional): If specified, the Java process will listen on this debug port.
• hyperfoil_controller_debug_suspend (optional): Use n for no, or y for yes. Default is n.
• hyperfoil_agent_debug_port (optional): If specified, the agent's Java process will listen on this port.
• libperfjava (optional): Path to libperfjava.so (used for performance mapping).

License

This is licensed under the Apache License, Version 2.0.