All Products
Search

This Product

    CloudMonitor:Install and uninstall the CloudMonitor agent

    Document Center

    CloudMonitor:Install and uninstall the CloudMonitor agent

    Last Updated:Aug 01, 2024

    To use CloudMonitor to collect metrics from a host operating system and configure alert rules for key metrics, you must install the CloudMonitor agent on the host. This helps you monitor metrics in real time. If you no longer need to use CloudMonitor to monitor a host, you can log on to the host to uninstall the CloudMonitor agent. This topic describes how to automatically install, manually install, and uninstall the CloudMonitor agent on a host.

    Important

    You can manage the CloudMonitor agent only by using an administrator account. For Linux operating systems, use the root user account. For Windows operating systems, use the Administrator account. If you use an administrator account, certain risks may occur. For example, system stability or data security issues may occur. Proceed with caution.

    Background information

    • The CloudMonitor agent is available for the following programming languages: Java, Go, and C++. The CloudMonitor agent for C++ has the latest version. The CloudMonitor agents for Java and Go are no longer maintained. Upgrade the CloudMonitor agents for Java and Go to the CloudMonitor agent for C++ based on the instructions described in this topic. For more information about the versions of the CloudMonitor agent, operating system requirements, installation location on the host, processes running on the host, ports, resource consumption, and logs, see Agent overview.

    • CloudMonitor supports monitoring on Elastic Compute Service (ECS) instances and third-party hosts. Alibaba Cloud hosts include ECS instances and simple application servers. Third-party hosts include on-premises data centers, Tencent Cloud hosts, and AWS hosts. After you register a third-party host as an Alibaba Cloud managed instance by using Cloud Assistant Agent of ECS, you can view the host on the Host Monitoring page and the CloudMonitor agent is automatically installed on the host. You must manually install the CloudMonitor agent on a third-party host that is not managed by Alibaba Cloud. After you install the CloudMonitor agent, you can view the host on the Host Monitoring page.

    • You are not charged for installing the CloudMonitor agent. You can view the metrics and their monitoring charts on the Host Monitoring page. You can configure alert rules free of charge for desired metrics and directly use CloudMonitor Basic without activating it.

    Prerequisites

    Before you automatically install the CloudMonitor agent on a third-party host, make sure that you have registered the host as an Alibaba Cloud managed instance. For more information, see Alibaba Cloud managed instances.

    Automatic installation (recommended)

    We recommend that you use the related features in the CloudMonitor console to automatically install the CloudMonitor agent on ECS instances and third-party hosts.

    1. Log on to the CloudMonitor console.

    2. In the left-side navigation pane, click Cloud Service Monitoring > Host Monitoring.

    3. On the Host Monitoring page, select the ECS instances on which you want to install or upgrade the CloudMonitor agent and click Batch Install.

    4. In the message that appears, click OK.

      The installation or upgrade process requires about 5 minutes to complete. When the agent status changes from Installing to Running, the CloudMonitor agent is installed or upgraded.

      Note

      • For newly purchased ECS instances, you can turn on Automatically Install CloudMonitor Agent on Newly Purchased ECS Instances in the upper-right corner. If you turn off the switch, you must manually install the CloudMonitor agent on each ECS instance.

      • If the agent status on an ECS instance is Stopped or Failed to install, you can automatically or manually install the CloudMonitor agent.

    Use a script to install the CloudMonitor agent

    Use a script to install the CloudMonitor agent on an ECS instance

    If the CloudMonitor agent fails to be automatically installed on an ECS instance, you must install the agent by using a script.

    Note

    If the CloudMonitor agent fails to be automatically installed or upgraded on an ECS instance, you must uninstall the agent then use a script to install it. For more information about how to uninstall the CloudMonitor agent, see How do I uninstall the CloudMonitor agent?

    1. Log on to the CloudMonitor console.

    2. In the left-side navigation pane, click Cloud Service Monitoring > Host Monitoring.

    3. On the Host Monitoring page, find the ECS instance and click the image icon in the argusagent Status column. If the ECS instance does not exist, click Host and Plug-in Operations in the upper part of the host list and then select Manual installation from the drop-down list.

    4. In the Manual installation dialog box, set Host Type to ECS Instance, select the region and operating system of the host, and then follow the installation instruction and command on the page to install the CloudMonitor agent.

      Windows

      1. Download the agent package of the 32-bit version or 64-bit version based on the operating system of the host.

      2. Use an administrator account to log on to the ECS instance on which you want to install the CloudMonitor agent.

      3. Create the C:\Program Files\Alibaba\cloudmonitor directory.

      4. Upload the agent package to the ECS instance and decompress the agent package to the C:\Program Files\Alibaba\cloudmonitor directory.

      5. Open the Command Prompt.

        Press Win+R. In the Run dialog box, enter cmd and click OK.

      6. Run the following commands to install the CloudMonitor agent:

        cd C:\Program Files\Alibaba\cloudmonitor\bin

        argusagent_service.exe install

      7. Run the following command to start the CloudMonitor agent:

        net start argusagent

      8. View the status of the CloudMonitor agent.

        1. Open the Services window.

          Press Win+R. In the Run dialog box, enter services.msc and click OK.

        2. View the status of the argusagent service.

          If the status of the argusagent service is Running, the CloudMonitor agent is running properly.

      Linux

      1. In the Installation Command section, click the image.png icon next to the command to copy the command.

        image

      2. Log on to the host on which you want to install the CloudMonitor agent as the root user.

      3. Paste and run the command to install the CloudMonitor agent.

      4. Run the following command to view the status of the CloudMonitor agent:

        ps aux | grep argusagent | grep -v grep

        The following output indicates that the CloudMonitor agent is running properly: 

        root      2284  0.0  0.0  22516  1488 ?        Ss   Sep14   0:00 /usr/local/cloudmonitor/bin/argusagent -d
root      2286  0.2  0.3 939652 14300 ?        Sl   Sep14   3:15 /usr/local/cloudmonitor/bin/argusagent

    Use a script to install the CloudMonitor agent on a third-party host

    Note

    If the CloudMonitor agent fails to be automatically installed or upgraded on a third-party host, you must uninstall the agent then use a script to install it. For more information about how to uninstall the CloudMonitor agent, see How do I uninstall the CloudMonitor agent?

    1. Log on to the CloudMonitor console.

    2. In the left-side navigation pane, click Cloud Service Monitoring > Host Monitoring.

    3. On the Host Monitoring page, find the ECS instance and click the image icon in the argusagent Status column. If the ECS instance does not exist, click Host and Plug-in Operations in the upper part of the host list and then select Manual installation from the drop-down list.

    4. In the Manual installation dialog box, set Host Type to Third-party Host, select the operating system of the host, and then follow the installation instruction and command on the page to install the CloudMonitor agent.

      Windows

      1. Download the agent package of the 32-bit version or 64-bit version based on the operating system of the host.

      2. Download the accesskey.properties configuration file.

      3. Use an administrator account to log on to the ECS instance on which you want to install the CloudMonitor agent.

      4. Create the C:\Program Files\Alibaba\cloudmonitor directory.

      5. Upload the agent package to the ECS instance and decompress the agent package to the C:\Program Files\Alibaba\cloudmonitor directory.

      6. Upload the configuration file to the C:\Program Files\Alibaba\cloudmonitor\local_data\conf directory of the host.

      7. Open the command prompt window.

        Press Win+R. In the Run dialog box, enter cmd and click OK.

      8. Run the following commands to install the CloudMonitor agent:

        cd C:\Program Files\Alibaba\cloudmonitor\bin

        argusagent_service.exe install

      9. Run the following command to start the CloudMonitor agent:

        net start argusagent

      10. View the status of the CloudMonitor agent.

        1. Open the Services window.

          Press Win+R. In the Run dialog box, enter services.msc and click OK.

        2. View the status of the argusagent service.

          If the status of the argusagent service is Running, the CloudMonitor agent is running properly.

      Linux

      • If the host is accessible over the Internet, perform the following steps:

        1. In the Installation Command section, click the image.png icon next to the command to copy the command.

          image

        2. Log on to the host on which you want to install the CloudMonitor agent as the root user.

        3. Paste and run the command to install the CloudMonitor agent.

        4. Run the following command to view the status of the CloudMonitor agent:

          ps aux | grep argusagent | grep -v grep

          The following output indicates that the CloudMonitor agent is running properly: 

          root      2284  0.0  0.0  22516  1488 ?        Ss   Sep14   0:00 /usr/local/cloudmonitor/bin/argusagent -d
root      2286  0.2  0.3 939652 14300 ?        Sl   Sep14   3:15 /usr/local/cloudmonitor/bin/argusagent

      • If the host is inaccessible over the Internet, perform the following steps:

        Note

        If the CloudMonitor agent is installed on the host but the host is inaccessible over the Internet, the metric data cannot be reported to CloudMonitor. You must configure a proxy server in the CloudMonitor agent. For more information, see Substep 2 in Step 2: Install and configure the CloudMonitor agent.

        1. Install a proxy server.

          An NGINX proxy server is used in this example. For more information, see Substep 1 to Substep 4 in Step 1: Deploy an NGINX proxy server.

        2. In the Installation Command section, click the image.png icon next to the command to copy the command.

        3. Log on to the host on which you want to install the CloudMonitor agent as the root user.

        4. Paste and run the command to install the CloudMonitor agent.

          Replace the parameters in the following command with the actual values. Keep the default values of other parameters. 

          CMS_HTTP_PROXY=<Address of the proxy server:Port number>

        5. Run the following command to view the status of the CloudMonitor agent:

          ps aux | grep argusagent | grep -v grep

          The following output indicates that the CloudMonitor agent is running properly: 

          root      2284  0.0  0.0  22516  1488 ?        Ss   Sep14   0:00 /usr/local/cloudmonitor/bin/argusagent -d
root      2286  0.2  0.3 939652 14300 ?        Sl   Sep14   3:15 /usr/local/cloudmonitor/bin/argusagent

    Uninstall the CloudMonitor agent

    After you uninstall the CloudMonitor agent for C++ from a host, you cannot monitor the host in real time in the CloudMonitor console. However, you can view the historical metric data.

    Windows

    1. Log on to the host where the CloudMonitor agent resides as the administrator.

    2. Open the command prompt window.

      Press Win+R. In the Run dialog box, enter cmd and click OK.

    3. Run the following command to stop the CloudMonitor agent:

      net stop argusagent

    4. Run the following command to uninstall the CloudMonitor agent:

      "C:\Program Files\Alibaba\cloudmonitor\bin\argusagent_service.exe" uninstall

    5. Run the following commands to delete the cloudmonitor directory:

      cd C:\Program Files\Alibaba

      rd /s /q cloudmonitor

    Linux

    1. Log on to the host where the CloudMonitor agent resides as a root user.

    2. Run the following command to stop the CloudMonitor agent:

      bash /usr/local/cloudmonitor/cloudmonitorCtl.sh stop

    3. Run the following command to uninstall the CloudMonitor agent:

      bash /usr/local/cloudmonitor/cloudmonitorCtl.sh uninstall

    4. Run the following commands to delete the cloudmonitor directory:

      rm -rf /usr/local/cloudmonitor

    References