From 728e239feb0a3d2533849ca9c85061aff5591d8d Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 9 Sep 2024 12:26:27 +0100 Subject: [PATCH 1/6] add faq --- .../faqs/Troubleshooting/generate-har-file.md | 73 +++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 website/docs/faqs/Troubleshooting/generate-har-file.md diff --git a/website/docs/faqs/Troubleshooting/generate-har-file.md b/website/docs/faqs/Troubleshooting/generate-har-file.md new file mode 100644 index 00000000000..564d166b642 --- /dev/null +++ b/website/docs/faqs/Troubleshooting/generate-har-file.md @@ -0,0 +1,73 @@ +--- +title: "How to generate HAR files" +description: "How to generate HAR files for debugging" +sidebar_label: 'Generate HAR files' +sidebar_position: 1 +keywords: + - HAR files + - HTTP Archive + - Troubleshooting + - Debugging +--- + +HTTP Archive (HAR) files are used to gather data from users’ browser, which dbt Support uses to troubleshoot network or resource issues. This information includes detailed timing information about the requests made between the browser and the server. + +The following sections describe how to generate HAR files using common browsers such as [Google Chrome](#google-chrome), [Mozilla Firefox](#mozilla-firefox), [Apple Safari](#apple-safari), and [Microsoft Edge](#microsoft-edge). + +:::info +Remove or hide any confidential or personally identifying information before you send the HAR file to dbt Labs. You can edit the file using a text editor. +::: + +## Google Chrome + +1. Open Google Chrome. +2. Click on **View** --> **Developer Tools**. +3. Select the **Network** tab. +4. Ensure that Google Chrome is recording. A red button (πŸ”΄) indicates that a recording is already in progress. Otherwise, click **Record network log**. +5. Select **Preserve Log**. +6. Clear any existing logs by clicking **Clear network log** (🚫). +7. Go to the page where the issue occurred and reproduce the issue. +8. Click Export HAR (the down arrow icon) to export the file as HAR. The icon is located on the same row as the **Clear network log** button. +9. Save the HAR file. +10. Upload the HAR file to the dbt Support ticket thread. + +## Mozilla Firefox + +1. Open Firefox +2. Go to the page to be recorded. +3. Click the application menu and then **More tools** --> **Web Developer Tools**. +4. In the developer tools docked tab select **Network**. +5. Go to the page where the issue occurred and reproduce the issue. The page automatically starts recording as you navigate. +6. When you're finished, click **Pause/Resume recording network log**. +7. Right-click anywhere in the **File** column and select **Save All as HAR**. +8. Save the HAR file. +9. Upload the HAR file to the dbt Support ticket thread. + +## Apple Safari + +1. Open Safari. +2. In case the **Develop** menu doesn't appear in the menu bar, go to **Safari** and then **Settings**. +3. Click **Advanced**. +4. Select the **Show features for web developers** checkbox. +5. Go to the page to be recorded. +6. From the **Develop** menu, select **Show Web Inspector**. +7. Click the **Network tab**. +8. Go to the page where the issue occurred and reproduce the issue. +9. When you're finished, click **Export**. +10. Save the file. +11. Upload the HAR file to the dbt Support ticket thread. + +## Microsoft Edge + +1. Open Microsoft Edge. +2. Click the **Settings and more** menu (...) to the right of the toolbar and then select **More tools** --> **Developer tools**. +3. Click **Network**. +4. Ensure that Microsoft Edge is recording. A red button (πŸ”΄) indicates that a recording is already in progress. Otherwise, click **Record network log**. +5. Visit the page and reproduce the issue. +6. When you're finished, click **Stop recording network log**. +7. Click **Export HAR** (the down arrow icon) or press **Ctrl + S** to export the file as HAR. +8. Save the HAR file. +9. Upload the HAR file to the dbt Support ticket thread. + +## Additional resources +- Check out the [How to generate a HAR file in Chrome](https://www.loom.com/share/cabdb7be338243f188eb619b4d1d79ca) video for a visual guide on how to generate HAR files in Chrome. From f1db33f7c97bb60794580ed6a9970cc33c3c52cb Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 9 Sep 2024 12:43:03 +0100 Subject: [PATCH 2/6] add har faq link --- website/docs/community/resources/getting-help.md | 4 ++-- website/docs/docs/dbt-support.md | 4 +++- .../faqs/Troubleshooting/generate-har-file.md | 10 +++++----- website/docs/guides/debug-errors.md | 15 ++++++++++++++- 4 files changed, 24 insertions(+), 9 deletions(-) diff --git a/website/docs/community/resources/getting-help.md b/website/docs/community/resources/getting-help.md index 19b7c22fbdf..e8dba3ef918 100644 --- a/website/docs/community/resources/getting-help.md +++ b/website/docs/community/resources/getting-help.md @@ -55,9 +55,9 @@ If you need dedicated support to build your dbt project, consider reaching out r If you want to receive dbt training, check out our [dbt Learn](https://learn.getdbt.com/) program. ## dbt Cloud support -**Note:** If you are a **dbt Cloud user** and need help with one of the following issues, please reach out to us by using the speech bubble (πŸ’¬) in the dbt Cloud interface or at support@getdbt.com +**Note:** If you are a **dbt Cloud user** and need help with one of the following issues, please reach out to us by clicking **Create a support ticket** through the dbt Cloud navigation or emailing support@getdbt.com: - Account setup (e.g. connection issues, repo connections) - Billing - Bug reports related to the web interface -As a rule of thumb, if you are using dbt Cloud, but your problem is related to code within your dbt project, then please follow the above process rather than reaching out to support. Refer to [dbt Cloud support](/docs/dbt-support) for more information. +As a rule of thumb, if you are using dbt Cloud, but your problem is related to code within your dbt project, then please follow the above process or checking out the [FAQs](/docs/faqs) rather than reaching out to support. Refer to [dbt Cloud support](/docs/dbt-support) for more information. diff --git a/website/docs/docs/dbt-support.md b/website/docs/docs/dbt-support.md index 5ccd251e783..07eb715a31c 100644 --- a/website/docs/docs/dbt-support.md +++ b/website/docs/docs/dbt-support.md @@ -23,11 +23,13 @@ We want to help you work through implementing and utilizing dbt Cloud at your or - **Enterprise plans** — Priority [support](#severity-level-for-enterprise-support), options for custom support coverage hours, implementation assistance, dedicated management, and dbt Labs security reviews depending on price point. - **Developer and Team plans** — 24x5 support (no service level agreement (SLA); [contact Sales](https://www.getdbt.com/pricing/) for Enterprise plan inquiries). -- **Support team help** — Assistance with dbt Cloud questions, like project setup, login issues, error understanding, setup private packages, link to a new GitHub account, and so on. +- **Support team help** — Assistance with [common dbt Cloud questions](/category/troubleshooting), like project setup, login issues, error understanding, setup private packages, link to a new GitHub account, [how to generate a har file](/faqs/Troubleshooting/generate-har-file), and so on. - **Resource guide** — Check the [guide](/community/resources/getting-help) for effective help-seeking strategies.
+ Example of common support questions + Types of dbt Cloud-related questions our Support team can assist you with, regardless of your dbt Cloud plan:

How do I...
- set up a dbt Cloud project?
diff --git a/website/docs/faqs/Troubleshooting/generate-har-file.md b/website/docs/faqs/Troubleshooting/generate-har-file.md index 564d166b642..1c4c2f1b3d5 100644 --- a/website/docs/faqs/Troubleshooting/generate-har-file.md +++ b/website/docs/faqs/Troubleshooting/generate-har-file.md @@ -18,7 +18,7 @@ The following sections describe how to generate HAR files using common browsers Remove or hide any confidential or personally identifying information before you send the HAR file to dbt Labs. You can edit the file using a text editor. ::: -## Google Chrome +### Google Chrome 1. Open Google Chrome. 2. Click on **View** --> **Developer Tools**. @@ -31,7 +31,7 @@ Remove or hide any confidential or personally identifying information before you 9. Save the HAR file. 10. Upload the HAR file to the dbt Support ticket thread. -## Mozilla Firefox +### Mozilla Firefox 1. Open Firefox 2. Go to the page to be recorded. @@ -43,7 +43,7 @@ Remove or hide any confidential or personally identifying information before you 8. Save the HAR file. 9. Upload the HAR file to the dbt Support ticket thread. -## Apple Safari +### Apple Safari 1. Open Safari. 2. In case the **Develop** menu doesn't appear in the menu bar, go to **Safari** and then **Settings**. @@ -57,7 +57,7 @@ Remove or hide any confidential or personally identifying information before you 10. Save the file. 11. Upload the HAR file to the dbt Support ticket thread. -## Microsoft Edge +### Microsoft Edge 1. Open Microsoft Edge. 2. Click the **Settings and more** menu (...) to the right of the toolbar and then select **More tools** --> **Developer tools**. @@ -69,5 +69,5 @@ Remove or hide any confidential or personally identifying information before you 8. Save the HAR file. 9. Upload the HAR file to the dbt Support ticket thread. -## Additional resources +### Additional resources - Check out the [How to generate a HAR file in Chrome](https://www.loom.com/share/cabdb7be338243f188eb619b4d1d79ca) video for a visual guide on how to generate HAR files in Chrome. diff --git a/website/docs/guides/debug-errors.md b/website/docs/guides/debug-errors.md index 11f02f325a4..58776fa181f 100644 --- a/website/docs/guides/debug-errors.md +++ b/website/docs/guides/debug-errors.md @@ -390,4 +390,17 @@ _(More likely for dbt Core users)_ If you just opened a SQL file in the `target/` directory to help debug an issue, it's not uncommon to accidentally edit that file! To avoid this, try changing your code editor settings to grey out any files in the `target/` directory β€” the visual cue will help avoid the issue. - \ No newline at end of file +## FAQs + +Here are some useful FAQs to help you debug your dbt project: + +- +- +- +- +- +- +- +- + + From 792ae8711d80c715f1e25ef52445cbaf10d31e23 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 9 Sep 2024 12:47:34 +0100 Subject: [PATCH 3/6] tweak --- website/docs/faqs/Troubleshooting/generate-har-file.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/faqs/Troubleshooting/generate-har-file.md b/website/docs/faqs/Troubleshooting/generate-har-file.md index 1c4c2f1b3d5..0440d771ad9 100644 --- a/website/docs/faqs/Troubleshooting/generate-har-file.md +++ b/website/docs/faqs/Troubleshooting/generate-har-file.md @@ -27,7 +27,7 @@ Remove or hide any confidential or personally identifying information before you 5. Select **Preserve Log**. 6. Clear any existing logs by clicking **Clear network log** (🚫). 7. Go to the page where the issue occurred and reproduce the issue. -8. Click Export HAR (the down arrow icon) to export the file as HAR. The icon is located on the same row as the **Clear network log** button. +8. Click **Export HAR** (the down arrow icon) to export the file as HAR. The icon is located on the same row as the **Clear network log** button. 9. Save the HAR file. 10. Upload the HAR file to the dbt Support ticket thread. @@ -36,7 +36,7 @@ Remove or hide any confidential or personally identifying information before you 1. Open Firefox 2. Go to the page to be recorded. 3. Click the application menu and then **More tools** --> **Web Developer Tools**. -4. In the developer tools docked tab select **Network**. +4. In the developer tools docked tab, select **Network**. 5. Go to the page where the issue occurred and reproduce the issue. The page automatically starts recording as you navigate. 6. When you're finished, click **Pause/Resume recording network log**. 7. Right-click anywhere in the **File** column and select **Save All as HAR**. From 0a4e75486ecbc865eb98c3bf08b76d6666cf3d06 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 9 Sep 2024 12:49:37 +0100 Subject: [PATCH 4/6] consistency --- .../faqs/Troubleshooting/generate-har-file.md | 34 +++++++++---------- 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/website/docs/faqs/Troubleshooting/generate-har-file.md b/website/docs/faqs/Troubleshooting/generate-har-file.md index 0440d771ad9..1085df126a1 100644 --- a/website/docs/faqs/Troubleshooting/generate-har-file.md +++ b/website/docs/faqs/Troubleshooting/generate-har-file.md @@ -33,29 +33,27 @@ Remove or hide any confidential or personally identifying information before you ### Mozilla Firefox -1. Open Firefox -2. Go to the page to be recorded. -3. Click the application menu and then **More tools** --> **Web Developer Tools**. -4. In the developer tools docked tab, select **Network**. -5. Go to the page where the issue occurred and reproduce the issue. The page automatically starts recording as you navigate. -6. When you're finished, click **Pause/Resume recording network log**. -7. Right-click anywhere in the **File** column and select **Save All as HAR**. -8. Save the HAR file. -9. Upload the HAR file to the dbt Support ticket thread. +1. Open Firefox. +2. Click the application menu and then **More tools** --> **Web Developer Tools**. +3. In the developer tools docked tab, select **Network**. +4. Go to the page where the issue occurred and reproduce the issue. The page automatically starts recording as you navigate. +5. When you're finished, click **Pause/Resume recording network log**. +6. Right-click anywhere in the **File** column and select **Save All as HAR**. +7. Save the HAR file. +8. Upload the HAR file to the dbt Support ticket thread. ### Apple Safari 1. Open Safari. 2. In case the **Develop** menu doesn't appear in the menu bar, go to **Safari** and then **Settings**. 3. Click **Advanced**. -4. Select the **Show features for web developers** checkbox. -5. Go to the page to be recorded. -6. From the **Develop** menu, select **Show Web Inspector**. -7. Click the **Network tab**. -8. Go to the page where the issue occurred and reproduce the issue. -9. When you're finished, click **Export**. -10. Save the file. -11. Upload the HAR file to the dbt Support ticket thread. +4. Select the **Show features for web developers** checkbox.. +5. From the **Develop** menu, select **Show Web Inspector**. +6. Click the **Network tab**. +7. Go to the page where the issue occurred and reproduce the issue. +8. When you're finished, click **Export**. +9. Save the file. +10. Upload the HAR file to the dbt Support ticket thread. ### Microsoft Edge @@ -63,7 +61,7 @@ Remove or hide any confidential or personally identifying information before you 2. Click the **Settings and more** menu (...) to the right of the toolbar and then select **More tools** --> **Developer tools**. 3. Click **Network**. 4. Ensure that Microsoft Edge is recording. A red button (πŸ”΄) indicates that a recording is already in progress. Otherwise, click **Record network log**. -5. Visit the page and reproduce the issue. +5. Go to the page where the issue occurred and reproduce the issue. 6. When you're finished, click **Stop recording network log**. 7. Click **Export HAR** (the down arrow icon) or press **Ctrl + S** to export the file as HAR. 8. Save the HAR file. From 7f70714b15da1e772e080a82a331238d8af4166e Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 9 Sep 2024 12:50:49 +0100 Subject: [PATCH 5/6] remove bullet --- website/docs/faqs/Troubleshooting/generate-har-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/faqs/Troubleshooting/generate-har-file.md b/website/docs/faqs/Troubleshooting/generate-har-file.md index 1085df126a1..dbca4871344 100644 --- a/website/docs/faqs/Troubleshooting/generate-har-file.md +++ b/website/docs/faqs/Troubleshooting/generate-har-file.md @@ -68,4 +68,4 @@ Remove or hide any confidential or personally identifying information before you 9. Upload the HAR file to the dbt Support ticket thread. ### Additional resources -- Check out the [How to generate a HAR file in Chrome](https://www.loom.com/share/cabdb7be338243f188eb619b4d1d79ca) video for a visual guide on how to generate HAR files in Chrome. +Check out the [How to generate a HAR file in Chrome](https://www.loom.com/share/cabdb7be338243f188eb619b4d1d79ca) video for a visual guide on how to generate HAR files in Chrome. From 31289932855cec481e4648cc965bd58cdc127177 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 9 Sep 2024 13:27:18 +0100 Subject: [PATCH 6/6] Update website/docs/faqs/Troubleshooting/generate-har-file.md --- website/docs/faqs/Troubleshooting/generate-har-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/faqs/Troubleshooting/generate-har-file.md b/website/docs/faqs/Troubleshooting/generate-har-file.md index dbca4871344..0cb16711942 100644 --- a/website/docs/faqs/Troubleshooting/generate-har-file.md +++ b/website/docs/faqs/Troubleshooting/generate-har-file.md @@ -47,7 +47,7 @@ Remove or hide any confidential or personally identifying information before you 1. Open Safari. 2. In case the **Develop** menu doesn't appear in the menu bar, go to **Safari** and then **Settings**. 3. Click **Advanced**. -4. Select the **Show features for web developers** checkbox.. +4. Select the **Show features for web developers** checkbox. 5. From the **Develop** menu, select **Show Web Inspector**. 6. Click the **Network tab**. 7. Go to the page where the issue occurred and reproduce the issue.