Skip to content

Commit bc2ef5e

Browse files
authored
Merge pull request #232605 from abandyop/patch-17
Add Troubleshooting Guide for SHIR for external public and customers
2 parents fcb267b + 10139ed commit bc2ef5e

File tree

9 files changed

+965
-0
lines changed

9 files changed

+965
-0
lines changed

articles/data-factory/includes/troubleshoot-shir-include.md

Lines changed: 882 additions & 0 deletions
Large diffs are not rendered by default.

articles/purview/index.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,3 +203,14 @@ landingContent:
203203
url: catalog-private-link-name-resolution.md
204204
- text: Connect to private networks
205205
url: manage-integration-runtimes.md
206+
207+
208+
#Card
209+
- title: Troubleshooting Microsoft Purview
210+
linkLists:
211+
- linkListType: how-to-guide
212+
links:
213+
- text: Troubleshooting Purview scans - SHIR
214+
url: scanning-shir-troubleshooting.md
215+
216+

articles/purview/media/no.png

874 Bytes
Loading
751 KB
Loading
71.2 KB
Loading
126 KB
Loading

articles/purview/media/yes.png

784 Bytes
Loading
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Troubleshoot SHIR self-hosted integration runtime
3+
titleSuffix: Microsoft Purview, Azure Data Factory & Azure Synapse
4+
description: Learn how to troubleshoot self-hosted integration runtime issues in Microsoft Purview.
5+
author: abandyop
6+
ms.service: purview
7+
ms.subservice: purview-data-map
8+
ms.custom: purview
9+
ms.topic: troubleshooting
10+
ms.date: 04/01/2023
11+
ms.author: arindamba
12+
---
13+
14+
# Troubleshoot Microsoft Purview SHIR self-hosted integration runtime
15+
16+
APPLIES TO: :::image type="icon" source="media/yes.png" border="false":::Microsoft Purview :::image type="icon" source="media/yes.png" border="false":::Azure Data Factory :::image type="icon" source="media/yes.png" border="false":::Azure Synapse Analytics
17+
18+
This article explores common troubleshooting methods for self-hosted integration runtime (SHIR) in Microsoft Purview, Azure Data Factory and Synapse workspaces.
19+
20+
## Gather Microsoft Purview specific SHIR self-hosted integration runtime logs
21+
22+
For failed activities that are running on a self-hosted IR or a shared IR, the service supports viewing and uploading error logs from the [Windows Event Viewer](https://learn.microsoft.com/shows/inside/event-viewer).
23+
To get support and troubleshooting guidance for SHIR issues, you may need to generate an error report and send it across to Microsoft. To generate the error report ID, follow the instructions here, and then enter the report ID to search for related known issues.
24+
25+
1. Before starting the scan on the Microsoft Purview governance portal:
26+
- Navigate to the SHIR VM, or machine and open the Windows Event Viewer.
27+
- Clear the windows event viewer logs in the "Integration Runtime" section. Right-click on the logs and select clear logs option.
28+
- Navigate back to the Microsoft Purview governance portal and start the scan.
29+
- Once the scan shows status "Failed", navigate back to the SHIR VM, or machine and refresh the event viewer in the "Integration Runtime" section.
30+
- The activity logs are displayed for the failed scan run.
31+
32+
:::image type="content" source="media/scanning-shir-troubleshooting/shir-event-viewer-logs-ir.png" lightbox="media/scanning-shir-troubleshooting/shir-event-viewer-logs-ir.png" alt-text="Screenshot of the logs for the failed scan SHIR activity.":::
33+
34+
1. For further assistance from Microsoft, select **Send Logs**.
35+
36+
The **Share the self-hosted integration runtime (SHIR) logs with Microsoft** window opens.
37+
38+
:::image type="content" source="media/scanning-shir-troubleshooting/shir-send-logs-ir.png" lightbox="media/scanning-shir-troubleshooting/shir-send-logs-ir.png" alt-text="Screenshot of the send logs button on the self-hosted integration runtime (SHIR) to upload logs to Microsoft.":::
39+
40+
1. Select which logs you want to send.
41+
* For a *self-hosted IR*, you can upload logs that are related to the failed activity or all logs on the self-hosted IR node.
42+
* For a *shared IR*, you can upload only logs that are related to the failed activity.
43+
44+
1. When the logs are uploaded, keep a record of the Report ID for later use if you need further assistance to solve the issue.
45+
46+
:::image type="content" source="media/scanning-shir-troubleshooting/shir-send-logs-complete.png" lightbox="media/scanning-shir-troubleshooting/shir-send-logs-complete.png" alt-text="Screenshot of the displayed report ID in the upload progress window for the Purview SHIR logs.":::
47+
48+
> [!NOTE]
49+
> Log viewing and uploading requests are executed on all online self-hosted IR instances. If any logs are missing, make sure that all the self-hosted IR instances are online.
50+
51+
52+
## Self-hosted integration runtime SHIR general failure or error
53+
54+
There are lots of common errors, warnings, issues between Purview SHIR and Azure Data Factory or Azure Synapse SHIR. If your SHIR issues aren't resolved at this stage, refer to the [Azure Data Factory ADF or Azure Synapse SHIR troubleshooting guide](../data-factory/self-hosted-integration-runtime-troubleshoot-guide.md)
55+
56+
[!INCLUDE[SHIR](../data-factory/includes/troubleshoot-shir-include.md)]
57+
58+
## Manage your Purview SHIR - next steps
59+
60+
For more help with troubleshooting, try the following resources:
61+
62+
* [Getting started with Microsoft Purview](https://azure.microsoft.com/products/purview/)
63+
* [Create and Manage SHIR Self-hosted integration runtimes in Purview](manage-integration-runtimes.md)
64+
* [Stack overflow forum for Microsoft Purview](https://stackoverflow.com/questions/tagged/azure-purview)
65+
* [Twitter information about Microsoft Purview](https://twitter.com/hashtag/Purview)
66+
* [Microsoft Purview Troubleshooting](frequently-asked-questions.yml)
67+
68+

articles/purview/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,8 @@ items:
223223
href: manage-integration-runtimes.md
224224
- name: Self-hosted integration runtime auto-update and expiration
225225
href: self-hosted-integration-runtime-version.md
226+
- name: Troubleshoot SHIR Self-hosted integration runtime
227+
href: scanning-shir-troubleshooting.md
226228
- name: Scan
227229
items:
228230
- name: Scan a registered source
@@ -235,6 +237,8 @@ items:
235237
href: how-to-monitor-data-map-population.md
236238
- name: Troubleshoot scans & connections
237239
href: troubleshoot-connections.md
240+
- name: Troubleshoot SHIR Self-hosted integration runtime
241+
href: scanning-shir-troubleshooting.md
238242
- name: Classify
239243
items:
240244
- name: Automatically apply classifications

0 commit comments

Comments
 (0)