QMetry Upgrade Document (from QMetry v8.10.3 and above)

Steps to upgrade QMetry from v8.10.3 and above to latest version


Important Pre-requisites to check before upgrade.

  • Proceed with this upgrade ONLY IF your current QMetry version is v8.10.3 or above. To check: Go to QMetry > About section.

  • Mysql version of QMetry Reports and QMetry Application should be 5.7.29.

  • Ensure internet connectivity is enabled on the server for this upgrade.

Follow the steps mentioned below to upgrade your existing QMetry installation:

Step 1 : IMPORTANT : Backup your existing QMetry Database

Take the backup of your existing “qmetry” database. You can replace the username, password, location of the backup file (currently default /opt).

  • Syntax : docker exec qmetry_rds_1 sh -c 'exec mysqldump -uroot -p<password> --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_<date>.sql

  • For example: docker exec qmetry_rds_1 sh -c 'exec mysqldump -uroot -pqmetry --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry' > /opt/qmetry_backup_2021-01-01.sql

Verify that your database has been backed up properly and is available for later use in case of any emergency.

Step 2 : Download Required Files

  • You can generate a request on the QMetry Support Portal, to get the latest version of QMetry Upgrade Installer.

  • Download the QMetry81031.zip to your QMetry Application Server once you receive it.

Step 3 : Run the QMetry Upgrade

1. Check the running containers using the following command. The dockers must be running to ensure a successful upgrade.

  • docker ps
  • If the dockers are not running, start them using the below commands (replace container names according to the application container name seen in the command above)
    • docker start qmetry_rds_1
    • docker start qmetry_app_1

2. Go to the directory where the QMetry81031.zip file is downloaded.

3. Copy QMetry81031.zip file inside the docker container using the following command

  • command : docker cp QMetry81031.zip qmetry_app_1:/opt
    • Note: Your current tomcat installed path in docker container would be /home/qmetry/QMetry.

4. Log in to the docker container, using the following command

  • command : docker exec -it qmetry_app_1 bash

5. Go to /opt directory where the QMetry81031.zip file is copied using the command

  • cd /opt

6. Unzip the file under the /opt directory separate from your current installation path /home/qmetry/QMetry

  • unzip QMetry81031.zip

7. Go to QMetry directory:

  • cd QMetry81031

8. Give permission to upgrade_qmetry.sh file through the following command.

  • chmod +x upgrade_qmetry.sh

9. Enter the following command and then pass the parameters mentioned.
  • sh upgrade_qmetry.sh

10. Utility will confirm if you want to upgrade, type Yes, and then specify the path of the existing QMetry installation.

OptionsTypeDefault ValueComments/ Example

Do you want to proceed with QMetry upgrade (Y/N)?



type - Y/N

Wait for the process to complete.

11. Exit from docker container once the process is completed, use the following command:

  • exit

Step 4 : Restart QMetry and MySQL Docker Container

  • Check the running containers using the following command:
    • docker ps
  • Restart both docker containers using the below commands: 
    • docker stop qmetry_app_1 qmetry_rds_1
    • docker start qmetry_rds_1
    • docker start qmetry_app_1

Step 5 : Installing / Upgrading Jira add-on for the Integration of QMetry and Jira.

Note: It is important to have the correct version of the Jira add-on installed in Jira based on your upgraded and current QMetry version. Refer to the below table for the right version of  "QMetry Jira Integration".

QMetry VersionJira-addon version required & above2.2.0

Upgrade your Jira add-on as per the above compatibility matrix. In case you have not installed the QMetry Jira Integration app for integration, follow the Steps to Install and Configure the QMetry Jira Integration app, if it is not installed.

If you are facing any issues during the upgrade process, kindly generate a support ticket on Support Portal for assistance.