Skip to content

Commit 1be1c9e

Browse files
authored
Merge pull request #1779 from YongRhee-MSFT/docs-editor/run-analyzer-macos-1730418632
Update run-analyzer-macos.md
2 parents 4683bf9 + f28de74 commit 1be1c9e

File tree

1 file changed

+12
-79
lines changed

1 file changed

+12
-79
lines changed

defender-endpoint/run-analyzer-macos.md

Lines changed: 12 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: defender-endpoint
99
ms.subservice: macos
1010
ms.localizationpriority: medium
1111
ms.topic: troubleshooting-general
12-
ms.date: 10/31/2024
12+
ms.date: 11/01/2024
1313
ms.custom: partner-contribution
1414
ms.collection:
1515
- m365-security
@@ -24,9 +24,6 @@ f1.keywords: NOCSH
2424

2525
If you're experiencing reliability or device health issues with Microsoft Defender for Endpoint on macOS, you can use the XMDE Client Analyzer to diagnose these issues. This article describes two ways to use the client analyzer tool:
2626

27-
- [Use the binary version of the client analyzer](#use-the-binary-version-of-the-client-analyzer)
28-
-
29-
3027
1. Using a binary version (no external Python dependency)
3128
2. Using a Python-based solution
3229

@@ -65,13 +62,12 @@ If you're experiencing reliability or device health issues with Microsoft Defend
6562
- `SupportToolLinuxBinary.zip`: For all Linux devices
6663
- `SupportToolMacOSBinary.zip`: For Mac devices
6764

68-
5. Depending on the machine you're investigating, unzip the appropriate file.
69-
70-
| OS type | Terminal command |
71-
|---|---|
72-
| Linux | `unzip -q SupportToolLinuxBinary.zip` |
73-
| Mac | `unzip -q SupportToolMacOSBinary.zip` |
65+
1. Unzip the SupportToolMacOSBinary.zip.
7466

67+
```bash
68+
unzip -q SupportToolMacOSBinary.zip
69+
```
70+
7571
6. Run the tool as root to generate your diagnostic package:
7672

7773
```bash
@@ -87,11 +83,11 @@ The tool currently requires Python version 3 or later to be installed on your de
8783
> [!WARNING]
8884
> 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 is recommended that you install the packages into a user PIP environment.
8985
90-
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool to the Mac or Linux machine you're investigating.
86+
1. Download the [XMDE Client Analyzer](https://aka.ms/XMDEClientAnalyzer) tool to the Mac machine you're investigating.
9187

9288
If you're using a terminal, download the tool by running the following command:
9389

94-
```bash
90+
```bash
9591
wget --quiet -O XMDEClientAnalyzer.zip https://aka.ms/XMDEClientAnalyzer
9692
```
9793

@@ -128,9 +124,9 @@ The tool currently requires Python version 3 or later to be installed on your de
128124
./mde_support_tool.sh
129125
```
130126

131-
7. To collect actual diagnostic package and generate the result archive file, run again as root:
127+
1. To collect actual diagnostic package and generate the result archive file, run again as root:
132128

133-
```bash
129+
```bash
134130
sudo ./mde_support_tool.sh -d
135131
```
136132

@@ -196,75 +192,12 @@ To approve profile installation, see the [Apple Support Guide](https://support.a
196192

197193
Usage example `./mde_support_tool.sh trace --length 5`
198194

199-
#### Exclude mode
200-
201-
Add exclusions for audit-d monitoring.
202-
203-
> [!NOTE]
204-
> This functionality exists for Linux only.
205-
206-
```console
207-
-h, --help show this help message and exit
208-
-e <executable>, --exe <executable>
209-
exclude by executable name, i.e: bash
210-
-p <process id>, --pid <process id>
211-
exclude by process id, i.e: 911
212-
-d <directory>, --dir <directory>
213-
exclude by target path, i.e: /var/foo/bar
214-
-x <executable> <directory>, --exe_dir <executable> <directory>
215-
exclude by executable path and target path, i.e: /bin/bash /var/foo/bar
216-
-q <q_size>, --queue <q_size>
217-
set dispatcher q_depth size
218-
-r, --remove remove exclusion file
219-
-s, --stat get statistics about common executables
220-
-l, --list list auditd rules
221-
-o, --override Override the existing auditd exclusion rules file for mdatp
222-
-c <syscall number>, --syscall <syscall number>
223-
exclude all process of the given syscall
224-
```
225-
226-
Usage example: `sudo ./MDESupportTool exclude -d /var/foo/bar`
227-
228-
### AuditD Rate Limiter
229-
230-
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.
231-
232-
> [!NOTE]
233-
> This functionality exists for Linux only.
234-
235-
```console
236-
-h, --help show this help message and exit
237-
-e <true/false>, --enable <true/false> enable/disable the rate limit with default values
238-
```
239-
240-
Usage example: `sudo ./mde_support_tool.sh ratelimit -e true`
241-
242-
> [!NOTE]
243-
> 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.
244-
245-
### AuditD Skip Faulty Rules
246-
247-
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.
248-
249-
> [!NOTE]
250-
> This functionality is only available on Linux.
251-
252-
```console
253-
-h, --help show this help message and exit
254-
-e <true/false>, --enable <true/false> enable/disable the option to skip the faulty rules. In case no argumanet is passed, the option will be true by default.
255-
```
256-
257-
Usage example: `sudo ./mde_support_tool.sh skipfaultyrules -e true`
258-
259-
> [!NOTE]
260-
> This functionality skips faulty rules. The faulty rule then needs to be further identified and fixed.
261-
262-
## Result package contents on macOS and Linux
195+
## Result package contents on macOS
263196

264197
| File | Description |
265198
|---|---|
266199
| `report.html` | The main HTML output file that contains the findings and guidance from running the client analyzer tool on the device. This file is only generated when running the Python-based version of the client analyzer tool. |
267-
| `mde_diagnostic.zip` | Same diagnostic output that gets generated when running `mdatp diagnostic create` on either [macOS](mac-resources.md#collecting-diagnostic-information) or [Linux](linux-resources.md#collect-diagnostic-information). |
200+
| `mde_diagnostic.zip` | Same diagnostic output that gets generated when running `mdatp diagnostic create` on [macOS](mac-resources.md#collecting-diagnostic-information). |
268201
| `mde.xml` | XML output that is generated while running and is used to build the html report file. |
269202
| `Processes_information.txt` | Contains the details of the running Microsoft Defender for Endpoint related processes on the system. |
270203
| `Log.txt` | Contains the same log messages written on screen during the data collection. |

0 commit comments

Comments
 (0)