Skip to content

Commit 0683b27

Browse files
authored
Merge pull request #263664 from neilghuman/update-troubleshooter-ama
Update AMA troubleshooters
2 parents 9829c68 + da2dfa2 commit 0683b27

File tree

2 files changed

+61
-17
lines changed

2 files changed

+61
-17
lines changed

articles/azure-monitor/agents/troubleshooter-ama-linux.md

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,62 @@
11
---
2-
title: Use Azure Monitor Agent Troubleshooter for Linux
2+
title: How to use the Linux Operating System (OS) Azure Monitor Agent Troubleshooter
33
description: Detailed instructions on using the Linux agent troubleshooter tool to diagnose potential issues.
44
ms.topic: conceptual
55
author: RepinStyle
6-
ms.author: bhumphrey
6+
ms.author: guywild
77
ms.date: 12/14/2023
88
ms.custom: references_regions
99
ms.reviewer: jeffwo
1010

1111
# customer-intent: When AMA is experiencing issues, I want to investigate the issues and determine if I can resolve the issue on my own.
1212
---
1313

14-
# Use the Azure Monitor Agent Troubleshooter for Linux
14+
# How to use the Linux operating system (OS) Azure Monitor Agent Troubleshooter
1515
The Azure Monitor Agent Troubleshooter (AMA) is designed to help identify issues with the agent and perform general health assessments. It can perform various checks to ensure that the agent is properly installed and connected, and can also gather AMA-related logs from the machine being diagnosed.
1616

1717
> [!Note]
1818
> The AMA Troubleshooter is an executable that is shipped with the agent for all versions newer than **1.25.1** for Linux.
1919
2020
## Prerequisites
21-
The linux Troubleshooter requires Python 2.6+ or any Python 3 installed on the machine. In addition, the following Python packages are required to run (all should be present on a default install of Python 2 or Python 3):
21+
22+
### Python requirement
23+
The Linux AMA Troubleshooter requires **Python 2.6+** or any **Python 3** version installed on the machine.
24+
25+
To check if python is installed on your machine, copy the following command and run in Bash as root:
26+
```Bash
27+
sudo python -V
28+
sudo python3 -V
29+
```
30+
31+
:::image type="content" source="media/agent-linux/python-version-check.png" alt-text="Screenshot of commands to check Python version in Linux." lightbox="media/agent-linux/python-version-check.png":::
32+
33+
Multiple versions of Python can be installed and aliased – if multiple versions are installed, use:
34+
35+
```Bash
36+
ls -ls /usr/bing/python*
37+
```
38+
39+
:::image type="content" source="media/agent-linux/python-multiple-version-check.png" alt-text="Screenshot of command to check multiple versions of Python for Linux." lightbox="media/agent-linux/python-multiple-version-check.png":::
40+
41+
If your virtual machine is using a distro that doesn't include Python 3 by default, then you must install it. The following sample commands install Python 3 on different distros:
42+
43+
# [Red Hat, CentOS, Oracle](#tab/redhat)
44+
```Bash
45+
sudo yum install -y python3
46+
```
47+
# [Ubuntu, Debian](#tab/ubuntu)
48+
```Bash
49+
sudo apt-get update
50+
sudo apt-get install -y python3
51+
```
52+
# [Suse](#tab/suse)
53+
```Bash
54+
sudo zypper install -y python3
55+
```
56+
57+
---
58+
59+
In addition, the following Python packages are required to run (all should be present on a default install of Python 2 or Python 3):
2260

2361
|Python Package|Required for Python 2?|Required for Python 3?|
2462
|:---|:---|:---|
@@ -34,23 +72,27 @@ The linux Troubleshooter requires Python 2.6+ or any Python 3 installed on the m
3472
|url lib|yes|no|
3573
|xml.dom.minidom|yes|yes|
3674

37-
On the machine to be diagnosed, does this directory exist:
75+
### Troubleshooter existence check
76+
Check for the existence of the AMA Agent Troubleshooter directory on the machine to be diagnosed to confirm the installation of the agent troubleshooter:
77+
3878
***/var/lib/waagent/Microsoft.Azure.Monitor.AzureMonitorLinuxAgent-{version}***
3979

40-
To verify the Agent Troubleshooter is present, copy the following command and run in Bash as root:
80+
To verify the Azure Monitor Agent Troubleshooter is presence, copy the following command and run in Bash as root:
4181

4282
```Bash
4383
ls -ltr /var/lib/waagent | grep "Microsoft.Azure.Monitor.AzureMonitorLinuxAgent-*"
4484
```
4585

4686
:::image type="content" source="./media/use-azure-monitor-agent-troubleshooter/ama-nix-prerequisites-shell.png" alt-text="Screenshot of the Bash window, which shows the result of ls command for the AMA installation directory." lightbox="media/use-azure-monitor-agent-troubleshooter/ama-nix-prerequisites-shell.png":::
4787

48-
If not, the directory doesn't exist and the installation failed. In this case, follow [Basic troubleshooting steps](azure-monitor-agent-troubleshoot-linux-vm.md#basic-troubleshooting-steps) instead.
88+
If directory doesn't exist or the installation is failed, follow [Basic troubleshooting steps](azure-monitor-agent-troubleshoot-linux-vm.md#basic-troubleshooting-steps).
4989

50-
Yes, the directory exists. Proceed to [Run the Troubleshooter](#run-the-troubleshooter).
90+
If the directory exists, proceed to [Run the Troubleshooter](#run-the-troubleshooter).
5191

5292
## Run the Troubleshooter
53-
On the machine to be diagnosed, run the Agent Troubleshooter.
93+
On the machine to be diagnosed, run the Agent Troubleshooter.
94+
95+
**Log Mode** enables the collection of logs, which can then be compressed into .tgz format for export or review. **Interactive Mode** allows users to actively engage in troubleshooting scenarios and view the output directly within the shell.
5496

5597
# [Log Mode](#tab/GenerateLogs)
5698

@@ -87,7 +129,7 @@ It runs a series of scenarios and displays the results.
87129
> [!Note]
88130
> The interactive mode will **not** generate log files, but will **only** output results to the screen. Switch to log mode, if you need to generate log files.
89131
90-
:::image type="content" source="media/use-azure-monitor-agent-troubleshooter/ama-nix-run-the-troubleshooter-option-l-shell.png" alt-text="Screenshot of the Bash window, which shows the result of the AgentTroubleshooter running with the -A option to output Troubleshooter results to the screen." lightbox="media/use-azure-monitor-agent-troubleshooter/ama-nix-run-the-troubleshooter-option-l-shell.png":::
132+
:::image type="content" source="media/agent-linux/ama-troubleshooter-interactive-mode.png" alt-text="Screenshot of the Bash window, which shows the result of the AgentTroubleshooter running with the -A option to output Troubleshooter results to the screen." lightbox="media/agent-linux/ama-troubleshooter-interactive-mode.png":::
91133

92134
---
93135

@@ -98,4 +140,4 @@ It isn't possible to use the Troubleshooter to diagnose an older version of the
98140

99141
## Next Steps
100142
- [Troubleshooting guidance for the Azure Monitor agent](../agents/azure-monitor-agent-troubleshoot-linux-vm.md) on Linux virtual machines and scale sets
101-
- [Syslog troubleshooting guide for Azure Monitor Agent](../agents/azure-monitor-agent-troubleshoot-linux-vm-rsyslog.md) for Linux
143+
- [Syslog troubleshooting guide for Azure Monitor Agent](../agents/azure-monitor-agent-troubleshoot-linux-vm-rsyslog.md) for Linux

articles/azure-monitor/agents/troubleshooter-ama-windows.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Use Azure Monitor Agent Troubleshooter for Windows
2+
title: How to use the Windows operating system (OS) Azure Monitor Agent Troubleshooter
33
description: Detailed instructions on using the Windows agent troubleshooter tool to diagnose potential issues.
44
ms.topic: conceptual
55
author: RepinStyle
@@ -11,14 +11,16 @@ ms.reviewer: jeffwo
1111
# customer-intent: When AMA is experiencing issues, I want to investigate the issues and determine if I can resolve the issue on my own.
1212
---
1313

14-
# Use the Azure Monitor Agent Troubleshooter for Windows
14+
# How to use the Windows operating system (OS) Azure Monitor Agent Troubleshooter
1515
The Azure Monitor Agent (AMA) Troubleshooter is designed to help identify issues with the agent and perform general health assessments. It can perform various checks to ensure that the agent is properly installed and connected, and can also gather AMA-related logs from the machine being diagnosed.
1616

1717
> [!Note]
18-
> The AMA Troubleshooter is a command line executable that is shipped with the agent for all versions newer than **1.12.0.0** for Windows.
18+
> The Windows AMA Troubleshooter is a command line executable that is shipped with the agent for all versions newer than **1.12.0.0**.
1919
2020
## Prerequisites
21-
On the machine to be diagnosed, does this directory exist:
21+
### Troubleshooter existence check
22+
Check for the existence of the AMA Agent Troubleshooter directory on the machine to be diagnosed to confirm the installation of the agent troubleshooter:
23+
2224
***C:/Packages/Plugins/Microsoft.Azure.Monitor.AzureMonitorWindowsAgent***
2325

2426
# [PowerShell](#tab/WindowsPowerShell)
@@ -43,7 +45,7 @@ If the directory exists, the cd command changes directories successfully.
4345

4446
---
4547

46-
If not, the directory doesn't exist and the installation failed. In this case, follow [Basic troubleshooting steps](../agents/azure-monitor-agent-troubleshoot-windows-vm.md#basic-troubleshooting-steps-installation-agent-not-running-configuration-issues) instead.
48+
If directory doesn't exist or the installation is failed, follow [Basic troubleshooting steps](../agents/azure-monitor-agent-troubleshoot-windows-vm.md#basic-troubleshooting-steps-installation-agent-not-running-configuration-issues).
4749

4850
Yes, the directory exists. Proceed to [Run the Troubleshooter](#run-the-troubleshooter).
4951

@@ -96,4 +98,4 @@ It isn't possible to use the Troubleshooter to diagnose an older version of the
9698

9799
## Next Steps
98100
- [Troubleshooting guidance for the Azure Monitor agent](../agents/azure-monitor-agent-troubleshoot-windows-vm.md) on Windows virtual machines and scale sets
99-
- [Troubleshooting guidance for the Azure Monitor agent](../agents/azure-monitor-agent-troubleshoot-windows-arc.md) on Windows Arc-enabled server
101+
- [Troubleshooting guidance for the Azure Monitor agent](../agents/azure-monitor-agent-troubleshoot-windows-arc.md) on Windows Arc-enabled server

0 commit comments

Comments
 (0)