Skip to content

Commit 4715691

Browse files
authored
Merge pull request #220874 from linda33wj/purview
Update scan run monitoring
2 parents 29dfffb + 3344354 commit 4715691

File tree

3 files changed

+69
-21
lines changed

3 files changed

+69
-21
lines changed

articles/purview/how-to-monitor-scan-runs.md

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: jingwang
66
ms.service: purview
77
ms.subservice: purview-data-map
88
ms.topic: how-to
9-
ms.date: 08/19/2022
9+
ms.date: 12/08/2022
1010
---
1111

1212
# Monitor scan runs in Microsoft Purview
@@ -15,26 +15,81 @@ In Microsoft Purview, you can register and scan various types of data sources, a
1515

1616
## Monitor scan runs
1717

18-
1. Go to your Microsoft Purview account -> open **Microsoft Purview governance portal** -> **Data map** -> **Monitoring**. You need to have **Data source admin** role on any collection to access this page. And you will see the scan runs that belong to the collections on which you have data source admin privilege.
19-
20-
1. The high-level KPIs show total scan runs within a period. The time period is defaulted at last 30 days, you can also choose to select last seven days. Based on the time filter selected, you can see the distribution of successful, failed, and canceled scan runs by week or by the day in the graph.
18+
1. Go to your Microsoft Purview account -> open **Microsoft Purview governance portal** -> **Data map** -> **Monitoring**. You need to have **Data source admin** role on any collection to access this page. And you'll see the scan runs that belong to the collections on which you have data source admin privilege.
19+
20+
1. The high-level KPIs show total scan runs within a period. The time period is defaulted at last 30 days, you can also choose to select last seven days. Based on the time filter selected, you can see the distribution of successful, failed, canceled, and in progress scan runs by week or by the day in the graph.
2121

2222
:::image type="content" source="./media/how-to-monitor-scan-runs/monitor-scan-runs.png" alt-text="View scan runs over time" lightbox="./media/how-to-monitor-scan-runs/monitor-scan-runs.png":::
2323

24-
1. At the bottom of the graph, there is a **View more** link for you to explore further. The link opens the **Scan status** page. Here you can see a scan name and the number of times it has succeeded, failed, or been canceled in the time period. You can also filter the list by source types.
24+
1. At the bottom of the graph, there's a **View more** link for you to explore further. The link opens the **Scan status** page. Here you can see a scan name and the number of times it has succeeded, failed, or been canceled in the time period. You can also filter the list by source types.
2525

2626
:::image type="content" source="./media/how-to-monitor-scan-runs/view-scan-status.png" alt-text="View scan status in details" lightbox="./media/how-to-monitor-scan-runs/view-scan-status.png":::
2727

2828
1. You can explore a specific scan further by selecting the **scan name**. It connects you to the scan history page, where you can find the list of run IDs with more execution details.
2929

3030
:::image type="content" source="./media/how-to-monitor-scan-runs/view-scan-history.png" alt-text="View scan history for a given scan" lightbox="./media/how-to-monitor-scan-runs/view-scan-history.png":::
3131

32-
1. You can come back to **Scan Status** page by following the bread crumbs on the top left corner of the run history page.
32+
1. You can click into the **run ID** to check more about the [scan run details](#scan-run-details).
33+
34+
## Scan run details
35+
36+
You can navigate to scan run history for a given scan from different places:
37+
38+
- Go to **Data map** -> **Monitoring** as described in [Monitor scan runs](#monitor-scan-runs) section.
39+
- Go to **Data map** -> **Sources** -> select the desired data source -> see **Scans**, **Recent scans** or **Recent failed scans**.
40+
- Go to **Data map** -> **Collections** -> select the desired collection -> **Scans** -> select the scan name that you want to view more.
41+
42+
You can click the **run ID** to check more about the scan run details:
43+
44+
:::image type="content" source="./media/how-to-monitor-scan-runs/monitor-scan-run-details.png" alt-text="Screenshot of view scan run execution details." lightbox="./media/how-to-monitor-scan-runs/monitor-scan-run-details.png":::
45+
46+
- **Run ID**: The GUID used to identify the given scan run.
47+
48+
- **Run type**: Full or incremental scan.
49+
50+
- **Scan** section summarizes the metrics for discovery phase that Purview connects to the source, extracts the metadata/lineage and classifies the data.
51+
52+
- **Scan status**:
53+
54+
| Status | Description |
55+
| ----------- | ------------------------------------------------------------ |
56+
| Completed | The scan phase succeeds. |
57+
| Failed | The scan phase fails. You can check the error details by clicking the "More info" link next to it. |
58+
| Canceled | The scan run is canceled by user. |
59+
| In Progress | The scan is running in progress. |
60+
| Queued | The scan run is waiting for available integration runtime resource.<br>If you use self-hosted integration runtime, note each node can run a number of concurrent scans at the same time depending on your machine specification (CPU and memory). More scans will be in Queued status. |
61+
| Throttled | The scan run is being throttled. It means this Microsoft Purview account at the moment has more ongoing scan runs than the allowed max concurrent count. Learn more about the limit [here](how-to-manage-quotas.md). This particular scan run will be waiting and be executed once your other ongoing scan(s) finishes. |
62+
63+
- **Scan type**: Manual or scheduled scan.
64+
- **Assets discovered**: The number of assets enumerated from the source. For both full and incremental scans, it includes all assets in the configured scope, regardless of whether they're existing assets or newly created/updated assets since the last scan run. While for incremental scan, detailed metadata is extracted only for newly created or updated assets additionally.
65+
- **Assets classified**: The number of assets sampled to classify the data, regardless of whether the assets have any matching classification or not. It's a subset of the discovered assets based on the [sampling mechanism](microsoft-purview-connector-overview.md#sampling-data-for-classification). For incremental scan, only newly created or updated assets may be selected for classification.
66+
- **Duration**: The scan phase duration and the start/end time.
67+
68+
- **Data ingestion** section summarizes the metrics for ingestion phase that Purview populates the data map with the identified metadata and lineage.
69+
70+
- **Ingestion status**:
71+
72+
| Status | Description |
73+
| ------------------- | ------------------------------------------------------------ |
74+
| Completed | All of the assets and relationships are ingested into the data map successfully. |
75+
| Partially completed | Partial of the assets and relationships are ingested into the data map successfully, while some fail. |
76+
| Failed | The ingestion phase fails. |
77+
| Canceled | The scan run is canceled by user, thus the ingestion is canceled along. |
78+
| In Progress | The ingestion is running in progress. |
79+
| Queued | The ingestion is waiting for available service resource or waiting for scan to discover metadata. |
80+
81+
- **Assets ingested**: The number of assets ingested into the data map. For full scan, the number is equal to the "assets discovered" count; for incremental scan, it only includes the newly created or updated assets, in which case less than the "assets discovered" count. When scanning file-based source, it's the raw assets count before resource set aggregation.
82+
83+
- **Relationships ingested**: The number of relationships ingested into the data map. It includes lineage and other relationships like foreign key relationships.
84+
85+
- **Duration**: The ingestion duration and the start/end time.
3386

3487
## Scans no longer run
3588

3689
If your Microsoft Purview scan used to successfully run, but are now failing, check these things:
37-
1. Have credentials to your resource changed or been rotated? If so, you'll need to update your scan to have the correct credentials.
90+
91+
1. Check the error message first to see the failure details.
92+
1. Have credentials to your resource changed or been rotated? If so, you'll need to update to make your scan use the correct credentials.
3893
1. Is an [Azure Policy](../governance/policy/overview.md) preventing **updates to Storage accounts**? If so follow the [Microsoft Purview exception tag guide](create-azure-purview-portal-faq.md) to create an exception for Microsoft Purview accounts.
3994
1. Are you using a self-hosted integration runtime? Check that it's up to date with the latest software and that it's connected to your network.
4095

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
11
---
2-
author: whhender
3-
ms.author: whhender
2+
author: linda33wj
3+
ms.author: jingwang
44
ms.service: purview
55
ms.subservice: purview-data-catalog
66
ms.topic: include
7-
ms.date: 6/04/2021
7+
ms.date: 12/08/2022
88
ms.custom: ignite-fall-2021
99
---
1010

1111
### View your scans and scan runs
1212

1313
To view existing scans:
1414

15-
1. Go to the [Microsoft Purview governance portal](https://web.purview.azure.com/resource/). Select the **Data Map** tab on the left pane.
16-
15+
1. Go to the [Microsoft Purview governance portal](https://web.purview.azure.com/resource/). Select the **Data map** tab on the left pane.
1716
1. Select the desired data source. You can view a list of existing scans on that data source under **Recent scans**, or you can view all scans on the **Scans** tab.
18-
19-
1. Select the scan that has results you want to view.
20-
21-
The page that appears shows you all of the previous scan runs, along with the status and metrics for each scan run. It also displays:
22-
23-
- Whether your scan was scheduled or manual.
24-
- How many assets had classifications applied.
25-
- How many total assets were discovered.
26-
- The start and end times of the scan, and the total scan duration.
17+
1. Select the scan that has results you want to view. The page shows you all of the previous scan runs, along with the status and metrics for each scan run.
18+
1. Click the **run ID** to check more about the [scan run details](../how-to-monitor-scan-runs.md#scan-run-details).
2719

2820
### Manage your scans - edit, delete, or cancel
2921

@@ -40,5 +32,6 @@ To manage or delete a scan:
4032
- Delete your scan by selecting **Delete scan**.
4133

4234
> [!NOTE]
35+
>
4336
> * Deleting your scan does not delete catalog assets created from previous scans.
4437
> * The asset will no longer be updated with schema changes if your source table has changed and you re-scan the source table after editing the description on the **Schema** tab of Microsoft Purview.
51.5 KB
Loading

0 commit comments

Comments
 (0)