Skip to content

Commit ebe00cb

Browse files
authored
Merge pull request #201670 from batamig/cm-audit-logs
Viewing CM audit logs
2 parents 2824897 + b7459d4 commit ebe00cb

File tree

3 files changed

+65
-33
lines changed

3 files changed

+65
-33
lines changed

articles/defender-for-iot/organizations/how-to-create-and-manage-users.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,18 +134,54 @@ To update sign-out counting periods, adjust the `= <number>` value to the requir
134134

135135
## Track user activity
136136

137-
You can track user activity in the event timeline on each sensor. The timeline displays the event or affected device, and the time and date that the user carried out the activity.
137+
Track user activity on a sensor's event timeline, or by viewing audit logs generated on an on-premises management console.
138138

139-
**To view user activity**:
139+
- **The timeline** displays the event or affected device, and the time and date that the user carried out the activity.
140140

141-
1. Select **Event Timeline** from the sensor side menu.
141+
- **Audit logs** record key activity data at the time of occurrence. Use audit logs generated on the on-premises management console to understand which changes were made, when, and by whom.
142142

143-
1. Verify that **User Operations** filter is set to **Show**.
143+
### View user activity on the sensor's Event Timeline
144144

145-
:::image type="content" source="media/how-to-create-and-manage-users/track-user-activity.png" alt-text="Screenshot of the Event timeline showing a user that signed in to Defender for IoT.":::
145+
Select **Event Timeline** from the sensor side menu. If needed, verify that **User Operations** filter is set to **Show**.
146146

147-
1. Use the filters or Ctrl F option to find the information of interest to you.
147+
For example:
148148

149+
:::image type="content" source="media/how-to-create-and-manage-users/track-user-activity.png" alt-text="Screenshot of the Event timeline showing a user that signed in to Defender for IoT.":::
150+
151+
Use the filters or search using CTRL+F to find the information of interest to you.
152+
153+
### View audit log data on the on-premises management console
154+
155+
In the on-premises management console, select **System Settings > System Statistics**, and then select **Audit log**.
156+
157+
The dialog displays data from the currently active audit log. For example:
158+
159+
For example:
160+
161+
:::image type="content" source="media/how-to-create-and-manage-users/view-audit-logs.png" alt-text="Screenshot of the on-premises management console showing audit logs." lightbox="media/how-to-create-and-manage-users/view-audit-logs.png":::
162+
163+
New audit logs are generated at every 10 MB. One previous log is stored in addition to the current active log file.
164+
165+
Audit logs include the following data:
166+
167+
| Action | Information logged |
168+
|--|--|
169+
| **Learn, and remediation of alerts** | Alert ID |
170+
| **Password changes** | User, User ID |
171+
| **Login** | User |
172+
| **User creation** | User, User role |
173+
| **Password reset** | User name |
174+
| **Exclusion rules-Creation**| Rule summary |
175+
| **Exclusion rules-Editing**| Rule ID, Rule Summary |
176+
| **Exclusion rules-Deletion** | Rule ID |
177+
| **Management Console Upgrade** | The upgrade file used |
178+
| **Sensor upgrade retry** | Sensor ID |
179+
| **Uploaded TI package** | No additional information recorded. |
180+
181+
182+
> [!TIP]
183+
> You may also want to export your audit logs to send them to the support team for extra troubleshooting. For more information, see [Export audit logs for troubleshooting](how-to-troubleshoot-the-sensor-and-on-premises-management-console.md#export-audit-logs-for-troubleshooting)
184+
>
149185
150186
## Change a user's password
151187

@@ -232,6 +268,7 @@ You can recover the password for the on-premises management console or the senso
232268
233269
1. Select **Next**, and your user, and a system-generated password for your management console will then appear.
234270

271+
235272
## Next steps
236273

237274
- [Activate and set up your sensor](how-to-activate-and-set-up-your-sensor.md)

articles/defender-for-iot/organizations/how-to-troubleshoot-the-sensor-and-on-premises-management-console.md

Lines changed: 22 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Troubleshoot the sensor and on-premises management console
33
description: Troubleshoot your sensor and on-premises management console to eliminate any problems you might be having.
4-
ms.date: 05/22/2022
4+
ms.date: 06/15/2022
55
ms.topic: article
66
---
77
# Troubleshoot the sensor and on-premises management console
@@ -262,13 +262,14 @@ All allowlists, policies, and configuration settings are cleared, and the sensor
262262

263263

264264
## Troubleshoot an on-premises management console
265-
### Investigate a lack of expected alerts on the management console
266265

267-
If an expected alert is not shown in the **Alerts** window, verify the following:
266+
### Investigate a lack of expected alerts
267+
268+
If you don't see an expected alert on the on-premises **Alerts** page, do the following to troubleshoot:
268269

269-
- Check if the same alert already appears in the **Alerts** window as a reaction to a different security instance. If yes, and this alert has not been handled yet, a new alert is not shown.
270+
- Verify whether the alert is already listed as a reaction to a different security instance. If it has, and that alert hasn't yet been handled, a new alert isn't shown elsewhere.
270271

271-
- Verify that you did not exclude this alert by using the **Alert Exclusion** rules in the on-premises management console.
272+
- Verify that the alert isn't being excluded by **Alert Exclusion** rules. For more information, see [Create alert exclusion rules](how-to-work-with-alerts-on-premises-management-console.md#create-alert-exclusion-rules).
272273

273274
### Tweak the Quality of Service (QoS)
274275

@@ -310,39 +311,33 @@ To limit the number of alerts, use the `notifications.max_number_to_report` prop
310311

311312
1. Save the changes. No restart is required.
312313

314+
### Export audit logs for troubleshooting
313315

316+
Audit logs record key activity data at the time of occurrence. Use audit logs generated on the on-premises management console to understand which changes were made, when, and by whom.
314317

315-
### Export audit logs from the management console
318+
You may also want to export your audit logs to send them to the support team for extra troubleshooting.
319+
320+
> [!NOTE]
321+
> New audit logs are generated at every 10 MB. One previous log is stored in addition to the current active log file.
322+
>
316323
317-
Audit logs record key information at the time of occurrence. Audit logs are useful when you are trying to figure out what changes were made, and by who. Audit logs can be exported in the management console, and contain the following information:
324+
**To export audit log data**:
318325

319-
| Action | Information logged |
320-
|--|--|
321-
| **Learn, and remediation of alerts** | Alert ID |
322-
| **Password changes** | User, User ID |
323-
| **Login** | User |
324-
| **User creation** | User, User role |
325-
| **Password reset** | User name |
326-
| **Exclusion rules-Creation**| Rule summary |
327-
| **Exclusion rules-Editing**| Rule ID, Rule Summary |
328-
| **Exclusion rules-Deletion** | Rule ID |
329-
| **Management Console Upgrade** | The upgrade file used |
330-
| **Sensor upgrade retry** | Sensor ID |
331-
| **Uploaded TI package** | No additional information recorded. |
326+
1. In the on-premises management console, select **System Settings > Export**.
332327

333-
**To export the audit log**:
328+
1. In the **Export Troubleshooting Information** dialog:
334329

335-
1. In the management console, in the left pane, select **System Settings**.
330+
1. In the **File Name** field, enter a meaningful name for the exported log. The default filename uses the current date, such as **13:10-June-14-2022.tar.gz**.
336331

337-
1. Select **Export**.
332+
1. Select **Audit Logs**.
338333

339-
1. In the File Name field, enter the file name that you want to use for the exported log. If no name is entered, the default file name will be the current date.
334+
1. Select **Export**.
340335

341-
1. Select **Audit Logs**.
336+
The file is exported and is linked from the **Archived Files** list at the bottom of the **Export Troubleshooting Information** dialog. Select the link to download the file.
342337

343-
1. Select **Export**.
338+
1. Exported audit logs are encrypted for your security, and require a password to open. In the **Archived Files** list, select the :::image type="icon" source="media/how-to-troubleshoot-the-sensor-and-on-premises-management-console/eye-icon.png" border="false"::: button for your exported logs to view its password. If you're forwarding the audit logs to the support team, make sure to send the password to support separately from the exported logs.
344339

345-
The exported log is added to the **Archived Logs** list. Select the :::image type="icon" source="media/how-to-troubleshoot-the-sensor-and-on-premises-management-console/eye-icon.png" border="false"::: button to view the OTP. Send the OTP string to the support team in a separate message from the exported logs. The support team will be able to extract exported logs only by using the unique OTP that's used to encrypt the logs.
340+
For more information, see [View audit log data on the on-premises management console](how-to-create-and-manage-users.md#view-audit-log-data-on-the-on-premises-management-console).
346341

347342
## Next steps
348343

680 KB
Loading

0 commit comments

Comments
 (0)