Skip to main content

Upgrade ArcGIS Monitor

Follow the steps in the sections below to upgrade ArcGIS Monitor 2024.x or later.

Follow the steps in the sections below to upgrade ArcGIS Monitor 2025.0 or later.

Learn more about upgrading Monitor 2024.x

Note:

All machines in a Monitor deployment must be upgraded to the same major.minor version.

Prepare to upgrade Monitor

Review the following information and complete any required actions before you upgrade Monitor:

  • Review the Monitor system requirements to ensure that your hardware meets the current requirements.

  • Before upgrading Monitor, check the size of the Monitor database. Ensure that the machine hosting the database contains enough temporary free disk space to accommodate double the size of the database.

    Tip:

    To check the size of the Monitor database, run the following SQL query on the machine hosting the database, replacing <DatabaseName> in the example with the name of the Monitor database:

    SELECT pg_size_pretty(pg_database_size('<DatabaseName>'));

  • Create a backup of the Monitor database and all Monitor machines in the deployment, and store the backup files in a secure, remote location.

  • Download the latest ArcGIS Monitor software installation files and authorization file from My Esri.

  • Do not uninstall the previous version of ArcGIS Monitor Server or ArcGIS Monitor Agent. There is no need to obtain and install each previously released version in sequence.

    Note:

    Only one version can be installed on a machine at a time; when you install a new version, the previous version is replaced.

  • Do not uninstall the previous version of ArcGIS Monitor Server or ArcGIS Monitor Agent until instructed to do so. There is no need to obtain and install each previously released version in sequence.

    Note:

    Only one version can be installed on a machine at a time; when you install a new version, the previous version is replaced.

  • For Monitor Agent machines to function, they must be the same major.minor version as the Monitor Server machine.

  • Stop the ArcGIS Monitor Server service on the Monitor Server machine and the ArcGIS Monitor Agent service on all Monitor Agent machines using the Windows Services tool before you upgrade. Monitoring is not available when the services are stopped.

    Note:

    Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

  • Stop the arcgis-monitor-server service on the Monitor Server machine and the arcgis-monitor-agent service on all Monitor Agent machines by running the following commands as a user in the sudoers group:

    • Monitor Server:

      `sudo systemctl stop arcgis-monitor-server

    • Monitor Agent:

      sudo systemctl stop arcgis-monitor-agent

    Monitoring is not available when the service is stopped.

    Note:

    Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

Upgrade a Monitor deployment

The recommended order to upgrade a Monitor deployment is as follows:

  1. Upgrade Monitor Server.

  2. Upgrade Monitor Agent.

    Note:

    Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

Starting with the Monitor 2024.0 release, all host machines must have Monitor Agent installed to collect metrics.

Learn more about deploying Monitor

Upgrade Monitor Server

Once you have the installation files and backup files, complete the upgrade steps for Monitor Server. Do not uninstall the existing Monitor Server version before installing the new version.

You can upgrade using an interactive wizard-driven experience by running the Setup.exe program or run Setup.exe from a command prompt or batch script to silently upgrade Monitor Server. The Setup.exe installation file detects and updates the existing installation of Monitor Server.

Upgrade using an interactive wizard-driven experience

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server using an interactive wizard. To upgrade using commands instead, proceed to the next section.

  1. Stop the ArcGIS Monitor Server service using the Windows Services tool before you upgrade.

    Monitoring is not available when the service is stopped.

  2. Run the Monitor Server Setup.exe file on the Monitor Server machine.

    Do not uninstall the existing Monitor Server installation.

  3. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

    When you accept the license agreement, the Monitor Server setup program displays the features that will be installed.

  4. When prompted, provide the credentials for the ArcGIS Monitor account.

    Typically, this is the username and password that you defined when the software was installed. If the username or password has changed since the software was installed, provide the credentials for the current ArcGIS Monitor account. If you are unsure of the username or password for the account, contact your system administrator.

  5. Once you have updated the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.

Upgrade using commands

Rather than running the setup program, you can run the Setup.exe file at a command prompt or in a batch script to update Monitor Server. To avoid receiving a prompt to proceed with the upgrade, run the command in silent mode by including the /qb parameter in the script.

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server:

  1. Stop the ArcGIS Monitor Server service using the Windows Services tool before you upgrade.

    Monitoring is not available when the service is stopped.

  2. Run the Monitor Server Setup.exe file from a command prompt or in a script on the Monitor Server machine.

    Do not uninstall the existing Monitor Server installation.

    The ACCEPTEULA parameter is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this parameter results in a failed installation. For more information, review the Master Agreement.

    When upgrading using the Setup.exe file in silent mode, you must specify the ArcGIS Monitor account. Typically, this is the account you defined when installing the software. If the account has changed since the software was installed, provide the current username and password of the ArcGIS Monitor account.

    If you do not specify the ArcGIS Monitor account, or it does not match the account used by the current installation, a message appears, indicating that the credentials could not be validated and the installation fails. If you are unsure of the username or password for the account, contact your system administrator.

    In the following example, the account used by the software is myaccount and the password is my.password:

    <path to ArcGIS Monitor Server setup download folder>\Setup.exe /qb ACCEPTEULA=yes USER_NAME=myaccount PASSWORD=my.password

    In the following example, the domain account used by the software is mydomain\myaccount and the password is my.password:

    <path to ArcGIS Monitor Server setup download folder>\Setup.exe /qb ACCEPTEULA=yes USER_NAME=mydomain\myaccount PASSWORD=my.password
    Caution:

    Command line parameters are case sensitive. If you have trouble upgrading, confirm that the case matches the properties as shown in the examples.

  3. Once you have updated the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.

    Note:

    Depending on the number of components in the Monitor deployment, it may take several minutes for post-upgrade tasks to complete. Access to Monitor is not available until these tasks are completed.

Once you have the installation and backup files, complete the upgrade steps for Monitor Server. Do not uninstall the existing Monitor Server version until instructed to do so.

You can upgrade using an interactive command line interface (CLI), or silently upgrade Monitor Server from the CLI. The setup script detects and updates the existing installation of Monitor Server.

Upgrade using an interactive CLI

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the steps below to upgrade Monitor Server using an interactive CLI. To perform a silent upgrade instead, proceed to the next section.

  1. Start a terminal session on the Monitor Server machine with a user account in the sudoers group.

  2. Run the following commands to uninstall previous versions of the Monitor Server service:

    • Ubuntu:

      sudo systemctl stop arcgis-monitor-server
sudo systemctl disable arcgis-monitor-server
sudo rm -rf /etc/systemd/system/arcgis-monitor-server.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service

    • Red Hat Enterprise Linux Server:

      sudo systemctl stop arcgis-monitor-server
sudo systemctl disable arcgis-monitor-server
sudo rm -rf /etc/systemd/system/arcgis-monitor-server.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service

  3. Start a terminal session on the Monitor Server machine with the ArcGIS Monitor account.

  4. Run the following command to uninstall the previous version of Monitor Server:

    <Monitor Server installation location>/uninstall_Monitor.sh

    The following is an example:

    /home/arcgis/arcgis/monitor/server/uninstall_Monitor.sh

  5. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

    The following is an example:

    tar -zxvf ArcGIS_Monitor_Server.tar.gz

  6. Change the directory to the location that contains the extracted Monitor Server setup file.

  7. From the command shell, run Setup.sh.

    The following is an example:

    ./Setup.sh

  8. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

    Tip:

    Press Q on your keyboard to close the Master Agreement.

  9. Follow the prompts on the screen to install the software.

  10. After the installation has finished, run the following command as a user in the sudoers group to configure the arcgis-monitor-server service to automatically start with the operating system:

    sudo <Monitor Server installation location>/framework/etc/scripts/create_Monitor_Server_service.sh

    The default installation directory is <ArcGIS Monitor user account home directory>/arcgis/monitor/server.

    The service is configured to start with the operating system and a message appears indicating the service's status. If the service is not running, run the following command as a user in the sudoers group to start the service:

    sudo systemctl start arcgis-monitor-server

  11. Once you update the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.

    Note:

    Depending on the number of components in the Monitor deployment, it may take several minutes for post-upgrade tasks to complete. Access to Monitor is not available until these tasks are completed.

Upgrade silently from the CLI

Rather than running the interactive CLI, you can upgrade Monitor Server silently.

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server:

  1. Start a terminal session on the Monitor Server machine with a user account in the sudoers group.

  2. Run the following commands to uninstall previous versions of the Monitor Server service:

    • Ubuntu:

      sudo systemctl stop arcgis-monitor-server
sudo systemctl disable arcgis-monitor-server
sudo rm -rf /etc/systemd/system/arcgis-monitor-server.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service

    • Red Hat Enterprise Linux Server:

      sudo systemctl stop arcgis-monitor-server
sudo systemctl disable arcgis-monitor-server
sudo rm -rf /etc/systemd/system/arcgis-monitor-server.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service

  3. Start a terminal session on the Monitor Server machine with the ArcGIS Monitor account.

  4. Run the following command to uninstall the previous version of Monitor Server:

    <Monitor Server installation location>/uninstall_Monitor.sh

    The following is an example:

    /home/arcgis/arcgis/monitor/server/uninstall_Monitor.sh

  5. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

    The following is an example:

    tar -zxvf ArcGIS_Monitor_Server.tar.gz

  6. Change the directory to the location that contains the extracted ArcGIS Monitor Server setup file.

  7. From the command shell, run Setup.sh.

    The --license-agreement parameter is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no results in a failed installation.

    The following is an example:

    ./Setup.sh -l yes [options]

    -l; --license-agreement CHOICE

    This property is required to accept the EULA during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property will result in a failed installation. The download contains a PDF of the EULA. The EULA.pdf file is in the Documentation folder.

    -d; --directory DIRECTORY

    This property is optional. By default, Monitor Server is installed to the $HOME directory. DIRECTORY specifies a different installation directory.

    The /arcgis/monitor/server path is appended to the installation directory.

    -h; --help

    This property displays command line help and exits.

  8. After the installation has finished, run the following command as a user in the sudoers group to configure the arcgis-monitor-server service to automatically start with the operating system:

    sudo <Monitor Server installation location>/framework/etc/scripts/create_Monitor_Server_service.sh

    The default installation directory is <ArcGIS Monitor user account home directory>/arcgis/monitor/server.

    The service is configured to start with the operating system and a message appears indicating the service's status. If the service is not running, run the following command as a user in the sudoers group to start the service:

    sudo systemctl start arcgis-monitor-server

  9. Once you update the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.

    Note:

    Depending on the number of components in the Monitor deployment, it may take several minutes for post-upgrade tasks to complete. Access to Monitor is not available until these tasks are completed.

Upgrade Monitor Agent

Once you have the installation files and backup files, complete the upgrade steps on each Monitor Agent machine in your Monitor deployment. All machines in the Monitor deployment must be upgraded to the same major.minor version. Do not uninstall the existing Monitor Agent version before installing the new version.

You can upgrade using an interactive wizard-driven experience by running the Setup.exe program or run Setup.exe from a command prompt or batch script to silently upgrade Monitor Agent. The Setup.exe installation file detects and updates the existing installation of Monitor Agent.

Once you have the installation and backup files, complete the upgrade steps on each Monitor Agent machine in the Monitor deployment. All machines in the Monitor deployment must be upgraded to the same major.minor version. Do not uninstall the existing Monitor Agent version until instructed to do so.

You can upgrade using a CLI, or silently upgrade Monitor Agent from the CLI. The setup script detects and updates the existing installation of Monitor Agent.

Note:

Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

Upgrade using an interactive wizard-driven experience

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Agent using an interactive wizard. To upgrade using commands instead, proceed to the next section.

  1. Stop the ArcGIS Monitor Agent service using the Windows Services tool before you upgrade.

    Monitoring is not available when the service is stopped.

  2. Run the Monitor Agent Setup.exe program on each Monitor Agent machine in the deployment.

    Do not uninstall the existing Monitor Agent installation.

  3. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

    When you accept the license agreement, the Monitor setup program displays the features that will be installed.

  4. When prompted, provide the credentials for the ArcGIS Monitor account.

    Typically, this is the username and password that you defined when the software was installed. If the username or password has changed since the software was installed, provide the credentials for the current ArcGIS Monitor account. If you are unsure of the username or password for the account, contact your system administrator.

  5. Once you have updated the Monitor Agent installation, open a supported web browser, access Monitor, and verify that the Monitor Agent machine is connected to Monitor Server.

Upgrade using commands

Rather than running the setup program, you can run the Setup.exe file at a command prompt or in a batch script to update Monitor Server. To avoid receiving a prompt to proceed with the upgrade, run the command in silent mode by including the /qb parameter in the script.

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server:

  1. Stop the ArcGIS Monitor Agent service using the Windows Services tool before you upgrade.

    Monitoring is not available when the service is stopped.

  2. Run the Monitor Setup.exe file from a command prompt or in a script on each Monitor Agent machine in the deployment.

    Do not uninstall the existing Monitor Agent installation.

    The ACCEPTEULA parameter is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this parameter results in a failed installation. For more information, review the Master Agreement.

    When upgrading using the Setup.exe file in silent mode, you must specify the ArcGIS Monitor account. Typically, this is the account you defined when installing the software. If the account has changed since the software was installed, provide the current username and password of the ArcGIS Monitor account.

    If you do not specify the ArcGIS Monitor account, or it does not match the account used by the current installation, a message appears, indicating that the credentials could not be validated and the installation fails.

    In the following example, the account used by the software is myaccount and the password is my.password:

    <path to the ArcGIS Monitor setup download>\setup.exe /qb ACCEPTEULA=yes ADDLOCAL=Agent USER_NAME=myaccount PASSWORD=my.password

    In the following example, the domain account used by the software is mydomain\myaccount and the password is my.password:

    <path to ArcGIS Monitor setup download folder>\Setup.exe /qb ACCEPTEULA=yes ADDLOCAL=Agent USER_NAME=mydomain\myaccount PASSWORD=my.password
    Caution:

    Command line parameters are case sensitive. If you are having trouble upgrading, confirm that the case matches the properties as shown in the examples.

  3. Once you have updated the Monitor Agent installation, open a supported web browser, access Monitor, and verify that the Monitor Agent machine is connected to Monitor Server.

Upgrade using an interactive CLI

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the steps below to upgrade Monitor Agent using an interactive CLI. To perform a silent upgrade instead, proceed to the next section.

  1. Start a terminal session on the Monitor Agent machine with a user account in the sudoers group.

  2. Run the following commands to uninstall previous versions of the Monitor Agent service:

    • Ubuntu:

      sudo systemctl stop arcgis-monitor-agent
sudo systemctl disable arcgis-monitor-agent
sudo rm -rf /etc/systemd/system/arcgis-monitor-agent.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service

    • Red Hat Enterprise Linux Server:

      sudo systemctl stop arcgis-monitor-agent
sudo systemctl disable arcgis-monitor-agent
sudo rm -rf /etc/systemd/system/arcgis-monitor-agent.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service

  3. Start a terminal session on the Monitor Agent machine with the ArcGIS Monitor account.

  4. Run the following command to uninstall the previous version of Monitor Agent:

    <Monitor Agent installation location>/uninstall_Monitor.sh

    The following is an example:

    /home/arcgis/arcgis/monitor/agent/uninstall_Monitor.sh

  5. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

    The following is an example:

    tar -zxvf ArcGIS_Monitor_Agent.tar.gz

  6. Change the directory to the location that contains the extracted Monitor Agent setup file.

  7. From the command shell, run Setup.sh.

    The following is an example:

    ./Setup.sh`
``

  8. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

    Tip:

    Press Q on your keyboard to close the Master Agreement.

  9. Follow the prompts on the screen to install the software.

  10. After the installation has finished, run the following command as a user in the sudoers group to configure the arcgis-monitor-agent service to automatically start with the operating system:

    sudo <Monitor Agent installation location>/framework/etc/scripts/create_Monitor_Agent_service.sh

    The default installation directory is <ArcGIS Monitor user account home directory>/arcgis/monitor/agent.

    The service is configured to start with the operating system and a message appears indicating the service's status. If the service is not running, run the following command as a user in the sudoers group to start the service:

    sudo systemctl start arcgis-monitor-agent

  11. Once you update the Monitor Agent installation, open a supported web browser, access Monitor, and verify that the Monitor Agent machine is connected to Monitor Server.

Upgrade silently from the CLI

Rather than running the interactive CLI, you can upgrade Monitor Agent silently.

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Agent:

  1. Start a terminal session on the Monitor Agent machine with a user account in the sudoers group.

  2. Run the following commands to uninstall previous versions of the Monitor Agent service:

    • Ubuntu:

      sudo systemctl stop arcgis-monitor-agent
sudo systemctl disable arcgis-monitor-agent
sudo rm -rf /etc/systemd/system/arcgis-monitor-agent.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service

    • Red Hat Enterprise Linux Server:

      sudo systemctl stop arcgis-monitor-agent
sudo systemctl disable arcgis-monitor-agent
sudo rm -rf /etc/systemd/system/arcgis-monitor-agent.service
sudo rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service

  3. Start a terminal session on the Monitor Agent machine with the ArcGIS Monitor account.

  4. Run the following command to uninstall the previous version of Monitor Agent:

    <Monitor Agent installation location>/uninstall_Monitor.sh

    The following is an example:

    /home/arcgis/arcgis/monitor/agent/uninstall_Monitor.sh

  5. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

    The following is an example:

    tar -zxvf ArcGIS_Monitor_Agent.tar.gz

  6. Change the directory to the location that contains the extracted Monitor Agent setup file.

  7. From the command shell, run Setup.sh.

    The --license-agreement parameter is required to accept the EULA during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no results in a failed installation.

    The following is an example:

    ./Setup.sh -l yes [options]

    -l; --license-agreement CHOICE

    This property is required to accept the EULA during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property will result in a failed installation. The download contains a PDF of the EULA. The EULA.pdf file is in the Documentation folder.

    -d; --directory DIRECTORY

    This property is optional. By default, Monitor Server is installed to the $HOME directory. DIRECTORY specifies a different installation directory.

    The /arcgis/monitor/agent path is appended to the installation directory.

    -h; --help

    This property displays command line help and exits.

  8. After the installation has finished, run the following command as a user in the sudoers group to configure the arcgis-monitor-agent service to automatically start with the operating system:

    sudo <Monitor Agent installation location>/framework/etc/scripts/create_Monitor_Agent_service.sh

    The default installation directory is <ArcGIS Monitor user account home directory>/arcgis/monitor/agent.

    The service is configured to start with the operating system and a message appears indicating the service's status. If the service is not running, run the following command as a user in the sudoers group to start the service:

    sudo systemctl start arcgis-monitor-agent

  9. Once you update the Monitor Agent installation, open a supported web browser, access Monitor, and verify that the Monitor Agent machine is connected to Monitor Server.

Considerations after upgrading

It is recommended that you create a backup of the Monitor database and all Monitor machines in the deployment after upgrading. After upgrading, confirm that the deployment is collecting data as expected by accessing Monitor and viewing collection details and component details.