Performance Test Environment
This guide introduces you to Bloomreach's dedicated Performance Test Environment.
💡Prerequisite knowledge
We recommend that you review the following guide:
- Environment Details: This guide informs you about the Performance Packages available for your testing needs.
What is the Performance Test Environment
Performance Test Environment is a dedicated setup created for a customer for load/performance testing. It is separate from Production/Staging and has a unique endpoint. You can use this testing environment to ensure the optimal performance of your systems.
This dedicated setup enables you to:
- Run load tests to analyze the impact of increased traffic on your website.
- Run performance test to assess the impact of major changes.
Environment Features
Feed and other configurations
You can choose your Staging or Production account to replicate feed data and other configurations (including Dashboard and CMS configurations). Currently, this environment does not support testing with a separate feed.
- All configurations ( Dashboard, CMS ) sync similar to the Production or Staging environment.
- The feed is replicated from Staging or Production to the performance environment weekly on Mondays.
Please get in touch with Bloomreach Support if you’d like the feed to be replicated mid-week or any other time.
QPS
You can choose the required QPS data for testing in this environment.
- Please Note: If you wish to test with a different QPS during the course of your testing using the performance environment, then a separate endpoint will be created for each QPS request. For example, we will create two separate endpoints if you request 100 QPS this month and 300 QPS for next month.
Pixel
- Pixel data is not currently included in the Performance Test Environment.
- You can decide to fire a pixel to Bloomreach while performing the load test. We recommend not firing the pixel since the load test can affect real customer data.
Supported Discovery Features
Please note that Search, Category, Autosuggest, and Recommendations & Pathways are supported for the Performance Test Environment. We do not support dedicated performance setup for Content Search.
Environment Setup: Timelines to Note
- A Bloomreach Technical Consultant will coordinate the provisioning and termination of any Performance Test Environment endpoints.
- A start date and end date must be provided for the test. The Performance Test Environment endpoint will be shared at least 1 day prior to the test start date and terminated 1 day after the test end date.
- Bloomreach requires at least 5 business days notice prior to a test to provision the Performance Test Environment.
- If a change to the original Performance Test Environment dates is needed, the change must be requested prior to the environment being provisioned.
Details Required for Provisioning the Environment
To create a dedicated Performance Test Environment, the Bloomreach Technical Consultant will need some mandatory information or confirmation of the information. This information should be in alignment with the Statement of Work, when present.
- Account ID
- The catalogs (domain_key values) that are in scope for the test.
Notes:- If there are multiple catalogs, a comma-separated list of domain_key values.
- Only the configured catalogs (domain_key values) will be available during any tests.
- The combined maximum QPS for the services in scope. For example, the Search, Category, Autosuggest, and Recommendations & Pathways QPS. Content Search is currently not supported.
- The QPS split (if there are multiple domains). This should not exceed the total contracted QPS limit. Please specify the QPS for Recommendations & Pathways separately.
- The duration of the testing period. This includes the following:
- a. Duration (in weeks, days, months, year)
- b. Start Date for the test
- c. End Date for the test
Please provide the duration details separately for Search and Recommendations & Pathways.
- The realm from which the product catalog data will be copied from when provisioning the Performance Test Environment – Production or Staging. Please share the realm details separately for Search and Recommendations & Pathways.
- Sample API requests for the services in scope that will be used in the test (optional).
After the Environment is Provisioned
- Once the dedicated Performance Test Environment is provisioned, a URL will be provided for testing. The Search URL will be of the format [numeric-value].perf.bloomreach.com. The Recommendations & Pathways URL will be of the format pathways.stack-ID.perf.bloomreach.com.
- The environment will only support up to the QPS provided when the environment was provisioned. If the QPS is breached, the system will respond with a 5XX HTTP response code.
Performance Assistance Package
This Service offering includes all elements of the basic package as well as:
- Weekly (or an agreed upon cadence) performance test results.
- Manual index refreshes (if required).
- Recommendations to the Bloomreach integration that may lead to performance improvements.
- An end-of-test summary.
This is an additional Service offering with additional fees. Please contact your Bloomreach Account Manager, Digital Experience Manager, or Service Delivery Manager for further details on this offering.
Updated 10 months ago