diff --git a/openmetadata-docs/content/v1.6.x/collate-menu.md b/openmetadata-docs/content/v1.6.x/collate-menu.md index b936c3006aa..29bddb70098 100644 --- a/openmetadata-docs/content/v1.6.x/collate-menu.md +++ b/openmetadata-docs/content/v1.6.x/collate-menu.md @@ -630,6 +630,8 @@ site_menu: url: /how-to-guides/data-discovery/details - category: How-to Guides / Data Discovery / Add Complex Queries using Advanced Search url: /how-to-guides/data-discovery/advanced + - category: How-to Guides / Data Discovery / Troubleshooting + url: /how-to-guides/data-discovery/troubleshooting - category: How-to Guides / Data Discovery / Bulk Upload Data Assets url: /how-to-guides/data-discovery/bulk-upload - category: How-to Guides / Data Discovery / How to Bulk Import Data Asset diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-discovery/troubleshooting.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-discovery/troubleshooting.md new file mode 100644 index 00000000000..5122d4e01d3 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-discovery/troubleshooting.md @@ -0,0 +1,42 @@ +--- +title: Troubleshooting for Export issue +slug: /how-to-guides/data-discovery/troubleshooting +--- + +# Troubleshooting Export Issue +When attempting to export a **CSV file for a Glossary**, the process gets stuck on the message **"Export initiated successfully."** and never completes. The file is not downloaded, and the export button remains disabled. + +This issue may occur if **WebSockets are blocked** in your network setup due to a **proxy** or **load balancer** configuration. OpenMetadata relies on WebSockets for real-time communication, and if they are blocked, the export process cannot complete. + +## Troubleshooting Steps + +### Step 1: Check for Load Balancer or Proxy + +If your setup includes a **load balancer** or **proxy**, verify whether WebSockets are being blocked. + +1. Run the following API request to check the export status: + +```bash +curl -X GET "https:///api/v1/glossaries/name//exportAsync" +``` + +If the response does not return a file and remains in an active state indefinitely, WebSockets might be blocked. + +### Step 2: Verify WebSocket Connectivity + +1. Open the Developer Tools in your browser (F12 or Ctrl + Shift + I in Chrome). +2. Navigate to the Network tab. +3. Filter requests by WebSockets (WS). +4. Check if WebSocket requests to OpenMetadata (wss://) are blocked, failing, or not established. + +### Step 3: Adjust WebSocket Settings in Your Proxy + +If WebSockets are blocked, update your proxy configuration to allow WebSocket traffic. + +### Step 4: Restart Services and Verify + +1. Restart your proxy or load balancer after making the configuration changes. +2. Clear browser cache and cookies. +3. Retry the CSV export in OpenMetadata. + +Once WebSockets are enabled in the proxy settings, the glossary export should complete successfully, and the CSV file should be available for download. diff --git a/openmetadata-docs/content/v1.6.x/menu.md b/openmetadata-docs/content/v1.6.x/menu.md index a13449f2717..115e0d760cf 100644 --- a/openmetadata-docs/content/v1.6.x/menu.md +++ b/openmetadata-docs/content/v1.6.x/menu.md @@ -799,6 +799,8 @@ site_menu: url: /how-to-guides/data-discovery/details - category: How-to Guides / Data Discovery / Add Complex Queries using Advanced Search url: /how-to-guides/data-discovery/advanced + - category: How-to Guides / Data Discovery / Troubleshooting + url: /how-to-guides/data-discovery/troubleshooting - category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension url: /how-to-guides/data-discovery/openmetadata-extension - category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing Activity Feeds and Managing Tasks diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md index 66bd565901a..55adbb4271b 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md @@ -638,6 +638,8 @@ site_menu: url: /how-to-guides/data-discovery/details - category: How-to Guides / Data Discovery / Add Complex Queries using Advanced Search url: /how-to-guides/data-discovery/advanced + - category: How-to Guides / Data Discovery / Troubleshooting + url: /how-to-guides/data-discovery/troubleshooting - category: How-to Guides / Data Discovery / Bulk Upload Data Assets url: /how-to-guides/data-discovery/bulk-upload - category: How-to Guides / Data Discovery / How to Bulk Import Data Asset diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/how-to-guides/data-discovery/troubleshooting.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/how-to-guides/data-discovery/troubleshooting.md new file mode 100644 index 00000000000..5122d4e01d3 --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/how-to-guides/data-discovery/troubleshooting.md @@ -0,0 +1,42 @@ +--- +title: Troubleshooting for Export issue +slug: /how-to-guides/data-discovery/troubleshooting +--- + +# Troubleshooting Export Issue +When attempting to export a **CSV file for a Glossary**, the process gets stuck on the message **"Export initiated successfully."** and never completes. The file is not downloaded, and the export button remains disabled. + +This issue may occur if **WebSockets are blocked** in your network setup due to a **proxy** or **load balancer** configuration. OpenMetadata relies on WebSockets for real-time communication, and if they are blocked, the export process cannot complete. + +## Troubleshooting Steps + +### Step 1: Check for Load Balancer or Proxy + +If your setup includes a **load balancer** or **proxy**, verify whether WebSockets are being blocked. + +1. Run the following API request to check the export status: + +```bash +curl -X GET "https:///api/v1/glossaries/name//exportAsync" +``` + +If the response does not return a file and remains in an active state indefinitely, WebSockets might be blocked. + +### Step 2: Verify WebSocket Connectivity + +1. Open the Developer Tools in your browser (F12 or Ctrl + Shift + I in Chrome). +2. Navigate to the Network tab. +3. Filter requests by WebSockets (WS). +4. Check if WebSocket requests to OpenMetadata (wss://) are blocked, failing, or not established. + +### Step 3: Adjust WebSocket Settings in Your Proxy + +If WebSockets are blocked, update your proxy configuration to allow WebSocket traffic. + +### Step 4: Restart Services and Verify + +1. Restart your proxy or load balancer after making the configuration changes. +2. Clear browser cache and cookies. +3. Retry the CSV export in OpenMetadata. + +Once WebSockets are enabled in the proxy settings, the glossary export should complete successfully, and the CSV file should be available for download. diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md index f5833c56a26..a591d2bb42d 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md @@ -807,6 +807,8 @@ site_menu: url: /how-to-guides/data-discovery/details - category: How-to Guides / Data Discovery / Add Complex Queries using Advanced Search url: /how-to-guides/data-discovery/advanced + - category: How-to Guides / Data Discovery / Troubleshooting + url: /how-to-guides/data-discovery/troubleshooting - category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension url: /how-to-guides/data-discovery/openmetadata-extension - category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing Activity Feeds and Managing Tasks