Skip to content

Commit

Permalink
create new har file faq (#6035)
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 authored Sep 9, 2024
1 parent 8df69c7 commit f751079
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 4 deletions.
4 changes: 2 additions & 2 deletions website/docs/community/resources/getting-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]
**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 [email protected]:
- 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.
4 changes: 3 additions & 1 deletion website/docs/docs/dbt-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<details>

<summary>Example of common support questions</summary>

Types of dbt Cloud-related questions our Support team can assist you with, regardless of your dbt Cloud plan:<br /><br />
<b>How do I...</b><br />
- set up a dbt Cloud project?<br />
Expand Down
71 changes: 71 additions & 0 deletions website/docs/faqs/Troubleshooting/generate-har-file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
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. 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. 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

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. 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.
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.
15 changes: 14 additions & 1 deletion website/docs/guides/debug-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</div>
## FAQs
Here are some useful FAQs to help you debug your dbt project:
- <FAQ path="Troubleshooting/generate-har-file" />
- <FAQ path="Troubleshooting/access_token_error" />
- <FAQ path="Troubleshooting/could-not-parse-project" />
- <FAQ path="Troubleshooting/gitignore" />
- <FAQ path="Troubleshooting/job-memory-limits" />
- <FAQ path="Troubleshooting/runtime-packages.yml" />
- <FAQ path="Troubleshooting/dispatch-could-not-find-package" />
- <FAQ path="Troubleshooting/sql-errors" />
</div>

0 comments on commit f751079

Please sign in to comment.