Data Center App Performance Toolkit User Guide For Jira Service Management

This document walks you through the process of testing your app on Jira Service Management using the Data Center App Performance Toolkit. These instructions focus on producing the required performance and scale benchmarks for your Data Center app:

If your application relays or extends the functionality of Insight (What is Insight?):

Please, make sure you have enabled Insight-specific tests in the jsm.yml file, by setting True value next to the insight variable.

In this document, we cover the use of the Data Center App Performance Toolkit on two types of environments:

Development environment: Jira Service Management Data Center environment for a test run of Data Center App Performance Toolkit and development of app-specific actions.

1. Set up a development environment Jira Service Management Data Center on AWS.
2. Run toolkit on the development environment locally.
3. Develop and test app-specific actions locally.

Enterprise-scale environment: Jira Service Management Data Center environment used to generate Data Center App Performance Toolkit test results for the Marketplace approval process.

4. Set up an enterprise-scale environment Jira Service Management Data Center on AWS.
5. Setting up load configuration for Enterprise-scale runs.
6. Running the test scenarios from execution environment against enterprise-scale Jira Service Management Data Center.

---

Development environment

Running the tests in a development environment helps familiarize you with the toolkit. It'll also provide you with a lightweight and less expensive environment for developing app-specific actions. Once you're ready to generate test results for the Marketplace Data Center Apps Approval process, run the toolkit in an enterprise-scale environment.

---

1. Setting up Jira Service Management Data Center development environment

AWS cost estimation for the development environment

To reduce costs, we recommend you to keep your deployment up and running only during the performance runs. AWS Jira Service Management Data Center development environment infrastructure costs about 20 - 40$ per working week depending on such factors like region, instance type, deployment type of DB, and other.

Setup Jira Service Management Data Center development environment on k8s.

Below process describes how to install low-tier Jira Service Management DC with "small" dataset included:

1. Create Access keys for AWS CLI:

   Do not use root user credentials for cluster creation.

   Option 1 (simple): create admin user with AdministratorAccess permissions.

   Option 2 (complex): create granular permission policies with policy1 and policy2.

   The specific configuration relies on how you manage permissions within AWS.

   Example Option 1 with Admin user:

   1. Go to AWS Console -> IAM service -> Users
   2. Create new user -> attach policies directly -> AdministratorAccess
   3. Open newly created user -> Security credentials tab -> Access keys -> Create access key -> Command Line Interface (CLI) -> Create access key
   4. Use Access key and Secret access key in aws_envs file

   Example Option 2 with granular Policies:

   1. Go to AWS Console -> IAM service -> Policies

   2. Create policy1 with json content of the policy1 file

      Important: change all occurrences of 123456789012 to your real AWS Account ID.

   3. Create policy2 with json content of the policy2 file

      Important: change all occurrences of 123456789012 to your real AWS Account ID.

   4. Go to User -> Create user -> Attach policies directly -> Attach policy1 and policy2-> Click on Create user button

   5. Open newly created user -> Security credentials tab -> Access keys -> Create access key -> Command Line Interface (CLI) -> Create access key

   6. Use Access key and Secret access key in aws_envs file

2. Clone Data Center App Performance Toolkit locally.

   For annual review, always get the latest version of the DCAPT code from the master branch.

   DCAPT supported versions: three latest minor version releases.

3. Navigate to dc-apps-peformance-toolkit/app/util/k8s folder.

4. Set AWS access keys created in step1 in aws_envs file:

   • AWS_ACCESS_KEY_ID
   • AWS_SECRET_ACCESS_KEY
   • AWS_SESSION_TOKEN (only for temporary creds)

5. Set required variables in dcapt-small.tfvars file:

   • environment_name - any name for you environment, e.g. dcapt-jsm-small.

   • products - jira

   • jira_image_repository - atlassian/jira-servicemanagement - make sure to select the Jira Service Management application.

   • jira_license - one-liner of valid Jira Service Management license without spaces and new line symbols.

   • region - AWS region for deployment. Do not change default region (us-east-2). If specific region is required, contact support.

   New trial license could be generated on my atlassian. Use BX02-9YO1-IN86-LO5G Server ID for generation.

6. Optional variables to override:

   • jira_version_tag - Jira Service Management version to deploy. Supported versions see in README.md.

7. From local terminal (Git Bash for Windows users) start the installation (~20 min):

   1
   2
   docker run --pull=always --env-file aws_envs \
   -v "/$PWD/dcapt-small.tfvars:/data-center-terraform/conf.tfvars" \
   -v "/$PWD/dcapt-snapshots.json:/data-center-terraform/dcapt-snapshots.json" \
   -v "/$PWD/logs:/data-center-terraform/logs" \
   -it atlassianlabs/terraform:2.9.3 ./install.sh -c conf.tfvars
   

8. Copy product URL from the console output. Product url should look like http://a1234-54321.us-east-2.elb.amazonaws.com/jira.

---

2. Run toolkit on the development environment locally

1. Clone Data Center App Performance Toolkit locally.

   For annual review, always get the latest version of the DCAPT code from the master branch.

   DCAPT supported versions: three latest minor version releases.

2. Follow the README.md instructions to set up toolkit locally.

3. Navigate to dc-app-performance-toolkit/app folder.

4. Open the jsm.yml file and fill in the following variables:

   • application_hostname: your_dc_jsm_instance_hostname without protocol.
   • application_protocol: http or https.
   • application_port: for HTTP - 80, for HTTPS - 443, 8080, 2990 or your instance-specific port.
   • secure: True or False. Default value is True. Set False to allow insecure connections, e.g. when using self-signed SSL certificate.
   • application_postfix: /jira # default value for TerraForm deployment; e.g., /jira for url like this http://localhost:2990/jira.
   • admin_login: admin user username.
   • admin_password: admin user password.
   • load_executor: executor for load tests. Valid options are jmeter (default) or locust.
   • concurrency_agents: 1 - number of concurrent JMeter/Locust agents.
   • concurrency_customers: 1 - number of concurrent JMeter/Locust customers.
   • test_duration: 5m - duration of the performance run.
   • ramp-up: 3s - amount of time it will take JMeter or Locust to add all test users to test execution.
   • total_actions_per_hour_agents: 500 - number of total JMeter/Locust actions per hour for agents scenario.
   • total_actions_per_hour_customers: 1500 - number of total JMeter/Locust actions per hour customers scenario.
   • WEBDRIVER_VISIBLE: visibility of Chrome browser during selenium execution (False is by default).
   • insight: True or False. Default value is False. Set True to enable Insight specific tests.

5. In case your application relays or extends the functionality of Insight. Make sure to set True value next to insight variable.

6. Run bzt.

   1
   2
   bzt jsm.yml
   

7. Review the resulting table in the console log. All JMeter/Locust and Selenium actions should have 0+% success rate.
   In case some actions have 0% success rate refer to the following logs in dc-app-performance-toolkit/app/results/jsm/YY-MM-DD-hh-mm-ss folder:

   • results_summary.log: detailed run summary
   • results.csv: aggregated .csv file with all actions and timings
   • bzt.log: logs of the Taurus tool execution
   • jmeter.*: logs of the JMeter tool execution
   • locust.*: logs of the Locust tool execution (in case you use Locust as load_executor in jsm.yml)
   • pytest.*: logs of Pytest-Selenium execution

---

3. Develop and test app-specific action locally

Data Center App Performance Toolkit has its own set of default test actions for Jira Service Management Data Center: JMeter/Locust and Selenium for load and UI tests respectively.

App-specific action - action (performance test) you have to develop to cover main use cases of your application. Performance test should focus on the common usage of your application and not to cover all possible functionality of your app. For example, application setup screen or other one-time use cases are out of scope of performance testing.

1. Define main use case of your app. Usually it is one or two main app use cases.
2. Your app adds new UI elements in Jira Service Management Data Center - Selenium app-specific action has to be developed.
3. Your app introduces new endpoint or extensively calls existing Jira Service Management Data Center API - JMeter/Locust app-specific actions has to be developed.
   JMeter and Locust actions are interchangeable, so you could select the tool you prefer:

• JMeter - UI-based performance tool.
• Locust - code-based (Python requests library) performance tool.

Custom dataset

You can filter your own app-specific issues for your app-specific actions.

1. Create app-specific service desk requests that have specific anchor in summary, e.g. AppRequest anchor and issues summaries like AppRequest1, AppRequest2, AppRequest3.
2. Go to the search page of your Jira Service Management Data Center - JSM_URL/issues/?jql= and select Advanced.
3. Write JQL that filter just your request from step 1, e.g. summary ~ 'AppRequest*'.
4. Edit JSM configuration file dc-app-performance-toolkit/app/jsm.yml:
   • custom_dataset_query: JQL from step 3.

Next time when you run toolkit, custom dataset issues will be stored to the dc-app-performance-toolkit/app/datasets/jsm/custom-requests.csv with columns: request_id, request_key, service_desk_id, project_id, project_key.

Example of app-specific Selenium action development with custom dataset

You develop an app that adds some additional fields to specific types of Jira Service Management requests. In this case, you should develop Selenium app-specific action:

1. Create app-specific service desk requests with AppRequest anchor in summary: AppRequest1, AppRequest2, etc.
2. Go to the search page of your Jira Service Management Data Center - JSM_URL/issues/?jql= and check if JQL is correct: summary ~ 'AppRequest*'.
3. Edit dc-app-performance-toolkit/app/jsm.yml configuration file and set custom_dataset_query: summary ~ 'AppRequest*'.
4. Extend example of app-specific action for agent in dc-app-performance-toolkit/app/extension/jsm/extension_ui_agents.py.
   Code example. So, our test has to open app-specific requests in agent view and measure time to load of this app-specific request.
5. Extend example of app-specific action for customer in dc-app-performance-toolkit/app/extension/jsm/extension_ui_customers.py.
   Code example. So, our test has to open app-specific requests in portal view and measure time to load of this app-specific request.
6. If you need to run app_specific_action as specific user uncomment app_specific_user_login function in code example. Note, that in this case test_1_selenium_custom_action should follow just before test_2_selenium_agent_z_logout or test_2_selenium_customer_z_log_out action.
7. In dc-app-performance-toolkit/app/selenium_ui/jsm_ui_agents.py, review and uncomment the following block of code to make newly created app-specific actions executed:

1
2
# def test_1_selenium_agent_custom_action(jsm_webdriver, jsm_datasets, jsm_screen_shots):
#     extension_ui_agents.app_specific_action(jsm_webdriver, jsm_datasets)

1. In dc-app-performance-toolkit/app/selenium_ui/jsm_ui_customers.py, review and uncomment the following block of code to make newly created app-specific actions executed:

1
2
# def test_1_selenium_customer_custom_action(jsm_webdriver, jsm_datasets, jsm_screen_shots):
#     extension_ui_customers.app_specific_action(jsm_webdriver, jsm_datasets)

1. Run toolkit with bzt jsm.yml command to ensure that all Selenium actions including app_specific_action are successful.

Example of app-specific Locust/JMeter action development

You develop an app that introduces new GET and POST endpoints in Jira Service Management Data Center. In this case, you should develop Locust or JMeter app-specific action.

Locust app-specific action development example

1. Extend example of app-specific action for agent in dc-app-performance-toolkit/app/extension/jsm/extension_locust_agents.py, so that test will call the endpoint with GET request, parse response use these data to call another endpoint with POST request and measure response time.
   Code example.
2. Extend example of app-specific action for customers in dc-app-performance-toolkit/app/extension/jsm/extension_locust_customers.py, so that test will call the endpoint with GET request, parse response use these data to call another endpoint with POST request and measure response time.
   Code example.
3. In dc-app-performance-toolkit/app/jsm.yml set load_executor: locust to make locust as load executor.
4. Set desired execution percentage for agent_standalone_extension/customer_standalone_extension. Default value is 0, which means that agent_standalone_extension/customer_standalone_extension action will not be executed. Locust uses actions percentage as relative weights, so if some_action: 10 and standalone_extension: 20 that means that standalone_extension will be called twice more.
   Set agent_standalone_extension/customer_standalone_extension weight in accordance with the expected frequency of your app use case compared with other base actions.
5. App-specific tests could be run (if needed) as a specific user. Use @run_as_specific_user(username='specific_user_username', password='specific_user_password') decorator for that.
6. Run toolkit with bzt jsm.yml command to ensure that all Locust actions including app_specific_action are successful.

JMeter app-specific action development example

1. Check that jsm.yml file has correct settings of application_hostname, application_protocol, application_port, application_postfix, etc.

2. Set desired execution percentage for agent_standalone_extension and/or customer_standalone_extension. Default values are 0, which means that agent_standalone_extension and customer_standalone_extension actions will not be executed. For example, for app-specific action development you could set percentage of agent_standalone_extension and/or customer_standalone_extension to 100 and for all other actions to 0 - this way only jmeter_agent_login_and_view_dashboard and agent_standalone_extension or jmeter_customer_login_and_view_dashboard and customer_standalone_extension actions would be executed.

3. Navigate to dc-app-performance-toolkit/app folder and run from virtualenv(as described in dc-app-performance-toolkit/README.md):

   1
   2
   python util/jmeter/start_jmeter_ui.py --app jsm --type agents
   # or
   python util/jmeter/start_jmeter_ui.py --app jsm --type customers  
   

4. Open Agents/Customers thread group > actions per login and navigate to agent_standalone_extension/customer_standalone_extension

5. Add GET HTTP Request: right-click to agent_standalone_extension/customer_standalone_extension`` > Add>Sampler HTTP Request`, chose method GET and set endpoint in Path.

6. Add Regular Expression Extractor: right-click to to newly created HTTP Request > Add > Post processor > Regular Expression Extractor

7. Add Response Assertion: right-click to newly created HTTP Request > Add > Assertions > Response Assertion and add assertion with Contains, Matches, Equals, etc types.

8. Add POST HTTP Request: right-click to agent_standalone_extension/customer_standalone_extension > Add > Sampler HTTP Request, chose method POST, set endpoint in Path and add Parameters or Body Data if needed.

9. Right-click on View Results Tree and enable this controller.

10. Click Start button and make sure that login_and_view_dashboard and agent_standalone_extension/customer_standalone_extension are successful.

11. Right-click on View Results Tree and disable this controller. It is important to disable View Results Tree controller before full-scale results generation.

12. Click Save button.

13. To make agent_standalone_extension/customer_standalone_extension executable during toolkit run edit dc-app-performance-toolkit/app/jsm.yml and set execution percentage of agent_standalone_extension/customer_standalone_extension accordingly to your use case frequency.

14. App-specific tests could be run (if needed) as a specific user. In the agent_standalone_extension/customer_standalone_extension uncomment login_as_specific_user controller. Navigate to the username:password config element and update values for app_specific_username and app_specific_password names with your specific user credentials. Also make sure that you located your app-specific tests between login_as_specific_user and login_as_default_user_if_specific_user_was_loggedin controllers.

15. Run toolkit to ensure that all JMeter actions including agent_standalone_extension and/or customer_standalone_extension are successful.

Using JMeter variables from the base script

Use or access the following variables in your agent_standalone_extension action if needed:

• ${request_id} - request id being viewed or modified (e.g. 693484)
• ${request_key} - request key being viewed or modified (e.g. ABC-123)
• ${request_project_id} - project id being viewed or modified (e.g. 3423)
• ${request_project_key} - project key being viewed or modified (e.g. ABC)
• ${request_service_desk_id} - service_desk_id being viewed or modified (e.g. 86)
• ${s_prj_key} - "small" project (<10k requests per project) key being viewed or modified (e.g. ABC)
• ${s_prj_id} - "small" project id being viewed or modified (e.g. 123)
• ${s_service_desk_id} - "small" project service_desk_id being viewed or modified (e.g. 12)
• ${s_prj_total_req} - "small" project total requests (e.g. 444)
• ${s_prj_all_open_queue_id} - "small" project "all open" queue id (e.g. 44)
• ${s_created_vs_resolved_id} - "small" project "created vs resolved" report id (e.g. 45)
• ${s_time_to_resolution_id} - "small" project "time to resolution" report id (e.g. 46)
• ${m_prj_key} - "medium" project (>10k and <100k requests per project) key being viewed or modified (e.g. ABC)
• ${m_prj_id} - "medium" project id being viewed or modified (e.g. 123)
• ${m_service_desk_id} - "medium" project service_desk_id being viewed or modified (e.g. 12)
• ${m_prj_total_req} - "medium" project total requests (e.g. 444)
• ${m_prj_all_open_queue_id} - "medium" project "all open" queue id (e.g. 44)
• ${m_created_vs_resolved_id} - "medium" project "created vs resolved" report id (e.g. 45)
• ${m_time_to_resolution_id} - "medium" project "time to resolution" report id (e.g. 46)
• ${username} - the logged in username (e.g. admin)

Use or access the following variables in your customer_standalone_extension action if needed:

• ${s_service_desk_id} - "small" project (<10k requests per project) service_desk_id being viewed or modified (e.g. 12)
• ${rt_project_id} - project id (e.g. 12)
• ${rt_service_desk_id} - service_desk_id (e.g. 12)
• ${rt_id} - request type id for project with project id ${rt_project_id} and service_desk_id ${rt_service_desk_id} (e.g. 123)
• ${username} - the logged in username (e.g. admin)

---

Enterprise-scale environment

After adding your custom app-specific actions, you should now be ready to run the required tests for the Marketplace Data Center Apps Approval process. To do this, you'll need an enterprise-scale environment.

4. Setting up Jira Service Management Data Center enterprise-scale environment with "large" dataset

EC2 CPU Limit

AWS cost estimation

AWS Pricing Calculator provides an estimate of usage charges for AWS services based on certain information you provide. Monthly charges will be based on your actual usage of AWS services and may vary from the estimates the Calculator has provided.

*The prices below are approximate and may vary depending on such factors like region, instance type, deployment type of DB, and other.

Setup Jira Service Management Data Center enterprise-scale environment on k8s

Data dimensions and values for an enterprise-scale dataset are listed and described in the following table.

Below process describes how to install enterprise-scale Jira Service Management DC with "large" dataset included:

1. Create Access keys for AWS CLI:

   Do not use root user credentials for cluster creation.

   Option 1 (simple): create admin user with AdministratorAccess permissions.

   Option 2 (complex): create granular permission policies with policy1 and policy2.

   The specific configuration relies on how you manage permissions within AWS.

   Example Option 1 with Admin user:

   1. Go to AWS Console -> IAM service -> Users
   2. Create new user -> attach policies directly -> AdministratorAccess
   3. Open newly created user -> Security credentials tab -> Access keys -> Create access key -> Command Line Interface (CLI) -> Create access key
   4. Use Access key and Secret access key in aws_envs file

   Example Option 2 with granular Policies:

   1. Go to AWS Console -> IAM service -> Policies

   2. Create policy1 with json content of the policy1 file

      Important: change all occurrences of 123456789012 to your real AWS Account ID.

   3. Create policy2 with json content of the policy2 file

      Important: change all occurrences of 123456789012 to your real AWS Account ID.

   4. Go to User -> Create user -> Attach policies directly -> Attach policy1 and policy2-> Click on Create user button

   5. Open newly created user -> Security credentials tab -> Access keys -> Create access key -> Command Line Interface (CLI) -> Create access key

   6. Use Access key and Secret access key in aws_envs file

2. Clone Data Center App Performance Toolkit locally.

   For annual review, always get the latest version of the DCAPT code from the master branch.

   DCAPT supported versions: three latest minor version releases.

3. Navigate to dc-app-perfrormance-toolkit/app/util/k8s folder.

4. Set AWS access keys created in step1 in aws_envs file:

   • AWS_ACCESS_KEY_ID
   • AWS_SECRET_ACCESS_KEY
   • AWS_SESSION_TOKEN (only for temporary creds)

5. Set required variables in dcapt.tfvars file:

   • environment_name - any name for you environment, e.g. dcapt-jsm-large.

   • products - jira

   • jira_image_repository - atlassian/jira-servicemanagement - make sure to select the Jira Service Management application.

   • jira_license - one-liner of valid Jira Service Management license without spaces and new line symbols.

   • region - AWS region for deployment. Do not change default region (us-east-2). If specific region is required, contact support.

   New trial license could be generated on my atlassian. Use BX02-9YO1-IN86-LO5G Server ID for generation.

6. Optional variables to override:

   • jira_version_tag - Jira Service Management version to deploy. Supported versions see in README.md.

7. From local terminal (Git Bash for Windows users) start the installation (~40min):

   1
   2
   docker run --pull=always --env-file aws_envs \
   -v "/$PWD/dcapt.tfvars:/data-center-terraform/conf.tfvars" \
   -v "/$PWD/dcapt-snapshots.json:/data-center-terraform/dcapt-snapshots.json" \
   -v "/$PWD/logs:/data-center-terraform/logs" \
   -it atlassianlabs/terraform:2.9.3 ./install.sh -c conf.tfvars
   

8. Copy product URL from the console output. Product url should look like http://a1234-54321.us-east-2.elb.amazonaws.com/jira.

---

5. Setting up load configuration for Enterprise-scale runs

Default TerraForm deployment configuration already has a dedicated execution environment pod to run tests from. For more details see Execution Environment Settings section in dcapt.tfvars file.

1. Check the jsm.yml configuration file. If load configuration settings were changed for dev runs, make sure parameters were changed back to the defaults:

2. In case your application relays or extends the functionality of Insight. Make sure to set True next to the insight variable.

   1
   2
       application_hostname: test_jsm_instance.atlassian.com   # Jira Service Management DC hostname without protocol and port e.g. test-jsm.atlassian.com or localhost
       application_protocol: http                # http or https
       application_port: 80                      # 80, 443, 8080, 2990, etc
       secure: True                              # Set False to allow insecure connections, e.g. when using self-signed SSL certificate
       application_postfix: /jira                # e.g. /jira for TerraForm deployment url like `http://a1234-54321.us-east-2.elb.amazonaws.com/jira`. Leave this value blank for url without postfix.
       admin_login: admin
       admin_password: admin
       load_executor: jmeter                     # jmeter and locust are supported. jmeter by default.
       concurrency_agents: 50                    # number of concurrent virtual agents for jmeter or locust scenario
       concurrency_customers: 150                # number of concurrent virtual customers for jmeter or locust scenario
       test_duration: 45m
       ramp-up: 3m                               # time to spin all concurrent users
       total_actions_per_hour_agents: 5000       # number of total JMeter/Locust actions per hour
       total_actions_per_hour_customers: 15000   # number of total JMeter/Locust actions per hour
       insight: False                            # Set True to enable Insight specific tests
       
   

You'll need to run the toolkit for each test scenario in the next section.

---

6. Running the test scenarios from execution environment against enterprise-scale Jira Service Management Data Center

Using the Data Center App Performance Toolkit for Performance and scale testing your Data Center app involves two test scenarios:

• Performance regression
• Scalability testing

Each scenario will involve multiple test runs. The following subsections explain both in greater detail.

Scenario 1: Performance regression

This scenario helps to identify basic performance issues without a need to spin up a multi-node Jira Service Management DC. Make sure the app does not have any performance impact when it is not exercised.

Run 1 (~50 min)

To receive performance baseline results without an app installed:

1. Before run:

   • Make sure jsm.yml and toolkit code base has default configuration from the master branch.
   • Check load configuration parameters needed for enterprise-scale run: Setting up load configuration for Enterprise-scale runs.
   • Check correctness of application_hostname, application_protocol, application_port and application_postfix in .yml file.
   • standalone_extension set to 0. App-specific actions are not needed for Run1 and Run2.
   • AWS access keys set in ./dc-app-performance-toolkit/app/util/k8s/aws_envs file:
     • AWS_ACCESS_KEY_ID
     • AWS_SECRET_ACCESS_KEY
     • AWS_SESSION_TOKEN (only for temporary creds)

2. Navigate to dc-app-performance-toolkit folder and start tests execution:

   1
   2
   export ENVIRONMENT_NAME=your_environment_name
   

   1
   2
   docker run --pull=always --env-file ./app/util/k8s/aws_envs \
   -e REGION=us-east-2 \
   -e ENVIRONMENT_NAME=$ENVIRONMENT_NAME \
   -v "/$PWD:/data-center-terraform/dc-app-performance-toolkit" \
   -v "/$PWD/app/util/k8s/bzt_on_pod.sh:/data-center-terraform/bzt_on_pod.sh" \
   -it atlassianlabs/terraform:2.9.3 bash bzt_on_pod.sh jsm.yml
   

3. View the following main results of the run in the dc-app-performance-toolkit/app/results/jsm/YY-MM-DD-hh-mm-ss folder:

   • results_summary.log: detailed run summary
   • results.csv: aggregated .csv file with all actions and timings
   • bzt.log: logs of the Taurus tool execution
   • jmeter.*: logs of the JMeter tool execution
   • pytest.*: logs of Pytest-Selenium execution

Run 2 (~50 min + Lucene Index timing test)

If you are submitting a Jira Service Management app, you are required to conduct a Lucene Index timing test. This involves conducting a foreground re-index on a single-node Data Center deployment (with your app installed) and a dataset that has 1M issues.

Benchmark your re-index time with your app installed:

1. Install the app you want to test.
2. Setup app license.
3. Go to > System > Indexing.
4. Select the Full re-index option.
5. Click Re-Index and wait until re-indexing is completed.

6. Take a screenshot of the acknowledgment screen displaying the re-index time and Lucene index timing.

7. Attach the screenshot(s) to your ECOHELP ticket.

Performance results generation with the app installed (still use master branch):

1. Navigate to dc-app-performance-toolkit folder and start tests execution:

   1
   2
   export ENVIRONMENT_NAME=your_environment_name
   

   1
   2
   docker run --pull=always --env-file ./app/util/k8s/aws_envs \
   -e REGION=us-east-2 \
   -e ENVIRONMENT_NAME=$ENVIRONMENT_NAME \
   -v "/$PWD:/data-center-terraform/dc-app-performance-toolkit" \
   -v "/$PWD/app/util/k8s/bzt_on_pod.sh:/data-center-terraform/bzt_on_pod.sh" \
   -it atlassianlabs/terraform:2.9.3 bash bzt_on_pod.sh jsm.yml
   

Generating a performance regression report

To generate a performance regression report:

1. Edit the ./app/reports_generation/performance_profile.yml file:
   • For runName: "without app", in the relativePath key, insert the relative path to results directory of Run 1.
   • For runName: "with app", in the relativePath key, insert the relative path to results directory of Run 2.
2. Navigate locally to dc-app-performance-toolkit folder and run the following command from local terminal (Git Bash for Windows users) to generate reports:

   1
   2
   docker run --pull=always \
   -v "/$PWD:/dc-app-performance-toolkit" \
   --workdir="//dc-app-performance-toolkit/app/reports_generation" \
   --entrypoint="python" \
   -it atlassian/dcapt csv_chart_generator.py performance_profile.yml
   

3. In the ./app/results/reports/YY-MM-DD-hh-mm-ss folder, view the .csv file (with consolidated scenario results), the .png chart file and performance scenario summary report.

Scenario 2: Scalability testing

The purpose of scalability testing is to reflect the impact on the customer experience when operating across multiple nodes. For this, you have to run scale testing on your app.

For many apps and extensions to Atlassian products, there should not be a significant performance difference between operating on a single node or across many nodes in Jira Service Management DC deployment. To demonstrate performance impacts of operating your app at scale, we recommend testing your Jira Service Management DC app in a cluster.

Run 3 (~50 min)

To receive scalability benchmark results for one-node Jira Service Management DC with app-specific actions:

1. Before run:

   • Make sure jsm.yml and toolkit code base has code base with your developed app-specific actions.
   • Check correctness of application_hostname, application_protocol, application_port and application_postfix in .yml file.
   • Check load configuration parameters needed for enterprise-scale run: Setting up load configuration for Enterprise-scale runs.
   • standalone_extension set to non 0 and .jmx file has standalone actions implementation in case of JMeter app-specific actions.
   • test_1_selenium_customer_custom_action is uncommented and has implementation in case of Selenium app-specific actions.
   • AWS access keys set in ./dc-app-performance-toolkit/app/util/k8s/aws_envs file:
     • AWS_ACCESS_KEY_ID
     • AWS_SECRET_ACCESS_KEY
     • AWS_SESSION_TOKEN (only for temporary creds)

2. Navigate to dc-app-performance-toolkit folder and start tests execution:

   1
   2
   export ENVIRONMENT_NAME=your_environment_name
   

   1
   2
   docker run --pull=always --env-file ./app/util/k8s/aws_envs \
   -e REGION=us-east-2 \
   -e ENVIRONMENT_NAME=$ENVIRONMENT_NAME \
   -v "/$PWD:/data-center-terraform/dc-app-performance-toolkit" \
   -v "/$PWD/app/util/k8s/bzt_on_pod.sh:/data-center-terraform/bzt_on_pod.sh" \
   -it atlassianlabs/terraform:2.9.3 bash bzt_on_pod.sh jsm.yml
   

Run 4 (~50 min)

To receive scalability benchmark results for two-node Jira Service Management DC with app-specific actions:

1. Navigate to dc-app-perfrormance-toolkit/app/util/k8s folder.

2. Open dcapt.tfvars file and set jira_replica_count value to 2.

3. From local terminal (Git Bash for Windows users) start scaling (~20 min):

   1
   2
   docker run --pull=always --env-file aws_envs \
   -v "/$PWD/dcapt.tfvars:/data-center-terraform/conf.tfvars" \
   -v "/$PWD/dcapt-snapshots.json:/data-center-terraform/dcapt-snapshots.json" \
   -v "/$PWD/logs:/data-center-terraform/logs" \
   -it atlassianlabs/terraform:2.9.3 ./install.sh -c conf.tfvars
   

4. Navigate to dc-app-performance-toolkit folder and start tests execution:

   1
   2
   export ENVIRONMENT_NAME=your_environment_name
   

   1
   2
   docker run --pull=always --env-file ./app/util/k8s/aws_envs \
   -e REGION=us-east-2 \
   -e ENVIRONMENT_NAME=$ENVIRONMENT_NAME \
   -v "/$PWD:/data-center-terraform/dc-app-performance-toolkit" \
   -v "/$PWD/app/util/k8s/bzt_on_pod.sh:/data-center-terraform/bzt_on_pod.sh" \
   -it atlassianlabs/terraform:2.9.3 bash bzt_on_pod.sh jsm.yml
   

Run 5 (~50 min)

To receive scalability benchmark results for four-node Jira Service Management DC with app-specific actions:

1. Scale your Jira Data Center deployment to 4 nodes as described in Run 4.

2. Navigate to dc-app-performance-toolkit folder and start tests execution:

   1
   2
   export ENVIRONMENT_NAME=your_environment_name
   

   1
   2
   docker run --pull=always --env-file ./app/util/k8s/aws_envs \
   -e REGION=us-east-2 \
   -e ENVIRONMENT_NAME=$ENVIRONMENT_NAME \
   -v "/$PWD:/data-center-terraform/dc-app-performance-toolkit" \
   -v "/$PWD/app/util/k8s/bzt_on_pod.sh:/data-center-terraform/bzt_on_pod.sh" \
   -it atlassianlabs/terraform:2.9.3 bash bzt_on_pod.sh jsm.yml
   

Generating a report for scalability scenario

To generate a scalability report:

1. Edit the ./app/reports_generation/scale_profile.yml file:
   • For runName: "1 Node", in the relativePath key, insert the relative path to results directory of Run 3.
   • For runName: "2 Nodes", in the relativePath key, insert the relative path to results directory of Run 4.
   • For runName: "4 Nodes", in the relativePath key, insert the relative path to results directory of Run 5.
2. Navigate locally to dc-app-performance-toolkit folder and run the following command from local terminal (Git Bash for Windows users) to generate reports:

   1
   2
   docker run --pull=always \
   -v "/$PWD:/dc-app-performance-toolkit" \
   --workdir="//dc-app-performance-toolkit/app/reports_generation" \
   --entrypoint="python" \
   -it atlassian/dcapt csv_chart_generator.py scale_profile.yml
   

3. In the ./app/results/reports/YY-MM-DD-hh-mm-ss folder, view the .csv file (with consolidated scenario results), the .png chart file and performance scenario summary report. If you see an impact (>20%) on any action timing, we recommend taking a look into the app implementation to understand the root cause of this delta.

Attaching testing results to ECOHELP ticket

1. Make sure you have two reports folders: one with performance profile and second with scale profile results. Each folder should have profile.csv, profile.png, profile_summary.log and profile run result archives. Archives should contain all raw data created during the run: bzt.log, selenium/jmeter/locust logs, .csv and .yml files, etc.
2. Attach two reports folders to your ECOHELP ticket.

Support

If the installation script fails on installing Helm release or any other reason, collect the logs, zip and share to community Slack #data-center-app-performance-toolkit channel. For instructions on how to collect detailed logs, see Collect detailed k8s logs. For failed cluster uninstall use Force terminate command.

In case of any technical questions or issues with DC Apps Performance Toolkit, contact us for support in the community Slack #data-center-app-performance-toolkit channel.