Add a settings set#

Settings sets allow you to run tests with different settings. You can reuse any settings set in new projects.

Note

If parameter names from a settings set match the settings of the test project, then the test uses the settings from the linked set.

Timer settings from a settings set override timer settings from a test project.

Create a settings set#

To create a settings set, follow these steps:

  1. Go to the Projects page and open the Settings tab:

    _images/um_set_list.en.png

  2. Click Add new settings set.

  3. Add parameters.
    _images/um_set_parametres.en.png

    To add a literal parameter, follow these steps:

    1. On the Literal parameters tab, enter the name of the parameter in the Parameter Name field.

    2. Enter the value of the parameter in the Parameter Value field.

    To add a CSV parameter, follow these steps:

    1. Go to the Import from CSV tab.

    2. Click to upload CSV file and select the file. The file can contain one or more columns. The file size shouldn’t exceed 50 MB. The page opens:

      _images/um_import_parametres_from_csv.en.png

    3. Configure import from CSV file:

      • Field delimiter. The character or string used to separate the fields in the uploaded CSV file, for example “;”.

      • The first line contains parameter’s names. If the toggle is switched on, the first line of the CSV file is used as parameter names. If the toggle is switched off, in the fields Parameter’s name, enter parameter’s names.

      • Reuse values at the end of file. If the toggle is switched on, the CSV file starts rereading from the beginning after having reached its end. If the toggle is switched off, the test may end earlier than planned when the end of the CSV file is reached.

      • Separate values by threads. If the toggle is switched on, the load generator separates a data set, and each Virtual User instance uses its own data set. If the toggle is switched off, each Virtual User instance uses a common data set.

      • Order. Select one of the values:

        • Random. Shuffles the CSV file lines before executing the test.

        • Sequential. Reads the CSV file lines sequentially.

  4. Rewrite the transaction URL if needed:

    1. Go to the URL overwrite tab.

    2. Click Add new URL.

    3. Enter the current transaction URL in the URL to rewrite field.

    4. Enter the new URL in the Updated URL field.

    Note

    Уou can also configure URL overwrite using parameters.

  5. Configure a timer and specify timeouts:

    1. Go to the Other settings tab:

      _images/um_set_timer.en.png

    2. Configure the default timer:

      1. To turn the default timer on or off, click the toggle.

      2. Select the timer type:

        • Constant. Enter a delay before sending the request by Virtual Users. A delay is specified in seconds.

        • Random. Enter a range of numbers within which a random delay time is selected. A range is specified in seconds.

    3. Enter the timeouts:

      • Connection timeout. A default timeout before the connection is established to the server or the handshake is executed. If it doesn’t happen within the given time frame, the request is marked as connection timeout. By default, it’s 60.

      • Request timeout. A default timeout before the entire body of the response from the server is received. If it doesn’t happen within the given time frame, the request is marked as timeout. By default, it’s 120.

  6. Add default headers for all requests of a test project if needed:

    1. Go to the Other settings tab:

      _images/um_default_headers.en.png

    2. Enter the name of the parameter in the Key field. To enter the name of the parameter in the format ${expression}, click P and select the parameter. Don’t use spaces in the parameter name.

    3. Enter the value of the parameter in the Value field. To enter the name of the parameter in the format ${expression}, click P and select the parameter.

      _images/um_select_parameter.png

      You can select the parameters with the P button, if you have added these parameters in the settings set.

  7. Set default cookies:

    1. Go to the Cookies tab.

      _images/um_default_cookies_seting_set.en.png

    2. Fill in the fields:

      • Name. The unique name of the cookie.

      • Value. The value of the cookie.

      • Domain. The name of the host to send the cookie to. Specified without http(s)://.

      • Path. The path to the resource on the web server. The default value is /.

    3. If needed, select the HTTPS only checkbox so the cookie should only be used over HTTPS, and JavaScript modification isn’t allowed.

    If needed, click the Clear cookies each iteration toggle so that cookies are cleared, and the virtual user should behave like a new user on each iteration of the group’s execution. A new user means the user wouldn’t remember any cookies from this website.

  8. Add webhooks, if needed, to send notifications when the test status changes, for example, when it’s finished. You can use webhooks as triggers in CI/CD pipelines:

    1. Go to the Webhooks tab.

    2. Click + Add new webhook. The webhook settings appear:

      _images/um_add_webhook.en.png

    3. Select test status from the drop-down list. Possible values:

      • Finished

      • Failed

      • Canceled

      • Pending

      • Running

    4. Click Edit request. The window opens:

      _images/um_webhook_settings.en.png

    5. Fill in the fields:

      • Url. Request URL.

      • Key. Name of the header parameter.

      • Value. Value of the header parameter.

    6. Click Save.

    When the test status changes to the one specified in the webhook settings, Boomq sends an HTTP request with the body:

    {
  "id": test id,
  "testProjectId": Test project id,
  "testProjectVersionId": Test project version id,
  "testMode": "Test mode",
  "state": "Test status",
  "displayState": "Displayed test status",
  "userId": User id,
  "teamId": Team id,
  "createDate": "Test creation date",
  "startDate": "Test starting date",
  "endDate": "Test completion date",
  "comment": "Test description",
  "labelSet": [Test labels]
}

    Use webhooks to configure triggers in CI/CD pipelines. For example, to get SLA results after completing the test, follow these steps:

    1. Add a webhook for the Finished status.

    2. Wait for the notification of the test completion.

    3. Send a request to get SLA results. The value of the testId parameter is equal to the value of the id parameter from the webhook request body:

      curl --location --request GET 'https://api.boomq.io/test-srv/api/testResult/sla?testId=id' \
--header 'boomq-token: API token'
  9. Add system metrics for the monitoring:

    1. Go to the Import from CSV tab.

    2. Select system metrics from the drop-down list:

      • Disk input/output system. Collects read/write operations of a disk. The Grafana dashboard includes: Root Disk usage, All partitions usage, DISK partitions Inode Total, DISK partitions Space Total, Root (/) Disk inodes, Path Used Percent, Swap usage, Swap I/O bytes.

      • UDP metrics. The Grafana dashboard includes: UDP datagrams, UDP buffer errors, UDP errors.

      • TCP metrics. Collects such metrics as established connections, time wait, and socket counts. The Grafana dashboard includes: Network Packets, TCP handshake issues.

      • Kernel metrics. Collects various Kernel metrics, such as boot_time, context_switches, interrupts. The Grafana dashboard includes: Context Switches, Interrupts, Forks.

      • Docker metrics. Uses Docker Engine API to gather metrics on running docker containers. The Grafana dashboard includes: Running Docker, Stopped Docker, Docker Images, Docker Status, CPU Usage, Mem Usage, Traffic, Disk IO.

    3. Click Generate and save. The links to configuration files appear:

      • telegraf.conf. The config file of the Telegraf agent for collecting metrics and system data.

      • docker-compose.yaml. The Docker compose file for the Telegraf agent deploying.

      _images/um_set_monitoring.en.png

      Note

      To get the system metrics of the testing system on the server where the metrics are collected, follow these steps:

      1. On the server where the metrics are collected, install Docker.

      2. Give access to the public Docker hub or pre-download the Telegraf Docker image.

      3. On the server where the metrics are collected, install Docker Compose.

      4. Copy the telegraf.conf file to the testing system server.

      5. On each telegraf.conf file, specify the hostname parameter. For more information, see Telegraf documentation.

  10. Click Save.

See also

Create a settings set based on a project#

  1. Open the Projects page.

  2. Click edit_settings_button for the project on which you want to base the settings set. The window opens:

    _images/um_select_set.en.png

  3. Click Extract from project.

  4. To edit the settings set, click edit_button if needed.

The created settings set is automatically linked with the project.

Copy a settings set#

You can create a settings set based on another set.

  1. Go to the Projects page and open the Settings tab:

  2. Click copy_set_button for the settings set on which you want to base the new settings set.

The new settings set calls “copied_<Name of the original settings set”.

Edit a settings set#

To edit a settings set, follow these steps:

  1. Use one of the following methods:

    • on the Projects tab:

      1. Click edit_settings_button for any project.

      2. Click edit_button for the required settings set.

    • on the Settings tab, open the settings set.

  2. Add parameters. For more information, see Create a settings set.

  3. Click Save.

Add labels to a settings set#

Labels allow you to filter the list of settings sets on the Settings tab, specify important information, and highlight the set in the list.

To add labels, follow these steps:

  1. Go to the Projects page and open the Settings tab:

    _images/um_set_list.en.png

  2. Click No label + for the required settings set.

  3. Enter the name of the label and click ok_label_button.

To filter the list of projects, select labels from the drop-down list:

_images/um_filtred_by_label.en.png

See also