Documentation forDatabase Performance Analyzer

Upgrade DPA on a Linux-based OS

If you are upgrading from DPA 2022.3 and you configured DPA 2022.3 for SAML authentication, see this knowledge article.

See the following sections:

Install the new files

  1. Review the upgrade checklist and prepare your environment.
  2. Download the most recent version of DPA from the SolarWinds Customer Portal.
  3. Log in to the DPA server as a user that owns all of the files in the DPA installation directory.

    If the Find SQL indexes were moved to a custom location, the user must also own all of the files in the custom location.

    To determine if the Find SQL indexes were moved and where, open the following file in a text editor:

    /home/solarwinds/dpa_V_v/DPA/iwc/tomcat/ignite_config/idc/system.properties

    Look for either of the following lines:

    • com.solarwinds.dpa.findSql.index.location=your_custom_location (if all indexes were moved to the same directory)

    • com.solarwinds.dpa.findSql.index.location.db_id=your_custom_location (if indexes for a specific database were moved)

    If neither of those lines are present, the indexes are in the default location:

    /home/solarwinds/dpa_V_v/DPA/iwc/tomcat/ignite_config/lucene-index/

  4. Install the new version in a new directory on your existing server.
  5. Run ./shutdown.sh from the old installation directory.
  6. Locate the directory that was created when you installed the new version:

    /home/dpa_x_x = old installation home

    /home/dpa_y_y = new DPA home

  7. If you are upgrading from DPA 2024.4.200 or earlier, replace your old server.xml file with the new one.

    The current version of Tomcat uses a different structure for keystore properties than earlier versions, and some properties have been renamed.

    • If you are using the default SSL certificate (not a custom certificate):

      1. Make a backup of the server.xml file from the old /home/dpa_x_x/iwc/tomcat/conf/ directory, and save the backup in a different directory.

      2. Copy the server.xml file from the new /home/dpa_y_y/iwc/tomcat/conf/, and put it in the old directory (replacing the existing file).

    • If you are using a custom SSL certificate, edit the server.xml file to include the correct values for your environment:

      1. Edit the following properties in the server.xml file in the new /home/dpa_y_y/iwc/tomcat/conf/ and change the values to match the corresponding property from your old server.xml file.

        Old property New property
        keystoreFile="conf/.keystore" certificateKeystoreFile="conf/.keystore"
        keystoreType="PKCS12" certificateKeystoreType="PKCS12"

        The file should look similar to the following example:

        <!-- Note: AIX requires algorithm="ibmX509" attribute to be present in the connector -->
        <Connector port="8124" maxHttpHeaderSize="20480" URIEncoding="UTF-8" 
              scheme="https" secure="true" SSLEnabled="true"
              clientAuth="false" useServerCipherSuitesOrder="true" compression="on"
              compressionMinSize="2048" 
              compressibleMimeType="text/html,text/xml,text/csv,text/css,application/javascript"
              sslEnabledProtocols="TLSv1.2+TLSv1.3"
              ciphers="HIGH:!SHA1:!SHA256:!SHA384:!RSA:!DHE"
              defaultSSLHostConfigName="dpasslhost">
           <SSLHostConfig hostName="dpasslhost">
              <Certificate certificateKeystoreFile="conf/.keystore"
                 certificateKeystoreType="PKCS12"
                 type="RSA" />
           </SSLHostConfig>
        </Connector>
      2. If the following properties are present in the Connector property in the old server.xml file, add the corresponding property to the SSLHostConfig property in the new server.xml file.

        Add only the properties that were already in your server.xml file. If a property listed below was not in the old file, do not add it to the new file.

        Old property New property
        keystorePass="password" certificateKeystorePassword="password"
        keyPass="keypassword" certificateKeyPassword="keypassword"
        keyAlias="alias" certificateKeyAlias="alias"

        The new SSLHostConfig property within the Connector property should look similar to the following example:

        <SSLHostConfig hostName="dpasslhost">
          <Certificate certificateKeystoreFile="conf/.keystore"
            certificateKeystoreType="PKCS12"
            certificateKeyAlias="somealias"
            certificateKeystorePassword="mypassword"
            certificateKeyPassword="mykeypassword"
            type="RSA" />
        </SSLHostConfig>
      3. Make a backup of the server.xml file from the old/home/dpa_x_x/iwc/tomcat/conf/ directory, and save the backup in a different directory.

      4. Copy the server.xml file that you edited in the new/home/dpa_y_y/iwc/tomcat/conf/, and put it in the old directory (replacing the existing file).

  8. Copy or move these directories from the old installation directory to the new directory:

    /iwc/tomcat/conf/
    /iwc/tomcat/ignite_config/
    /iwc/tomcat/logs/
    /iwc/tomcat/licensing

    Do not copy hotfix files.

    For example:

    mv OLD_home/iwc/tomcat/ignite_config/* NEW_home/iwc/tomcat/ignite_config/

    or

    cp -rp OLD_home/iwc/tomcat/ignite_config/* NEW_home/iwc/tomcat/ignite_config/

    Copying Find SQL index data might take some time.

  9. If you encrypted the keystore password for SSL/TLS in the Tomcat server configuration file used by DPA, copy or move the following file from the old installation to the new:

    /iwc/tomcat/lib/swdpa-customutil-1.0.0.jar

  10. If you are upgrading from DPA 2023.2.100 or earlier, open /iwc/tomcat/conf/context.xml in a text editor and delete the following string:

    useRelativeRedirects="false"

    This string fixed an issue in previous versions of Tomcat. It is no longer needed, and it should be removed for security reasons.

  11. If you changed the default SolarWinds DPA ports, edit the server.xml file in the new installation to incorporate the port changes from your earlier installation.

Complete the upgrade and restart DPA

To complete the upgrade:

  • Update any system startup files or cron job scripts that were created for the older version.

  • Ensure the older version of DPA cannot start because this will cause conflicts with your ports, monitored instances, and the repository.

  • If you have configured DPA to use a custom certificate for SSL/TLS, migrate the custom certificate.

If one or more DPA licenses are expired, you must remove the expired licenses before DPA can complete the repository upgrade. When all licenses are compliant, you can complete the upgrade process by opening DPA and clicking Proceed with upgrade.

To restart DPA, run ./startup.sh from the new directory.