Skip to content

Commit 8db58e6

Browse files
authored
Simplify instructions and update examples in documentation
1 parent 1bb87f9 commit 8db58e6

File tree

1 file changed

+39
-22
lines changed

1 file changed

+39
-22
lines changed

defender-endpoint/run-analyzer-linux.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If you're experiencing reliability or device health issues with Defender for End
5151
unzip -q XMDEClientAnalyzerBinary.zip -d XMDEClientAnalyzerBinary
5252
```
5353

54-
3. Change to the tool's directory by entering the following command:
54+
3. Change the directory:
5555

5656
```bash
5757
cd XMDEClientAnalyzerBinary
@@ -62,7 +62,7 @@ If you're experiencing reliability or device health issues with Defender for End
6262
- **SupportToolLinuxBinary.zip** : For all Linux devices
6363
- **SupportToolMacOSBinary.zip** : For Mac devices
6464

65-
5. Unzip `SupportToolLinuxBinary.zip` files based on the machine you need to investigate.
65+
5. Unzip `SupportToolLinuxBinary.zip` file.
6666

6767
```bash
6868
unzip -q SupportToolLinuxBinary.zip
@@ -95,13 +95,13 @@ If you're experiencing reliability or device health issues with Defender for End
9595
echo '07E6A7B89E28A78309D5B6F1E25E4CDFBA9CA141450E422D76441C03AD3477E7 XMDEClientAnalyzer.zip' | sha256sum -c
9696
```
9797
98-
3. Extract the contents of XMDEClientAnalyzer.zip on the machine by using the following command:
98+
3. Extract the contents of XMDEClientAnalyzer.zip on the machine.
9999
100100
```bash
101101
unzip -q XMDEClientAnalyzer.zip -d XMDEClientAnalyzer
102102
```
103103
104-
4. Change directory to the extracted location.
104+
4. Change the directory.
105105
106106
```bash
107107
cd XMDEClientAnalyzer
@@ -225,7 +225,7 @@ optional arguments:
225225
Usage example: `sudo ./MDESupportTool -d`
226226
227227
> [!NOTE]
228-
> The log level autoreset feature only available in 2405 or newer client version.
228+
> The log level autoreset feature is available only on agent version 101.24052.0002 or above.
229229
230230
The files generated when using this mode are summarized in the following table:
231231
@@ -306,7 +306,7 @@ Collect extensive machine performance tracing of Defender for Endpoint processes
306306
307307
Usage example: `sudo ./MDESupportTool performance --frequency 500`
308308
309-
The files generated when using this mode:
309+
Below is the file generated when using this mode:
310310
311311
| File | Remarks |
312312
| ------ | ------ |
@@ -315,13 +315,15 @@ The files generated when using this mode:
315315
> [!NOTE]
316316
> The files corresponding to diagnostic mode are also generated.
317317
318-
The tar files contain files on the format `<pid of a MDE process>.data`.
318+
The tar contains files in the format `<pid of a MDE process>.data`.
319319
The data file can be read using the command:
320320
321-
`perf report -i <pid>.data`
321+
```console
322+
perf report -i <pid>.data
323+
```
322324
323325
#### Run connectivity test
324-
This modes test if the cloud resources needed by Defender for Endpoint are reachable or not.
326+
This mode tests if the cloud resources needed by Defender for Endpoint are reachable or not.
325327
326328
```console
327329
@@ -332,9 +334,12 @@ This modes test if the cloud resources needed by Defender for Endpoint are reach
332334
333335
```
334336
335-
Usage example: `sudo ./MDESupportTool connectivitytest -o ~/MicrosoftDefenderATPOnboardingLinuxServer.py`
337+
Usage example:
336338
337-
The result is printed in the screen.
339+
```console
340+
sudo ./MDESupportTool connectivitytest -o ~/MicrosoftDefenderATPOnboardingLinuxServer.py`
341+
```
342+
The output printed on the screen will show if the URLs are reachable or not.
338343
339344
340345
#### Collect different installation/onboarding reports
@@ -349,9 +354,12 @@ This mode collects installation related info like distro info, system requiremen
349354
350355
```
351356
352-
Usage example: `sudo ./MDESupportTool installation --all`
357+
Usage example:
358+
```console
359+
sudo ./MDESupportTool installation --all
360+
```
353361
354-
A single report `installation_report.json` is generated. The keys in the file are as:
362+
A single report `installation_report.json` is generated. The keys in the file are as follows:
355363
356364
| Key | Remarks |
357365
| ------------- | ------------- |
@@ -360,7 +368,7 @@ A single report `installation_report.json` is generated. The keys in the file ar
360368
361369
#### Exclude mode
362370
363-
Add exclusions for audit-d monitoring.
371+
This mode adds exclusions for audit-d monitoring.
364372
365373
```console
366374
@@ -384,11 +392,14 @@ Add exclusions for audit-d monitoring.
384392
385393
```
386394
387-
Usage example: `sudo ./MDESupportTool exclude -d /var/foo/bar`
395+
Usage example:
396+
```console
397+
sudo ./MDESupportTool exclude -d /var/foo/bar`
398+
```
388399
389400
### AuditD rate limiter
390401
391-
Syntax that can be used to limit the number of events being reported by the auditD plugin. 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 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.
392403
393404
```console
394405
@@ -397,14 +408,17 @@ Syntax that can be used to limit the number of events being reported by the audi
397408
398409
```
399410
400-
Usage example: `sudo ./mde_support_tool.sh ratelimit -e true`
411+
Usage example:
412+
```console
413+
sudo ./mde_support_tool.sh ratelimit -e true
414+
```
401415
402416
> [!NOTE]
403-
> This functionality should be carefully used as limits the number of events being reported by the auditd subsystem as a whole. This could reduces the number of events for other subscribers as well.
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.
404418
405-
### AuditD skips faulty rules
419+
### AuditD skip faulty rules
406420
407-
This option enables you to skip the faulty rules added in the auditd rules file while loading them. This option allows the auditd subsystem to continue loading rules even if there's a faulty rule. This option summarizes the results of loading the rules. In the background, this option runs the auditctl with the `-c` option.
421+
This option enables you to skip the faulty rules added in the auditd rules file while loading them. It allows the auditd subsystem to continue loading rules even if there's a faulty rule.
408422
409423
```console
410424
@@ -413,7 +427,10 @@ This option enables you to skip the faulty rules added in the auditd rules file
413427
414428
```
415429
416-
Usage example: `sudo ./mde_support_tool.sh skipfaultyrules -e true`
430+
Usage example:
431+
```console
432+
sudo ./mde_support_tool.sh skipfaultyrules -e true
433+
```
417434
418435
> [!NOTE]
419436
> This functionality skips faulty rules. Faulty rules must be further identified and fixed.
@@ -448,7 +465,7 @@ The following script performs the first six steps of the [Running the Binary ver
448465
1. Create a bash file `InstallXMDEClientAnalyzer.sh` and paste the following content into it.
449466
450467
```bash
451-
#! /usr/bin/bash
468+
#! /usr/bin/bash
452469
453470
echo "Starting Client Analyzer Script. Running As:"
454471
whoami

0 commit comments

Comments
 (0)