Merge pull request #284119 from kainawroth/kainawroth-dependency

ShannonLeavitt · web-flow · commit 2f610a7724af · 2024-08-30T09:39:57.000-06:00
Adding info to manual installation of Dependency Agent
diff --git a/articles/azure-monitor/vm/vminsights-dependency-agent-maintenance.md b/articles/azure-monitor/vm/vminsights-dependency-agent-maintenance.md
@@ -1,6 +1,6 @@
 ---
 title: VM Insights Dependency Agent
-description: This article describes how to upgrade the VM insights Dependency agent using command-line, setup wizard, and other methods.
+description: This article describes how to upgrade the VM Insights Dependency Agent using command-line, setup wizard, and other methods.
 ms.topic: conceptual
 ms.custom: linux-related-content
 author: guywi-ms
@@ -13,88 +13,129 @@ ms.date: 09/28/2023
 > [!CAUTION]
 > This article references CentOS, a Linux distribution that is End Of Life (EOL) status. Please consider your use and planning accordingly. For more information, see the [CentOS End Of Life guidance](/azure/virtual-machines/workloads/centos/centos-end-of-life).
 
-The Dependency Agent collects data about processes running on the virtual machine and external process dependencies. Dependency Agent updates include bug fixes or support of new features or functionality. This article describes Dependency Agent requirements and how to upgrade Dependency Agent manually or through automation.
+Dependency Agent collects data about processes running on the virtual machine and external process dependencies. Updates include bug fixes or support of new features or functionality. This article describes Dependency Agent requirements and how to upgrade it manually or through automation.
 
 >[!NOTE]
-> The Dependency Agent sends heartbeat data to the [InsightsMetrics](/azure/azure-monitor/reference/tables/insightsmetrics) table, for which you incur data ingestion charges. This behavior is different from Azure Monitor Agent, which sends agent health data to the [Heartbeat](/azure/azure-monitor/reference/tables/heartbeat) table, which is free from data collection charges.
+> Dependency Agent sends heartbeat data to the [InsightsMetrics](/azure/azure-monitor/reference/tables/insightsmetrics) table, for which you incur data ingestion charges. This behavior is different from Azure Monitor Agent, which sends agent health data to the [Heartbeat](/azure/azure-monitor/reference/tables/heartbeat) table, which is free from data collection charges.
 
 ## Dependency Agent requirements
 
-* The Dependency Agent requires the Azure Monitor Agent to be installed on the same machine.
-* On both the Windows and Linux versions, the Dependency Agent collects data using a user-space service and a kernel driver. 
-    * Dependency Agent supports the same [Windows versions that Azure Monitor Agent supports](../agents/agents-overview.md#supported-operating-systems), except Windows Server 2008 SP2 and Azure Stack HCI.
-    * For Linux, see [Dependency Agent Linux support](#dependency-agent-linux-support).
+> [!div class="checklist"]
+> * Requires the Azure Monitor Agent to be installed on the same machine.
+> * Collects data using a user-space service and a kernel driver on both Windows and Linux.
+> * Supports the same [Windows versions that Azure Monitor Agent supports](../agents/agents-overview.md#supported-operating-systems), except Windows Server 2008 SP2 and Azure Stack HCI. For Linux, see [Dependency Agent Linux support](#dependency-agent-linux-support).
 
 ## Install or upgrade Dependency Agent 
 
-You can upgrade the Dependency agent for Windows and Linux manually or automatically, depending on the deployment scenario and environment the machine is running in, using these methods:
+You can upgrade Dependency Agent for Windows and Linux manually or automatically, depending on the deployment scenario and environment the machine is running in, using these methods:
 
-|Environment |Installation method |Upgrade method |
-|------------|--------------------|---------------|
-|Azure VM | Dependency agent VM extension for [Windows](/azure/virtual-machines/extensions/agent-dependency-windows) and [Linux](/azure/virtual-machines/extensions/agent-dependency-linux) | Agent is automatically upgraded by default unless you configured your Azure Resource Manager template to opt out by setting the property *autoUpgradeMinorVersion* to **false**. The upgrade for minor version where auto upgrade is disabled, and a major version upgrade follow the same method - uninstall and reinstall the extension. |
-| Custom Azure VM images | Manual install of Dependency agent for Windows/Linux | Updating VMs to the newest version of the agent needs to be performed from the command line running the Windows installer package or Linux self-extracting and installable shell script bundle.|
-| Non-Azure VMs | Manual install of Dependency agent for Windows/Linux | Updating VMs to the newest version of the agent needs to be performed from the command line running the Windows installer package or Linux self-extracting and installable shell script bundle. |
+| Environment | Installation method | Upgrade method |
+|-------------|---------------------|----------------|
+| Azure VM | Dependency Agent VM extension for [Windows](/azure/virtual-machines/extensions/agent-dependency-windows) and [Linux](/azure/virtual-machines/extensions/agent-dependency-linux) | Agent is automatically upgraded by default unless you configured your Azure Resource Manager template to opt out by setting the property `autoUpgradeMinorVersion` to **false**. The upgrade for minor version where auto upgrade is disabled, and a major version upgrade follow the same method - uninstall and reinstall the extension. |
+| Custom Azure VM images | Manual install of Dependency Agent for Windows/Linux | Updating VMs to the newest version of the agent needs to be performed from the command line running the Windows installer package or Linux self-extracting and installable shell script bundle. |
+| Non-Azure VMs | Manual install of Dependency Agent for Windows/Linux | Updating VMs to the newest version of the agent needs to be performed from the command line running the Windows installer package or Linux self-extracting and installable shell script bundle. |
+
+> [!NOTE]
+> Dependency Agent is installed automatically when VM Insights is enabled for process and connection data via the [Azure portal](vminsights-enable-portal.md), [PowerShell](vminsights-enable-powershell.md), [ARM template deployment](vminsights-enable-resource-manager.md), or [Azure policy](vminsights-enable-policy.md).
+>
+> If VM Insights is enabled exclusively for performance data, Dependency Agent won't be installed.
 
 ### Manually install or upgrade Dependency Agent on Windows 
 
-Update the agent on a Windows VM from the command prompt, with a script or other automation solution, or by using the InstallDependencyAgent-Windows.exe Setup Wizard.  
+Update the agent on a Windows VM from the command prompt, with a script or other automation solution, or by using the InstallDependencyAgent-Windows.exe Setup Wizard.
+
+#### Prerequisites
 
-[Download the latest version of the Windows agent](https://aka.ms/dependencyagentwindows).
+> [!div class="checklist"]
+> * Download the latest version of the Windows agent from [aka.ms/dependencyagentwindows](https://aka.ms/dependencyagentwindows).
 
 #### Using the Setup Wizard
 
 1. Sign on to the computer with an account that has administrative rights.
 
-2. Execute **InstallDependencyAgent-Windows.exe** to start the Setup Wizard.
+1. Execute **InstallDependencyAgent-Windows.exe** to start the Setup Wizard.
    
-3. Follow the **Dependency Agent Setup** wizard to uninstall the previous version of the dependency agent and then install the latest version.
-
+1. Follow the **Dependency Agent Setup** wizard to uninstall the previous version of Dependency Agent and then install the latest version.
 
 #### From the command line
 
-1. Sign on to the computer with an account that has administrative rights.
+1. Sign in on the computer using an account with administrative rights.
 
-2. Run the following command.
+1. Run the following command:
 
     ```cmd
     InstallDependencyAgent-Windows.exe /S /RebootMode=manual
     ```
 
     The `/RebootMode=manual` parameter prevents the upgrade from automatically rebooting the machine if some processes are using files from the previous version and have a lock on them. 
 
-3. To confirm the upgrade was successful, check the `install.log` for detailed setup information. The log directory is *%Programfiles%\Microsoft Dependency Agent\logs*.
+1. To confirm the upgrade was successful, check the `install.log` for detailed setup information. The log directory is *%Programfiles%\Microsoft Dependency Agent\logs*.
 
-### Manually install or upgrade Dependency Agent on Linux 
+### Manually install or upgrade Dependency Agent on Linux
 
-Upgrade from prior versions of the Dependency Agent on Linux is supported and performed following the same command as a new installation.
+Upgrading from prior versions of Dependency Agent on Linux is supported and performed following the same command as a new installation.
 
-You can download the latest version of the Linux agent from [here](https://aka.ms/dependencyagentlinux).
+#### Prerequisites
 
-1. Sign on to the computer with an account that has administrative rights.
+> [!div class="checklist"]
+> * Download the latest version of the Linux agent from [aka.ms/dependencyagentlinux](https://aka.ms/dependencyagentlinux) or via curl:
+
+```bash
+curl -L -o DependencyAgent-Linux64.bin https://aka.ms/dependencyagentlinux
+```
+
+> [!NOTE]
+> Curl doesn't automatically set execution permissions. You need to manually set them using chmod:
+> 
+> ```bash
+> chmod +x DependencyAgent-Linux64.bin
+> ```
+
+#### From the command line
+
+1. Sign in on the computer with a user account that has sudo privileges to execute commands as root.
 
-2. Run the following command as root.
+1. Run the following command:
 
     ```bash
-    ./InstallDependencyAgent-Linux64.bin -s
+    sudo <path>/InstallDependencyAgent-Linux64.bin
     ```
 
-If the Dependency agent fails to start, check the logs for detailed error information. On Linux agents, the log directory is */var/opt/microsoft/dependency-agent/log*. 
+If Dependency Agent fails to start, check the logs for detailed error information. On Linux agents, the log directory is */var/opt/microsoft/dependency-agent/log*. 
 
-## Uninstall Dependency Agent 
+## Uninstall Dependency Agent
 
-To uninstall Dependency Agent:
+> [!NOTE]
+> If Dependency Agent was installed manually, it won’t show in the Azure portal and has to be uninstalled manually. It will only show if it was installed via the [Azure portal](vminsights-enable-portal.md), [PowerShell](vminsights-enable-powershell.md), [ARM template deployment](vminsights-enable-resource-manager.md), or [Azure policy](vminsights-enable-policy.md).
 
 1. From the **Virtual Machines** menu in the Azure portal, select your virtual machine.
+
 1. Select **Extensions + applications** > **DependencyAgentWindows** or **DependencyAgentLinux** > **Uninstall**.
 
     :::image type="content" source="media/vminsights-dependency-agent-maintenance/azure-monitor-uninstall-dependency-agent.png" alt-text="Screenshot showing the Extensions and applications screen for a virtual machine." lightbox="media/vminsights-dependency-agent-maintenance/azure-monitor-uninstall-dependency-agent.png":::
 
+### Manually uninstall Dependency Agent on Windows
+
+**Method 1:** In Windows, go to **Add and remove programs**, find Microsoft Dependency Agent, click on the ellipsis to open the context menu, and select **Uninstall**.
+
+**Method 2:** Use the uninstaller located in the Microsoft Dependency Agent folder, for example, `C:\Program Files\Microsoft Dependency Agent"\Uninstall_v.w.x.y.exe` (where v.w.x.y is the version number).
+
+### Manually uninstall Dependency Agent on Linux
+
+1. Sign in on the computer with a user account that has sudo privileges to execute commands as root.
+
+1. Run the following command:
+
+    ```bash
+    sudo /opt/microsoft/dependency-agent/uninstall -s
+    ```
+
 ## Dependency Agent Linux support
 
-Since the Dependency agent works at the kernel level, support is also dependent on the kernel version. As of Dependency agent version 9.10.* the agent supports * kernels.  The following table lists the major and minor Linux OS release and supported kernel versions for the Dependency agent.
+Since Dependency Agent works at the kernel level, support is also dependent on the kernel version. As of Dependency Agent version 9.10.* the agent supports * kernels. The following table lists the major and minor Linux OS release and supported kernel versions for Dependency Agent.
 
 [!INCLUDE [dependency-agent-linux-versions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/vm-insights-dependency-agent-linux-versions.md)]
 
 ## Next steps
 
-If you want to stop monitoring your VMs for a while or remove VM insights entirely, see [Disable monitoring of your VMs in VM insights](../vm/vminsights-optout.md).
+If you want to stop monitoring your VMs for a while or remove VM Insights entirely, see [Disable monitoring of your VMs in VM Insights](../vm/vminsights-optout.md).
