|
1 | 1 | --- |
2 | | -title: Azure Data Studio Troubleshooting |
| 2 | +title: Azure Data Studio troubleshooting |
3 | 3 | description: "Learn how to get logs and troubleshoot Azure Data Studio, which is helpful in reporting bug reports." |
4 | 4 | author: erinstellato-ms |
5 | 5 | ms.author: erinstellato |
6 | 6 | ms.reviewer: maghan, randolphwest |
7 | 7 | ms.date: 08/29/2023 |
8 | 8 | ms.service: azure-data-studio |
9 | 9 | ms.topic: conceptual |
10 | | -ms.custom: updatefrequency5 |
11 | 10 | --- |
12 | 11 |
|
13 | | -# Azure Data Studio Troubleshooting |
| 12 | +# Azure Data Studio troubleshooting |
| 13 | + |
14 | 14 | Azure Data Studio tracks issues and feature requests using on a [GitHub repository issue tracker](https://github.com/Microsoft/azuredatastudio/issues) for the `azuredatastudio` repository. |
15 | 15 |
|
16 | | -## If you've experienced any issue |
| 16 | +## Report an issue you've experienced |
17 | 17 |
|
18 | | -Report issues to [GitHub Issue Tracker](https://github.com/Microsoft/azuredatastudio/issues) and let us know any details that will help reproduce the error. Include any [log information](#how-to-set-the-logging-level) from the log file. |
| 18 | +Report issues to [GitHub Issue Tracker](https://github.com/Microsoft/azuredatastudio/issues) and let us know any details that help reproduce the error. Include any [log information](#how-to-set-the-logging-level) from the log file. |
19 | 19 |
|
20 | | -## Writing good bug reports and feature requests |
| 20 | +## Write good bug reports and feature requests |
21 | 21 |
|
22 | 22 | File a single issue per problem and feature request. |
23 | 23 |
|
24 | | -* Don't enumerate multiple bugs or feature requests in the same issue. |
25 | | -* Don't add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. |
| 24 | +- Don't enumerate multiple bugs or feature requests in the same issue. |
| 25 | +- Don't add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. |
26 | 26 |
|
27 | 27 | The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. |
28 | 28 |
|
29 | 29 | Include the following information with each issue: |
30 | 30 |
|
31 | | -* Version of Azure Data Studio |
32 | | -* Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw. |
33 | | -* Images, animations, or a link to a video. Images and animations illustrate repro-steps but don't replace them. |
34 | | -* A code snippet that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue. |
| 31 | +- Version of Azure Data Studio |
| 32 | +- Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw. |
| 33 | +- Images, animations, or a link to a video. Images and animations illustrate repro-steps but don't replace them. |
| 34 | +- A code snippet that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue. |
35 | 35 |
|
36 | | -> [!NOTE] |
37 | | -> Because we need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient. |
| 36 | +> [!NOTE] |
| 37 | +> Because we need to copy and paste the code snippet, including a code snippet as a media file (that is, `.gif`) isn't sufficient. |
38 | 38 |
|
39 | | -* Errors in the Dev Tools Console (Help | Toggle Developer Tools) |
| 39 | +- Errors in the Dev Tools Console (**Help > Toggle Developer Tools**) |
40 | 40 |
|
41 | | -Please remember to do the following: |
| 41 | +Remember to take the following steps: |
42 | 42 |
|
43 | | -* Search the issue repository to see if the same issue already exists. |
44 | | -* Simplify your code around the issue so we can better isolate the problem. |
| 43 | +- Search the issue repository to see if the same issue already exists. |
| 44 | +- Simplify your code around the issue so we can better isolate the problem. |
45 | 45 |
|
46 | 46 | Don't feel bad if we can't reproduce the issue and ask for more information! |
47 | 47 |
|
48 | 48 | ## How to set the logging level |
49 | 49 |
|
50 | 50 | ### Azure Data Studio |
51 | | -Run the `Developer: Set Log Level...` command to select the log level for the current session. This value is NOT persisted over multiple sessions - so if you restart Azure Data Studio it will revert back to the default `Info` level. |
52 | 51 |
|
53 | | -If you want to enable debug logging for startup then set the log level to `Debug` and run the `Developer: Reload Window` command. |
| 52 | +From the **Command Palette (Ctrl/Cmd + Shift + P)**, run the **Developer: Set Log Level...** command to select the log level for the current session. This value isn't persisted over multiple sessions. If you restart Azure Data Studio, it reverts back to the default `Info` level. |
| 53 | + |
| 54 | +If you want to enable debug logging for startup then set the log level to `Debug` and run the **Developer: Reload Window** command. |
54 | 55 |
|
55 | | -### MSSQL (Built-In Extension) |
| 56 | +### MSSQL (Built-in extension) |
56 | 57 |
|
57 | | -If the `Mssql: Log Debug Info` user setting is set to true, then debug log info will be sent to the `MSSQL` output channel. |
| 58 | +If the `Mssql: Log Debug Info` user setting is set to true, then debug log info is sent to the `MSSQL` output channel. |
58 | 59 |
|
59 | 60 | The `Mssql: Tracing Level` user setting is used to control the verbosity of the logging. |
60 | 61 |
|
61 | 62 | ## Azure Data Studio logs and location |
62 | 63 |
|
63 | | -From Azure Data Studio, run the `Developer: Open Logs Folder` command to open the path to the logs. There's many different types of log files that write there, a few of the commonly used ones are: |
| 64 | +From the **Command Palette (Ctrl/Cmd + Shift + P)**, run the **Developer: Open Logs Folder** command to open the path to the logs. There are many different types of log files that write there. A few of the commonly used ones are: |
64 | 65 |
|
65 | | -1. `renderer#.log` (for example, renderer1.log) - this file is the log file for the main process. |
66 | | -1. `telemetry.log` - When the log level is set to `Trace` this file will contain the telemetry events sent by Azure Data Studio |
67 | | -1. `exthost#/exthost.log` - Log file for the extension host process (this is only the process itself, not the extensions running inside it) |
68 | | -1. `exthost#/Microsoft.mssql` - Logs for the mssql extension, which contains much of the core logic for MSSQL-related features |
69 | | - * sqltools.log is the log for SQL Tools Service |
70 | | -1. `exthost#/output_logging_#######` - these folders contain the messages displayed in the `Output` panel in Azure Data Studio. Each file is named `#-<Channel Name>` so for example the `Notebooks` output channel may output to a file named `3-Notebooks.log`. |
| 66 | +1. `renderer#.log` (for example, `renderer1.log`): this file is the log file for the main process. |
| 67 | +1. `telemetry.log`: When the log level is set to `Trace`, this file contains the telemetry events sent by Azure Data Studio |
| 68 | +1. `exthost#/exthost.log`: Log file for the extension host process (this is only the process itself, not the extensions running inside it) |
| 69 | +1. `exthost#/Microsoft.mssql`: Logs for the mssql extension, which contains much of the core logic for MSSQL-related features |
| 70 | + - `sqltools.log` is the log for SQL Tools service |
| 71 | +1. `exthost#/output_logging_#######`: these folders contain the messages displayed in the `Output` panel in Azure Data Studio. Each file is named `#-<Channel Name>`. For example, the `Notebooks` output channel may output to a file named `3-Notebooks.log`. |
71 | 72 |
|
72 | | -If you are asked to provide logs, zip up the entire folder to ensure that the correct logs are included. |
| 73 | +If you're asked to provide logs, zip up the entire folder to ensure that the correct logs are included. |
73 | 74 |
|
74 | 75 | ## Recover editor files after a crash |
75 | 76 |
|
76 | | -If Azure Data Studio crashes unexpectedly, restarting Azure Data Studio should reopen any unsaved editor files as well. If they do not, there may have been an error trying to reopen them. In that case, follow these steps to navigate to the folder containing the backups where you can manually open them to recover their contents. |
| 77 | +If Azure Data Studio crashes unexpectedly, restarting Azure Data Studio should reopen any unsaved editor files as well. If they don't, there may have been an error trying to reopen them. In that case, follow these steps to navigate to the folder containing the backups where you can manually open them to recover their contents. |
77 | 78 |
|
78 | | -1. Run the `Developer: Open User Data Folder` command in Azure Data Studio from the **Command Palette** (**Ctrl/Cmd + Shift + P**). |
79 | | -2. In the folder that opens, navigate to the `Backups` folder. |
| 79 | +1. From the **Command Palette** (**Ctrl/Cmd + Shift + P**), run the **Developer: Open User Data Folder** command. |
| 80 | +1. In the folder that opens, navigate to the `Backups` folder. |
80 | 81 |
|
81 | | -This will contain folders with randomly generated names. Within these folders will be files that contain the editor backups (which will include some additional metadata along with their text contents). |
| 82 | +This contains folders with randomly generated names. Within these folders are files that contain the editor backups (which include some additional metadata along with their text contents). |
82 | 83 |
|
| 84 | +## Next steps |
83 | 85 |
|
84 | | -## Next Steps |
85 | 86 | - [Report an issue](https://github.com/Microsoft/azuredatastudio/issues) |
86 | 87 | - [What is Azure Data Studio](what-is-azure-data-studio.md) |
0 commit comments