Configure Hypertest
The dashboard will prompt you to go to configuration page and complete configuration.
  1. 1.
    Click on generate sample config
  2. 2.
    Copy the configuration and paste it in hypertest.yml
  3. 3.
    Edit the parameters
  4. 4.
    Click on the arrow sign on top to convert the yaml configuration to parsed json
  5. 5.
    Click on update config
Note that a detailed explanation for every configuration parameter can be found in Hypertest itself, on the configuration page under the "Description" tab on the right side

Before you are able to run any analysis by Hypertest, it needs to be configured. The configuration can be found in the dashboard home. You can generate a "template" that can be edited as per requirement. The configuration tab can be found on the dashboard home.

After generating a template, You need to provide some parameters that are absolutely mandatory for Hypertest to become functional. Following is a list:
  • PRIMARY_BASE_URL: Address of the Primary version of the application.
  • CANDIDATE_BASE_URL: Address of the Candidate version of the application.
  • SERVICE_NAME: The name of the application on which test analyses are run.
  • HEALTH_CHECK: The endpoint of the health check in your application. If you do not have one, you can specify any endpoint that exists.
  • VALID_HEALTH_STATUS_CODES: The response code that is sent by the application on making a request at the "HEALTH_CHECK" endpoint
While Hypertest needs a lot more parameters to actually work, they have a default value assigned to them.

Advanced parameters can be used to perform tasks like redaction, blocking and ignoring specific requests/responses. Check out the parameter description on the configuration page.

The configuration section also contains some optional settings, that are absolutely optional. They offer functionalities that do not affect the analyses that are run by Hypertest.
  • WEEKLY_REPORTS_DAY
  • OAS_DOC_PATH
  • OAS_HEADERS
  • OAS_API_PREFIX
  • DAILY_MAINTENANCE_TIME
  • TIMEZONE_OFFSET
  • MAX_RUNNER_INSTANCES
  • REQUEST_AUTODELETION_WINDOW_DAYS
  • TEST_RESULTS_AUTODELETION_WINDOW_DAYS
Copy link
On this page
The Basic setup
Required parameters
Advanced configuration
Optional configuration