Skip to content

Commit 7530499

Browse files
committed
Update run-analyzer-linux.md
1 parent 35a4127 commit 7530499

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

defender-endpoint/run-analyzer-linux.md

Lines changed: 30 additions & 30 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: denisebmsft
5-
ms.author: deniseb
4+
author: emmwalshh
5+
ms.author: ewalsh
66
manager: deniseb
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: 01/08/2024
12+
ms.date: 02/24/2025
1313
ms.custom: partner-contribution
1414
ms.collection:
1515
- m365-security
@@ -28,46 +28,46 @@ f1.keywords: NOCSH
2828

2929
> Want to experience Defender for Endpoint? [Sign up for a free trial.](https://go.microsoft.com/fwlink/p/?linkid=2225630)
3030
31-
If you're experiencing reliability or device health issues with Defender for Endpoint on Linux, and you contact support, you might be asked to provide the output package of the Microsoft Defender for Endpoint Client Analyzer tool. This article describes how to use the client analyzer tool locally on the device or together with live response. In either case, you can use a Python-based solution or a binary version that has no external Python dependency.
31+
If you have issues with Microsoft Defender for Endpoint on Linux and need support, you might be asked to provide the output from the Client Analyzer tool. This article explains how to use the tool on your device or with live response. You can use either a Python-based solution or a binary version that doesn't need Python.
3232

3333

3434
## Running the binary version of the client analyzer
3535

36-
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to Linux machine you need to investigate. If you're using a terminal, download the tool by entering the following command:
36+
1. Download the [XMDE Client Analyzer Binary](https://aka.ms/XMDEClientAnalyzerBinary) tool to the Linux machine that you're to investigating. If you're using a terminal, download the tool by entering the following command:
3737

3838
```bash
3939
wget --quiet -O XMDEClientAnalyzerBinary.zip https://aka.ms/XMDEClientAnalyzerBinary
4040
```
4141

42-
1. Verify the download.
42+
2. Verify the download.
4343

4444
```bash
4545
echo '4E96E75B16244BB25BDBF34CBB3EB596BC2E9CE368BC4E532E8AE12DF2A1E19D XMDEClientAnalyzerBinary.zip' | sha256sum -c
4646
```
4747

48-
2. Extract the contents of `XMDEClientAnalyzerBinary.zip` on the machine.
48+
3. Extract the contents of `XMDEClientAnalyzerBinary.zip` on the machine.
4949

5050
```bash
5151
unzip -q XMDEClientAnalyzerBinary.zip -d XMDEClientAnalyzerBinary
5252
```
5353

54-
3. Change the directory:
54+
4. Change the directory:
5555

5656
```bash
5757
cd XMDEClientAnalyzerBinary
5858
```
5959

60-
4. Two new zip files are produced:
60+
5. Two new zip files are produced:
6161

6262
- **SupportToolLinuxBinary.zip** : For all Linux devices
6363
- **SupportToolMacOSBinary.zip** : For Mac devices
6464

65-
5. Unzip `SupportToolLinuxBinary.zip` file.
65+
6. Unzip `SupportToolLinuxBinary.zip` file.
6666

6767
```bash
6868
unzip -q SupportToolLinuxBinary.zip
6969
```
70-
6. Run the tool as _root_ to generate diagnostic package:
70+
7. Run the tool as _root_ to generate diagnostic package:
7171

7272
```bash
7373
sudo ./MDESupportTool -d
@@ -76,14 +76,14 @@ If you're experiencing reliability or device health issues with Defender for End
7676
## Running the Python-based client analyzer
7777

7878
> [!NOTE]
79-
> - The analyzer depends on 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).
79+
> - 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).
8080
> - In addition, the tool currently requires Python version 3 or later to be installed on your device.
8181
> - If your device is behind a proxy, then you can pass the proxy server as an environment variable to the `mde_support_tool.sh` script. For example: `https_proxy=https://myproxy.contoso.com:8080 ./mde_support_tool.sh"`.
8282
8383
> [!WARNING]
84-
> 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, it's recommended that you install the packages into a user PIP environment.
84+
> 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.
8585
86-
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool on Linux machine you need to investigate. If you're using a terminal, download the tool by entering the following command:
86+
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:
8787
8888
```bash
8989
wget --quiet -O XMDEClientAnalyzer.zip https://aka.ms/XMDEClientAnalyzer
@@ -119,7 +119,7 @@ If you're experiencing reliability or device health issues with Defender for End
119119
./mde_support_tool.sh
120120
```
121121
122-
7. To collect diagnostic package and generate the result archive file, run again as root.
122+
7. To collect the diagnostic package and generate the result archive file, run again as root.
123123
124124
```bash
125125
sudo ./mde_support_tool.sh -d
@@ -147,7 +147,7 @@ positional arguments:
147147
analysis of a performance scenario that can be
148148
reproduced on demand
149149
installation Collect different installation/onboarding reports
150-
exclude Exclude specific process(es) from audit-d monitoring.
150+
exclude Exclude specific processes from audit-d monitoring.
151151
ratelimit Set the rate limit for auditd events. Rate limit will
152152
update the limits for auditd events for all the
153153
applications using auditd, which could impact
@@ -190,7 +190,7 @@ optional arguments:
190190
### Diagnostics mode
191191
192192
Diagnostics mode is used to collect extensive set of machine information, such as memory, disk, MDATP logs, etc.
193-
This set of files give us primary set of information required to debug any issue related to Defender For Endpoint.
193+
This set of files gives the primary set of information required to debug any issue related to Defender For Endpoint.
194194
195195
The options supported are as follows:
196196
@@ -225,7 +225,7 @@ optional arguments:
225225
Usage example: `sudo ./MDESupportTool -d`
226226
227227
> [!NOTE]
228-
> The log level autoreset feature is available only on agent version 101.24052.0002 or above.
228+
> The log level autoreset feature is available only in agent version 101.24052.0002 or above.
229229
230230
The files generated when using this mode are summarized in the following table:
231231
@@ -245,7 +245,7 @@ The files generated when using this mode are summarized in the following table:
245245
| `ebpf_enabled_func.txt` | List of all the kernel functions that are currently enabled for tracing |
246246
| `ebpf_syscalls.zip` | Information about system call tracing |
247247
| `ebpf_raw_syscalls.zip` | Tracing events related to raw system calls |
248-
| `ebpf_maps_info.txt` | eBPF maps' id and size info |
248+
| `ebpf_maps_info.txt` | eBPF maps' ID and size info |
249249
| `syslog.zip` | The files under /var/log/syslog |
250250
| `messages.zip` | The files under /var/log/messages |
251251
| `conflicting_processes_information.txt` | Defender for Endpoint Conflicting Processes |
@@ -274,7 +274,7 @@ The files generated when using this mode are summarized in the following table:
274274
| `uptime_info.txt` | Time since last restart |
275275
| `last_info.txt` | Listing of last logged in users |
276276
| `locale_info.txt` | Show current locale |
277-
| `tmp_files_owned_by_mdatp.txt` | /tmp files owned by group:mdatp <br/>(Present only when Defender for Endpoint is installed) |
277+
| `tmp_files_owned_by_mdatp.txt` | /tmp files owned by group: mdatp <br/>(Present only when Defender for Endpoint is installed) |
278278
| `mdatp_config.txt` | All the Defender for Endpoint configurations <br/>(Present only when Defender for Endpoint is installed) |
279279
| `mpenginedb.db`<br/>`mpenginedb.db-wal`<br/> `mpenginedb.db-shm` | Antivirus definitions file <br/>(Present only when Defender for Endpoint is installed) |
280280
| `iptables_rules.txt` | Linux iptables rules |
@@ -290,7 +290,7 @@ The files generated when using this mode are summarized in the following table:
290290
| `top_output.txt `| Process running in the machine when the tool was run |
291291
| `top_summary.txt` | Memory and CPU usage analytics of the process running |
292292
293-
### Optional argumets for Client Analyzer
293+
### Optional arguments for Client Analyzer
294294
Client Analyzer provides the following optional arguments for extra data collection:
295295
296296
#### Collect performance info
@@ -339,12 +339,12 @@ Usage example:
339339
```console
340340
sudo ./MDESupportTool connectivitytest -o ~/MicrosoftDefenderATPOnboardingLinuxServer.py`
341341
```
342-
The output printed on the screen will show if the URLs are reachable or not.
342+
The output printed on the screen shows if the URLs are reachable or not.
343343
344344
345345
#### Collect different installation/onboarding reports
346346
347-
This mode collects installation related info like distro info, system requirements, etc.
347+
This mode collects installation related information like distro, system requirements, etc.
348348
349349
```console
350350
@@ -399,7 +399,7 @@ sudo ./MDESupportTool exclude -d /var/foo/bar`
399399
400400
### AuditD rate limiter
401401
402-
This option sets the rate limit globally for AuditD causing a drop in all the audit events. When the limiter is enabled the number of auditd events are limited to 2500 events/sec. This option can be used in cases where we see high CPU usage from AuditD side.
402+
This option sets the rate limit globally for AuditD causing a drop in all the audit events. When the limiter is enabled, the auditd events are limited to 2500 events/sec. This option can be used in cases where we see high CPU usage from AuditD side.
403403
404404
```console
405405
@@ -414,7 +414,7 @@ sudo ./mde_support_tool.sh ratelimit -e true
414414
```
415415
416416
> [!NOTE]
417-
> This functionality should be carefully used as it limits the number of events being reported by the auditd subsystem as a whole. This could reduce the number of events for other subscribers as well.
417+
> This functionality should be carefully used as it limits the number of events the auditd subsystem reports as a whole. This could reduce the number of events for other subscribers as well.
418418
419419
### AuditD skip faulty rules
420420
@@ -433,7 +433,7 @@ sudo ./mde_support_tool.sh skipfaultyrules -e true
433433
```
434434
435435
> [!NOTE]
436-
> This functionality skips faulty rules. Faulty rules must be further identified and fixed.
436+
> This functionality skips the faulty rules. Faulty rules must be further identified and fixed.
437437
438438
439439
## Use live response in Defender for Endpoint to collect support logs
@@ -444,7 +444,7 @@ The XMDE Client Analyzer tool can be downloaded as a [binary](https://aka.ms/XMD
444444
- For execution, the `acl` package is required.
445445
446446
> [!IMPORTANT]
447-
> Window uses the Carriage Return and Line Feed invisible characters to represent the end of one line and beginning of a new line in a file, but Linux systems uses only the Line Feed invisible character at the end of its file lines. When using the following scripts, if done on Windows, this difference can result in errors and failures of the scripts to run. A potential solution to this is to utilize the Windows Subsystem for Linux and the `dos2unix` package to reformat the script so it aligns with the Unix and Linux format standard.
447+
> Window uses the Carriage Return and Line Feed invisible characters to represent the end of one line and beginning of a new line in a file, but Linux systems uses only the Line Feed invisible character at the end of its file lines. When you use the following scripts, if done on Windows, this difference can result in errors and failures of the scripts to run. A potential solution to this is to utilize the Windows Subsystem for Linux and the `dos2unix` package to reformat the script so it aligns with the Unix and Linux format standard.
448448
449449
### Install the XMDE Client Analyzer
450450
@@ -456,7 +456,7 @@ Download and extract the XMDE Client Analyzer. You can use either the binary or
456456
Due to the limited commands available in live response, the steps detailed must be executed in a bash script. By splitting the installation and execution portion of these commands, it's possible to run the install script once, and run the execution script multiple times.
457457
458458
> [!IMPORTANT]
459-
> The example scripts assume the machine has direct internet access and can retrieve the XMDE Client Analyzer from Microsoft. If the machine does not have direct internet access, then the installation scripts must be updated to fetch the XMDE Client Analyzer from a location the machines can access successfully.
459+
> The example scripts assume the machine has direct internet access and can retrieve the XMDE Client Analyzer from Microsoft. If the machine doesn't have direct internet access, then the installation scripts must be updated to fetch the XMDE Client Analyzer from a location the machines can access successfully.
460460
461461
#### Binary client analyzer install script
462462
@@ -533,7 +533,7 @@ The following script performs the first six steps of the [Running the Python ver
533533
Live response doesn't support running the XMDE Client Analyzer or Python directly, so an execution script is necessary.
534534
535535
> [!IMPORTANT]
536-
> The following scripts assume the XMDE Client Analyzer was installed using the same locations from the scripts mentioned earlier. If your organization has chosen to install the scripts into a different location, then the scripts must be updated to align with your organization's chosen installation location.
536+
> The following scripts assume the XMDE Client Analyzer was installed using the same locations from the scripts mentioned earlier. If your organization chooses to install the scripts into a different location, then the scripts must be updated to align with your organization's chosen installation location.
537537
538538
#### Script to execute the binary client analyzer
539539
@@ -572,7 +572,7 @@ The Python version of the client analyzer accepts command line parameters to per
572572
#### Run the client analyzer script
573573
574574
> [!NOTE]
575-
> If you have an active live response session you can skip Step 1.
575+
> If you have an active live response session, you can skip Step 1.
576576
577577
1. Initiate a [Live Response session](live-response.md#initiate-a-live-response-session-on-a-device) on the machine you want to investigate.
578578

0 commit comments

Comments
 (0)