Versions Compared

Old Version 2

changes.mady.by.user Martin Moghadam

Saved on

compared with

New Version Current

changes.mady.by.user Martin Moghadam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip
iconfalse

Before you upgrade PerformanceGuard, make sure that you know the hardware recommendations and software requirements.

Important Prerequisites

It's important to be aware of the following before you begin the upgrade process:

  • You must have administrative rights on the computer that you are going to perform the upgrade on (local administrator).
  • The new version of PerformanceGuard may require a different Java JDK and/or Microsoft .NET Framework version than your old one. If the new PerformanceGuard version requires a different JDK and/or .NET Framework version, it is important that you install the required JDK and/or .NET Framework version on the PerformanceGuard server before you install the new version of PerformanceGuard. See also Software Requirements and Install Java JDK.
  • You should install the new version at the same location as the one you are upgrading. Make a note of the location that PerformanceGuard is currently installed at.
  • You must uninstall first and then re-install the newer version when upgrading if you are using service accounts for accessing the database.

  • If you use SQL Server authentication, passwords for the databases must follow the password policy for the SQL Server that you use.

    Tip
    iconfalse

    View Microsoft's SQL Server password policies (link applies for SQL Server 2012, but you can select other SQL Server versions on the page).

  • You can download the server installer for the latest PerformanceGuard version. You can download the server installer for the latest PerformanceGuard version from the CapaSystems wiki.

If You Want to Upgrade a PerformanceGuard Installation that Uses Windows Authentication


Note
iconfalse

If your current PerformanceGuard installation uses Windows authentication for some or all of its services, perform steps 1-5 in the following, but note that during step 5 you should also specify the Windows account(s) that should run the required service(s). Read more details about this under step 5.


Step 1: Stop PerformanceGuard Services

Select Image Removed  Image Added /Start, type services.msc and press ENTER. Then stop these services:

  • PerformanceGuard Backend Server
  • PerformanceGuard Frontend Server
  • PerformanceGuard Web Server
  • PerformanceGuard Web Server 2

Step 2:

Back Up PerformanceGuard Databases

Back up your PerformanceGuard Frontend and Backend server databases before you upgrade your PerformanceGuard installation. Having a backup is important in the unlikely case that something goes wrong during your upgrade.
See Database Backup for more information.

Step 3: Back Up Current PerformanceGuard Installation

Back up all of the content of the following folders in your current PerformanceGuard installation, including subfolders:

  • [PerformanceGuard installation folder]\collector
  • [PerformanceGuard installation folder]\display
  • [PerformanceGuard installation folder]\notification
  • [PerformanceGuard installation folder]\reports

Step 4: Upgrade PerformanceGuard

Tip
iconfalse

Remember to update the msiproperties file in the installation folder of PerformanceGuard i.e. C:\Program Files\PerformanceGuard\msiproperties.properties before upgrading. This implies to you only if you have changed any parameters e.g. port no, password, database's connection URL etc. These changed parameters must reflect the parameters in the msiproperties file.

  • Start an elevated Windows command prompt and navigate to the folder that contains the installer for the new PerformanceGuard version. 

    Info
    iconfalse
    Expand
    titleWhat's an elevated command prompt?

    It is a command prompt that's able to execute commands with administrative privileges. To get an elevated command prompt, click Image Removed /Start, type cmd, right-click Command Prompt in the search results, and select Run as administrator.

    • Start the installation with the following command:

    Code Block
    languagepowershell
    themeEmacs
    msiexec /i PerformanceGuard.msi /L*v! installLog.txt

    The /L*v! parameter in the command makes sure that the installer records a log file of the installation. In this case the log file will be called installLog.txt. The log file will be available at the location from which you run the installation, so if you run the installation file from C:\, the log file will be placed under C:\ too.

    Note
    iconfalse

    PerformanceGuard is by default installed in C:\Program Files\PerformanceGuard. If your old PerformanceGuard installation was installed at another location, for example on the D: drive, it is important that you specify the location that your require, otherwise your new PerformanceGuard version will be installed at the default location on the C: drive.

    To install PerformanceGuard at a location other than the default C:\Program Files\PerformanceGuard, add an INSTALLFOLDER parameter to the command, like in the following example where PerformanceGuard is going to be installed on the D: drive:

    Code Block
    languagepowershell
    themeEmacs
    msiexec /i PerformanceGuard.msi /L*v! installLog.txt INSTALLFOLDER="D:\PerformanceGuard"

    If you are installing on a Windows Server CORE (a type of server that doesn't have a graphical user interface), add the following to the command:

    Code Block
    languagepowershell
    themeEmacs
    "/q"
    When the installer open window opens, click Next.

  • Make sure that Automatically apply SQL upgrade scripts is selected. When ready, click Next.

    • Image Removed

    Note
    iconfalse

    If you clear the Automatically apply SQL upgrade scripts box, you must upgrade the PerformanceGuard databases yourself. This is generally not recommended, but some advanced users prefer to be able to do this themselves. If you prefer to upgrade the databases manually, make sure that you know the database user names and passwords as well as the system administrator (sa) password for the SQL Server(s) in question.

     
     
          4. Click Install.

    Image Removed
     
          5. When installation is complete, click Finish.

    Step 5: Adding Custom Encryption

    Note
    iconfalse

    Custom Encryption is optional when upgrading Server.

    You can add AES using two different ways:

    • After Installation is finished, you can add the AES Encryption Key manually in config.properties file. Open [PerformanceGuard installation folder]\collector\conf\config.properties and add the 128 bit long custom key of the aes.key parameter under #Encryption e.g. aes.key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.

    • If you want to upgrade using Installer, then uninstall the Server first and install Server again. Simply add the AES key as you did with first time install.

    Installation Troubleshooting

    If something goes wrong during your installation, you'll see an error message. The error message will typically tell you that:

    • the setup wizard ended prematurely, and
    • that your system has not been modified

    The latter is not always true. Your system may in fact have been modified, even if the error message tells you that it hasn't. Sometimes the entire PerformanceGuard system, including databases, may in fact have been upgraded, but if just a single of the PerformanceGuard services doesn't start after the installation has finished, the error message will appear.
    You are therefore often able to solve the problem yourself.

    What You Should DoIf something goes wrong during your installation, you should first ask yourself if you have you met all of the prerequisites (see the beginning of this topic). For example, do you have administrative rights, and does the computer have the required version of Java JDK?
    Next, you should check your installation log:
    1. Open your installation log. If you followed the installation procedure in the previous, the log file is called installLog.txt. The log file will be available at the location from which you ran the installation, so if you ran the installation file from C:\, the log file will be placed under C:\ too.
    2. Search the log for occurrences of return value 3.
    3. Read the contents of the log file just before occurrences of return value 3 to determine which actions failed during the installation.In this example (click thumbnail to view image in full size), a search for return value 3 revealed that there were problems with the user account specified for the PerformanceGuard Backend server database:Image Removed
    If you go through the installation log as described, you can nearly always find out what went wrong. In many cases you can solve the problem yourself. For instance, the problem identified in the example was solved simply by specifying the correct password for the Backend server database.
    If you need help from PerformanceGuard support, click the PerformanceGuard logo at the top of this page. That will take you to the front page of the help system, where you can find information about your support options.
    If you need help from PerformanceGuard support, you can find information about your support options on the CapaSystems website, http://www.capasystems.com/.

    Step 6: Restore Specific Modifications

    At the end of the upgrade process you may need to re-apply certain configuration settings:
    Stop Services
    Select Image Removed /Start, type services.msc and press ENTER. Then stop these services:

    • PerformanceGuard Backend Server
    • PerformanceGuard Frontend Server
    • PerformanceGuard Web Server
    • PerformanceGuard Web Server 2

    Reports

    Make sure that you move the content from your backup of the report folder (\[PerformanceGuard installation folder\]\reports) to the similar report folder in the new PerformanceGuard version. This way you'll be able to access any old reports in your new PerformanceGuard version

    Services Memory
    The PerformanceGuard services—the Frontend server, Backend Server and Web Server services—are allocated a certain amount of memory (by default a minimum of 2048 MB and a maximum of 4096 MB).
    If your previous PerformanceGuard installation used a higher maximum setting for some or all of the services, you must specify that again.Other Changes
    If you have made changes to the configuration of your old PerformanceGuard version, you'll need to edit the new version's configuration files. Open the configuration files in the following folders from your backup, compare them with the corresponding configuration files in your new PerformanceGuard version, and make any necessary changes to the new version's configuration files:
    • \[PerformanceGuard installation folder\]\collector\conf

    • \[PerformanceGuard installation folder\]\display\conf

      Note
      iconfalse

      If you have used SSL, the ...\display\conf folder will contain a keystore file called pg.keystore. Remember to migrate that keystore file for SSL to work with your signed server certificate on the new PerformanceGuard version.

    • \[PerformanceGuard installation folder\]\notification\conf

    Start Services
    Select Image Removed /Start, type services.msc and press ENTER. Then start these services:

    • PerformanceGuard Backend Server
    • PerformanceGuard Frontend Server
    • PerformanceGuard Web Server
    • PerformanceGuard Web Server 2

    License
    When you access the PerformanceGuard web interface for the first time after upgrading, you must re-install your license.

    Use your existing license from the backup of [PerformanceGuard installation folder]\display\conf\

    Info
    iconfalse
    Expand
    titleDo i not need a new license for the new version?
    No, as long as your existing license hasn't reached its expiry date, you can use it for the new version too.

    Backup Database

    Backup the existing Backend and Frontend(s) Databases

    This step can be skipped if a vm snapshot has been created of the backend database

    Info

    See Create a Full Database Backup - SQL Server | Microsoft Docs

    Step 3: Copy Configuration Files

    Copy the configuration files from the existing installation folder:

    • msiproperties.properties
    • collector/conf/config.properties
    • notification/conf/config.properties
    • display/conf/performanceguard.xml
    • display2/display2.yml
    • display2/display2-ssl.yml

    Step 4: Run the installer PerformanceGuardServer.exe

    Run the installer

    Image Added

    The installer should detect the existing installation and show an upgrade Dialog.

    After Clicking upgrade the installer removes the old version and reads the configuration from the previous version.

    Image Added

    Than continue with the installation, See Install PerformanceGuard Server. Run Install Process like a new installation except use the existing Database and Parameters

    Image Added

    Strange Behavior After Upgrade?

    On rare occasions, PerformanceGuard may behave strangely after an upgrade if its cache and work folders were not cleaned up before you started the new version of PerformanceGuard. Fortunately, there's an easy solution if you experience this: See the troubleshooting topic After Upgrade PerformanceGuard Behaves Strangely.


    What About PerformanceGuard Agents?

    You don't need to upgrade the PerformanceGuard agents that are installed on your organization's computers. Old agents are compatible with new versions of PerformanceGuard.
    Should you wish to upgrade your PerformanceGuard agents anyway, you can download the latest version of the PerformanceGuard agent installer from the CapaSystems wiki. Unless your existing agents are very old (version 5.x or earlier), you don't need to remove existing agents before you deploy the new version.

    Panel

    Search this documentation

    Live Search
    spaceKeyPD

    On this page

    Table of Contents

    In this section

    Child pages (Children Display)