Skip to content

Commit 195b7f8

Browse files
committed
Grammar and Style Updates
1 parent 4a92f22 commit 195b7f8

File tree

1 file changed

+83
-11
lines changed

1 file changed

+83
-11
lines changed

articles/purview/how-to-monitor-with-azure-monitor.md

Lines changed: 83 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,40 +75,112 @@ Follow the steps to create a Diagnostic setting for your Microsoft Purview accou
7575

7676
Create a new diagnostic setting to collect platform logs and metrics by following this article: [Create diagnostic settings to send platform logs and metrics to different destinations](../azure-monitor/essentials/diagnostic-settings.md).
7777

78-
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-one-diagnostic-setting.png" alt-text="Screenshot showing creating diagnostic log." lightbox="./media/how-to-monitor-with-azure-monitor/step-one-diagnostic-setting.png":::
78+
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-one-diagnostic-setting.png" alt-text="Screenshot showing creating diagnostic log." lightbox="./media/how-to-monitor-with-azure-monitor/step-one-diagnostic-setting.png":::
79+
80+
You can send your logs to:
7981

80-
You can send your logs to:
8182
- [A log analytics workspace](#destination---log-analytics-workspace)
8283
- [A storage account](#destination---storage-account)
83-
84-
#### Destination - Log Analytics Workspace
85-
Select the destination to a log analytics workspace to send the event to. Create a name for the diagnostic setting, select the applicable log category group and select the right subscription and workspace, then click save. The workspace doesn't have to be in the same region as the resource being monitored. Follow this article to [Create a New Log Analytics Workspace](../azure-monitor/logs/quick-create-workspace.md).
84+
85+
### Destination - Log Analytics Workspace
86+
87+
Select the destination to a log analytics workspace to send the event to. Create a name for the diagnostic setting, select the applicable log category group and select the right subscription and workspace, then select save. The workspace doesn't have to be in the same region as the resource being monitored. Follow this article to [Create a New Log Analytics Workspace](../azure-monitor/logs/quick-create-workspace.md).
8688

8789
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-two-diagnostic-setting.png" alt-text="Screenshot showing assigning log analytics workspace to send event to." lightbox="./media/how-to-monitor-with-azure-monitor/step-two-diagnostic-setting.png":::
8890

8991
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-two-one-diagnostic-setting.png" alt-text="Screenshot showing saved diagnostic log event to log analytics workspace." lightbox="./media/how-to-monitor-with-azure-monitor/step-two-one-diagnostic-setting.png":::
9092

91-
Verify the changes in **Log Analytics Workspace** by perfoming some operations to populate data such as creating/updating/deleting policy. After which you can open the **Log Analytics Workspace**, navigate to **Logs**, enter query filter as **"purviewsecuritylogs"**, then click **"Run"** to execute the query.
93+
Verify the changes in **Log Analytics Workspace** by performing some operations to populate data such as creating/updating/deleting policy. After which you can open the **Log Analytics Workspace**, navigate to **Logs**, enter query filter as **"purviewsecuritylogs"**, then select **"Run"** to execute the query.
9294

9395
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-two-two-diagnostic-setting.png" alt-text="Screenshot showing log results in the Log Analytics Workspace after a query was run." lightbox="./media/how-to-monitor-with-azure-monitor/step-two-two-diagnostic-setting.png":::
9496

95-
#### Destination - Storage account
96-
To log the events to a storage account; create a diagnostic setting name, select the log category,. select the destination as archieve to a storage account, select the right subscription and storage account then click save. A dedicated storage account is recommended for archiving the diagnostic logs. Following this article to [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-portal).
97+
### Destination - Storage account
98+
99+
To log the events to a storage account; create a diagnostic setting name, select the log category, select the destination as archive to a storage account, select the right subscription and storage account then select save. A dedicated storage account is recommended for archiving the diagnostic logs. Following this article to [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-portal).
97100

98101
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-three-diagnostic-setting.png" alt-text="Screenshot showing assigning storage account for diagnostic log." lightbox="./media/how-to-monitor-with-azure-monitor/step-three-diagnostic-setting.png":::
99102

100103
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-three-one-diagnostic-setting.png" alt-text="Screenshot showing saved log events to storage account." lightbox="./media/how-to-monitor-with-azure-monitor/step-three-one-diagnostic-setting.png":::
101-
102-
To see logs in the **Storage Account**, create/update/delete a policy, then open the **Storage Account**, navigate to **Containers**, and click on the container name
104+
105+
To see logs in the **Storage Account**, create/update/delete a policy, then open the **Storage Account**, navigate to **Containers**, and select the container name
103106

104107
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-three-two-diagnostic-setting.png" alt-text="Screenshot showing container in storage account where the diagnostic logs have been sent to." lightbox="./media/how-to-monitor-with-azure-monitor/step-three-two-diagnostic-setting.png":::
105108

106-
Navigate to the flie and download it to see the logs
109+
Navigate to the file and download it to see the logs
107110

108111
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-three-three-diagnostic-setting.png" alt-text="Screenshot showing folders with details of logs." lightbox="./media/how-to-monitor-with-azure-monitor/step-three-three-diagnostic-setting.png":::
109112

110113
:::image type="content" source="./media/how-to-monitor-with-azure-monitor/step-three-four-diagnostic-setting.png" alt-text="Screenshot showing details of logs." lightbox="./media/how-to-monitor-with-azure-monitor/step-three-four-diagnostic-setting.png":::
111114

115+
## Sample Log
116+
117+
The event tracks the scan life cycle. A scan operation follows progress through a sequence of states, from Queued, Running and finally a terminal state of Succeeded | Failed | Canceled. An event is logged for each state transition and the schema of the event will have the following properties.
118+
119+
```JSON
120+
{
121+
"time": "<The UTC time when the event occurred>",
122+
"properties": {
123+
"dataSourceName": "<Registered data source friendly name>",
124+
"dataSourceType": "<Registered data source type>",
125+
"scanName": "<Scan instance friendly name>",
126+
"assetsDiscovered": "<If the resultType is succeeded, count of assets discovered in scan run>",
127+
"assetsClassified": "<If the resultType is succeeded, count of assets classified in scan run>",
128+
"scanQueueTimeInSeconds": "<If the resultType is succeeded, total seconds the scan instance in queue>",
129+
"scanTotalRunTimeInSeconds": "<If the resultType is succeeded, total seconds the scan took to run>",
130+
"runType": "<How the scan is triggered>",
131+
"errorDetails": "<Scan failure error>",
132+
"scanResultId": "<Unique GUID for the scan instance>"
133+
},
134+
"resourceId": "<The azure resource identifier>",
135+
"category": "<The diagnostic log category>",
136+
"operationName": "<The operation that cause the event Possible values for ScanStatusLogEvent category are:
137+
|AdhocScanRun
138+
|TriggeredScanRun
139+
|StatusChangeNotification>",
140+
"resultType": "Queued – indicates a scan is queued.
141+
Running – indicates a scan entered a running state.
142+
Succeeded – indicates a scan completed successfully.
143+
Failed – indicates a scan failure event.
144+
Cancelled – indicates a scan was cancelled. ",
145+
"resultSignature": "<Not used for ScanStatusLogEvent category. >",
146+
"resultDescription": "<This will have an error message if the resultType is Failed. >",
147+
"durationMs": "<Not used for ScanStatusLogEvent category. >",
148+
"level": "<The log severity level. Possible values are:
149+
|Informational
150+
|Error >",
151+
"location": "<The location of the Microsoft Purview account>",
152+
}
153+
```
154+
155+
The Sample log for an event instance is shown in the below section.
156+
157+
```JSON
158+
{
159+
"time": "2020-11-24T20:25:13.022860553Z",
160+
"properties": {
161+
"dataSourceName": "AzureDataExplorer-swD",
162+
"dataSourceType": "AzureDataExplorer",
163+
"scanName": "Scan-Kzw-shoebox-test",
164+
"assetsDiscovered": "0",
165+
"assetsClassified": "0",
166+
"scanQueueTimeInSeconds": "0",
167+
"scanTotalRunTimeInSeconds": "0",
168+
"runType": "Manual",
169+
"errorDetails": "empty_value",
170+
"scanResultId": "0dc51a72-4156-40e3-8539-b5728394561f"
171+
},
172+
"resourceId": "/SUBSCRIPTIONS/111111111111-111-4EB2/RESOURCEGROUPS/FOOBAR-TEST-RG/PROVIDERS/MICROSOFT.PURVIEW/ACCOUNTS/FOOBAR-HEY-TEST-NEW-MANIFEST-EUS",
173+
"category": "ScanStatusLogEvent",
174+
"operationName": "TriggeredScanRun",
175+
"resultType": "Delayed",
176+
"resultSignature": "empty_value",
177+
"resultDescription": "empty_value",
178+
"durationMs": 0,
179+
"level": "Informational",
180+
"location": "eastus",
181+
}
182+
```
183+
112184
## Next steps
113185

114186
[Elastic data map in Microsoft Purview](concept-elastic-data-map.md)

0 commit comments

Comments
 (0)