Skip to content

Commit 1773f3a

Browse files
authored
Revise run-analyzer-linux.md for clarity and accuracy
Updated author and date information, improved clarity in instructions, and corrected minor grammatical errors throughout the document.
1 parent 10607f6 commit 1773f3a

File tree

1 file changed

+39
-33
lines changed

1 file changed

+39
-33
lines changed

defender-endpoint/run-analyzer-linux.md

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Run the client analyzer on Linux
33
description: Run the Defender for Endpoint client analyzer on Linux
4-
author: batamig
5-
ms.author: bagol
4+
author: paulinbar
5+
ms.author: painbar
66
manager: bagol
77
ms.reviewer: yongrhee
88
ms.service: defender-endpoint
99
ms.subservice: linux
1010
ms.localizationpriority: medium
1111
ms.topic: troubleshooting-general
12-
ms.date: 05/24/2025
12+
ms.date: 09/23/2025
1313
ms.custom: partner-contribution
1414
ms.collection:
1515
- m365-security
@@ -38,35 +38,36 @@ This article explains how to use the tool on your device or with live response.
3838
3939
## Run the binary version of the client analyzer
4040
The binary version of client analyzer is made available in two ways:
41-
1. Shipped with Microsoft Defender for Linux
42-
2. Shipped as a standalone tool
41+
- Shipped with Microsoft Defender for Linux
42+
- Shipped as a standalone tool
4343

44-
### Run Client Analyzer binary shipped with Microsoft Defender for Linux:
44+
### Run the Client Analyzer binary shipped with Microsoft Defender for Linux:
4545
> [!NOTE]
46-
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with agent. It can be found at the location `/opt/microsoft/mdatp/tools/client_analyzer/binary`
46+
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with an agent. It can be found at the following location: `/opt/microsoft/mdatp/tools/client_analyzer/binary`
4747
48-
To run this client analyzer follow the steps:
49-
1. Go to directory `/opt/microsoft/mdatp/tools/client_analyzer/binary`:
48+
To run this client analyzer follow these steps:
49+
50+
1. Go to the directory `/opt/microsoft/mdatp/tools/client_analyzer/binary`:
5051

5152
```bash
5253
cd /opt/microsoft/mdatp/tools/client_analyzer/binary
5354
```
54-
2. Run the tool as _root_ to generate diagnostic package:
55+
2. Run the tool as _root_ to generate a diagnostic package:
5556

5657
```bash
5758
sudo ./MDESupportTool -d
5859
```
59-
### Download and run Client Analyzer standalone binary tool
60+
### Download and run the Client Analyzer standalone binary tool
6061

61-
Follow the below steps to use the standalone ClientAnalyzer binary
62+
Follow the steps below to use the standalone ClientAnalyzer binary
6263

63-
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine that you're to investigate. If you're using a terminal, download the tool by entering the following command:
64+
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine that you need to investigate. If you're using a terminal, download the tool by entering the following command:
6465
6566
```bash
6667
wget --quiet -O XMDEClientAnalyzerBinary.zip "https://go.microsoft.com/fwlink/?linkid=2336125"
6768
```
6869
69-
2. Verify the download.
70+
2. Verify the download:
7071
7172
```bash
7273
echo '042692269A7208AB30B4355A6FC1CD0A25FE59356D96CCD2E7F1F61DF9B4B85D XMDEClientAnalyzerBinary.zip' | sha256sum -c
@@ -89,12 +90,12 @@ Follow the below steps to use the standalone ClientAnalyzer binary
8990
- **SupportToolLinuxamd64Binary.zip**: For x86 Linux devices
9091
- **SupportToolLinuxarm64Binary.zip**: For ARM Linux devices
9192
92-
6. Unzip the sepecific zip based on your Linux OS architecture. For example, we will be using `SupportToolLinuxamd64Binary.zip` file.
93+
6. Unzip the sepecific zip based on your Linux OS architecture. For example, we use here the `SupportToolLinuxamd64Binary.zip` file.
9394
9495
```bash
9596
unzip -q SupportToolLinuxamd64Binary.zip
9697
```
97-
7. Run the tool as _root_ to generate diagnostic package:
98+
7. Run the tool as _root_ to generate a diagnostic package:
9899
99100
```bash
100101
sudo ./MDESupportTool -d
@@ -103,8 +104,9 @@ Follow the below steps to use the standalone ClientAnalyzer binary
103104
## Run the Python-based client analyzer
104105
105106
The python version of client analyzer is made available in two ways:
106-
1. Shipped with Microsoft Defender for Linux
107-
2. Shipped as a standalone tool
107+
108+
- Shipped with Microsoft Defender for Linux
109+
- Shipped as a standalone tool
108110
109111
> [!NOTE]
110112
> - The analyzer depends on a few extra PIP packages (`decorator`, `sh`, `distro`, `lxml`, and `psutil`) which are installed in the operating system when in root to produce the result output. If not installed, the analyzer attempts to fetch it from the [official repository for Python packages](https://pypi.org/search/?q=lxml).
@@ -115,10 +117,12 @@ The python version of client analyzer is made available in two ways:
115117
> Running the Python-based client analyzer requires the installation of PIP packages which could cause some issues in your environment. To avoid issues from occurring, we recommend that you install the packages into a user PIP environment.
116118
117119
### Run Client Analyzer python version shipped with Microsoft Defender for Linux
120+
118121
> [!NOTE]
119-
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with agent. It can be found at the location `/opt/microsoft/mdatp/tools/client_analyzer/python`
122+
> Starting with the Defender for Endpoint version `101.25082.0000`, the Client Analyzer is shipped with an agent. It can be found at the following location: `/opt/microsoft/mdatp/tools/client_analyzer/python`
123+
124+
To run this client analyzer follow these steps:
120125
121-
To run this client analyzer follow the steps:
122126
1. Go to directory `/opt/microsoft/mdatp/tools/client_analyzer/python`:
123127
124128
```bash
@@ -135,45 +139,45 @@ To run this client analyzer follow the steps:
135139
sudo ./mde_support_tool.sh -d
136140
```
137141
138-
### Download and run Client Analyzer standalone python version
142+
### Download and run the Client Analyzer standalone python version
139143
140144
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool on the Linux machine you need to investigate. If you're using a terminal, download the tool by entering the following command:
141145

142146
```bash
143147
wget --quiet -O XMDEClientAnalyzerPython.zip "https://go.microsoft.com/fwlink/?linkid=2336046"
144148
```
145149

146-
2. Verify the download.
150+
2. Verify the download:
147151

148152
```bash
149153
echo '9F29043CD3034DD4DF30B0EA25B37B5EE7BE5D81D5848CF047F9842B76C831EA XMDEClientAnalyzerPython.zip' | sha256sum -c
150154
```
151155

152-
3. Extract the contents of `XMDEClientAnalyzer.zip` on the machine.
156+
3. Extract the contents of `XMDEClientAnalyzer.zip` on the machine:
153157

154158
```bash
155159
unzip -q XMDEClientAnalyzerPython.zip -d XMDEClientAnalyzerPython
156160
```
157161

158-
4. Change the directory.
162+
4. Change the directory:
159163

160164
```bash
161165
cd XMDEClientAnalyzerPython
162166
```
163167

164-
5. Give the tool executable permission.
168+
5. Give the tool executable permission:
165169

166170
```bash
167171
chmod a+x mde_support_tool.sh
168172
```
169173

170-
6. Run as a nonroot user to install required dependencies.
174+
6. Run as a nonroot user to install required dependencies:
171175

172176
```bash
173177
./mde_support_tool.sh
174178
```
175179

176-
7. To collect the diagnostic package and generate the result archive file, run again as root.
180+
7. To collect the diagnostic package and generate the result archive file, run again as root:
177181

178182
```bash
179183
sudo ./mde_support_tool.sh -d
@@ -183,7 +187,8 @@ To run this client analyzer follow the steps:
183187
> Watch this video to learn more about onboarding issues: [Defender for Endpoint client analyzer onboarding issues](https://www.youtube.com/watch?v=HdhePgMBqs8)
184188

185189
## Command line options
186-
Below are the command line options provided by client analyzer
190+
191+
Below are the command line options provided by client analyzer:
187192

188193
```console
189194
@@ -246,8 +251,7 @@ optional arguments:
246251
247252
### Diagnostics mode
248253
249-
Diagnostics mode is used to collect extensive set of machine information, such as memory, disk, and MDATP logs.
250-
This set of files gives the primary set of information required to debug any issue related to Defender For Endpoint.
254+
Diagnostics mode is used to collect extensive set of machine information, such as memory, disk, and MDATP logs. This set of files gives the primary set of information required to debug any issue related to Defender For Endpoint.
251255
252256
The options supported are as follows:
253257
@@ -348,6 +352,7 @@ The files generated when using this mode are summarized in the following table:
348352
| `top_summary.txt` | Memory and CPU usage analytics of the process running |
349353
350354
### Optional arguments for Client Analyzer
355+
351356
Client Analyzer provides the following optional arguments for extra data collection:
352357
353358
#### Collect performance info
@@ -462,7 +467,8 @@ This mode adds exclusions for `audit-d` monitoring.
462467
463468
```
464469
465-
Usage example:
470+
Usage example:
471+
466472
```console
467473
sudo ./MDESupportTool exclude -d /var/foo/bar`
468474
```
@@ -479,6 +485,7 @@ This option sets the rate limit globally for AuditD causing a drop in all the au
479485
```
480486
481487
Usage example:
488+
482489
```console
483490
sudo ./mde_support_tool.sh ratelimit -e true
484491
```
@@ -498,6 +505,7 @@ This option enables you to skip the faulty rules added in the auditd rules file
498505
```
499506
500507
Usage example:
508+
501509
```console
502510
sudo ./mde_support_tool.sh skipfaultyrules -e true
503511
```
@@ -682,8 +690,6 @@ The Python version of the client analyzer accepts command line parameters to per
682690
683691
- [Address false positives/negatives in Microsoft Defender for Endpoint](/defender-endpoint/defender-endpoint-false-positives-negatives)
684692
685-
686-
687693
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../includes/defender-mde-techcommunity.md)]
688694
689695

0 commit comments

Comments
 (0)