Troubleshooting SQL Server made easy via Notebooks – seeking your feedback

Published Sep 21 2021 09:35 PM 1,319 Views
Microsoft

As part of our journey in making troubleshooting experience easier for our customers, we have learned from our research and studies, that Jupyter Notebook is a great way to do this.  Code and documentation can be in one place, which boosts users’ workflow. To continue in this effort, we are currently experimenting with SQL Server DOCs articles that are rich with code snippets. These articles are ideal for executable troubleshooting guides in Jupyter Notebook format that can be launched, edited and executed directly in Azure Data Studio client tool, i.e. less copying and pasting!

 

To illustrate the new experience, a database administrator, Gloria, searches online on how to troubleshoot SQL Server Error 9002. She finds an article such as Troubleshooting a Full Transaction Log (SQL Server Error 9002) which shows an [Open Notebook in Azure Data Studio] button. Clicking on the button will allow Gloria to launch a Jupyter Notebook equivalent to the article, in order to troubleshoot SQL Server Error 9002 in Azure Data Studio.

 

JosephPilov_0-1632284862665.png

 

This allows Gloria then to read through the description about the error in the notebook, and then execute the code cells to start diagnosing. No copy and pasting!

 

JosephPilov_1-1632284909180.png

 

Articles with troubleshooting notebooks (Preview)

To try out this new Docs to Jupyter Notebooks experience, check out these two articles. In these articles, you can click on “Open Notebook in Azure Data Studio” which will launch the equivalent notebook for the article. Please note that you will need to have Azure Data Studio installed on your local machine first (http://aka.ms/getAzureDataStudio).

 

These articles were selected for this experimentation phase due to high frequency of these problems being reported to Microsoft CSS.

 

Seeking feedback

What are your thoughts on this experience? Please vote on this Github item and provide comments so we can improve the experience further. [Seeking Feedback] From SQL Server docs articles to notebooks in Azure Data Studio · Issue #16648


For more information on what the expected experience looks like, watch the animated gifs below:

 

Launching and running a SQL Notebook in Azure Data Studio

 

9002article.gif

 

 

 

 

Launching and running a PowerShell Notebook in Azure Data Studio

 

35250article.gif

 

Learn more

 

 

 

 

1 Comment
Deleted
Not applicable

That looks really nice :)

Do you have a nice solution when my admin-account does not have internet acces, and I am reading the online documentation with another (office) account?

I might end up with some copy-paste or download-open in this situation.

But still I like the concept - specially for trouble-shooting. 

%3CLINGO-SUB%20id%3D%22lingo-sub-2772504%22%20slang%3D%22en-US%22%3ETroubleshooting%20SQL%20Server%20made%20easy%20via%20Notebooks%20%E2%80%93%20seeking%20your%20feedback%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2772504%22%20slang%3D%22en-US%22%3E%3CP%3EAs%20part%20of%20our%20journey%20in%20making%20troubleshooting%20experience%20easier%20for%20our%20customers%2C%20we%20have%20learned%20from%20our%20research%20and%20studies%2C%20that%20Jupyter%20Notebook%20is%20a%20great%20way%20to%20do%20this.%26nbsp%3B%20Code%20and%20documentation%20can%20be%20in%20one%20place%2C%20which%20boosts%20users%E2%80%99%20workflow.%20To%20continue%20in%20this%20effort%2C%20we%20are%20currently%20experimenting%20with%20%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Fsql%2Fsql-server%2F%22%20target%3D%22_self%22%20rel%3D%22noopener%20noreferrer%22%3ESQL%20Server%20DOCs%3C%2FA%3E%20articles%20that%20are%20rich%20with%20code%20snippets.%20These%20articles%20are%20ideal%20for%20executable%20troubleshooting%20guides%20in%20Jupyter%20Notebook%20format%20that%20can%20be%20launched%2C%20edited%20and%20executed%20directly%20in%20%3CA%20href%3D%22https%3A%2F%2Fazure.microsoft.com%2Fen-us%2Fservices%2Fdeveloper-tools%2Fdata-studio%2F%23overview%22%20target%3D%22_self%22%20rel%3D%22noopener%20noreferrer%22%3EAzure%20Data%20Studio%3C%2FA%3E%26nbsp%3Bclient%20tool%2C%20i.e.%26nbsp%3B%3CSTRONG%3E%3CEM%3Eless%20copying%20and%20pasting!%3C%2FEM%3E%3C%2FSTRONG%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3ETo%20illustrate%20the%20new%20experience%2C%20a%20database%20administrator%2C%20Gloria%2C%20searches%20online%20on%20how%20to%20troubleshoot%20SQL%20Server%20Error%209002.%20She%20finds%20an%20article%20such%20as%20%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Fsql%2Frelational-databases%2Flogs%2Ftroubleshoot-a-full-transaction-log-sql-server-error-9002%22%20target%3D%22_self%22%20rel%3D%22noopener%20noreferrer%22%3ETroubleshooting%20a%20Full%20Transaction%20Log%20(SQL%20Server%20Error%209002)%3C%2FA%3E%20which%20shows%20an%20%5BOpen%20Notebook%20in%20Azure%20Data%20Studio%5D%20button.%20Clicking%20on%20the%20button%20will%20allow%20Gloria%20to%20launch%20a%20Jupyter%20Notebook%20equivalent%20to%20the%20article%2C%20in%20order%20to%20troubleshoot%20SQL%20Server%20Error%209002%20in%20Azure%20Data%20Studio.%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%3CSPAN%20class%3D%22lia-inline-image-display-wrapper%20lia-image-align-inline%22%20image-alt%3D%22JosephPilov_0-1632284862665.png%22%20style%3D%22width%3A%20999px%3B%22%3E%3CIMG%20src%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fimage%2Fserverpage%2Fimage-id%2F311953i8217E21D33BC0400%2Fimage-size%2Flarge%3Fv%3Dv2%26amp%3Bpx%3D999%22%20role%3D%22button%22%20title%3D%22JosephPilov_0-1632284862665.png%22%20alt%3D%22JosephPilov_0-1632284862665.png%22%20%2F%3E%3C%2FSPAN%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EThis%20allows%20Gloria%20then%20to%20read%20through%20the%20description%20about%20the%20error%20in%20the%20notebook%2C%20and%20then%20execute%20the%20code%20cells%20to%20start%20diagnosing.%20No%20copy%20and%20pasting!%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%3CSPAN%20class%3D%22lia-inline-image-display-wrapper%20lia-image-align-inline%22%20image-alt%3D%22JosephPilov_1-1632284909180.png%22%20style%3D%22width%3A%20999px%3B%22%3E%3CIMG%20src%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fimage%2Fserverpage%2Fimage-id%2F311954i98620234D5F0A999%2Fimage-size%2Flarge%3Fv%3Dv2%26amp%3Bpx%3D999%22%20role%3D%22button%22%20title%3D%22JosephPilov_1-1632284909180.png%22%20alt%3D%22JosephPilov_1-1632284909180.png%22%20%2F%3E%3C%2FSPAN%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CH2%20id%3D%22toc-hId--350658759%22%20id%3D%22toc-hId--350658693%22%20id%3D%22toc-hId--350658693%22%20id%3D%22toc-hId--350658693%22%20id%3D%22toc-hId--350658693%22%3EArticles%20with%20troubleshooting%20notebooks%20(Preview)%3C%2FH2%3E%0A%3CP%3ETo%20try%20out%20this%20new%20Docs%20to%20Jupyter%20Notebooks%20experience%2C%20check%20out%20these%20two%20articles.%20In%20these%20articles%2C%20you%20can%20click%20on%20%E2%80%9COpen%20Notebook%20in%20Azure%20Data%20Studio%E2%80%9D%20which%20will%20launch%20the%20equivalent%20notebook%20for%20the%20article.%20Please%20note%20that%20you%20will%20need%20to%20have%20Azure%20Data%20Studio%20installed%20on%20your%20local%20machine%20first%20(%3CA%20href%3D%22http%3A%2F%2Faka.ms%2FgetAzureDataStudio%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3Ehttp%3A%2F%2Faka.ms%2FgetAzureDataStudio%3C%2FA%3E).%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CUL%3E%0A%3CLI%3E%3CA%20href%3D%22https%3A%2F%2Fnam06.safelinks.protection.outlook.com%2F%3Furl%3Dhttps%253A%252F%252Fdocs.microsoft.com%252Fsql%252Frelational-databases%252Flogs%252Ftroubleshoot-a-full-transaction-log-sql-server-error-9002%253F%26amp%3Bdata%3D04%257C01%257Cjukoesma%2540microsoft.com%257C312055300a0b48a618af08d95c27c6df%257C72f988bf86f141af91ab2d7cd011db47%257C1%257C0%257C637642148186786862%257CUnknown%257CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%253D%257C1000%26amp%3Bsdata%3DqDdMt7uZlIWd%252B4lA86twu208J%252Fg7BvD9%252Frgir%252Fl8A1w%253D%26amp%3Breserved%3D0%22%20target%3D%22_blank%22%20rel%3D%22noopener%20nofollow%20noreferrer%22%3ETroubleshoot%20full%20transaction%20log%20error%209002%20-%20SQL%20Server%20%7C%20Microsoft%20Docs%3C%2FA%3E%3C%2FLI%3E%0A%3CLI%3E%3CA%20href%3D%22https%3A%2F%2Fnam06.safelinks.protection.outlook.com%2F%3Furl%3Dhttps%253A%252F%252Fdocs.microsoft.com%252Fsql%252Frelational-databases%252Ferrors-events%252Fmssqlserver-35250-database-engine-error%26amp%3Bdata%3D04%257C01%257Cjukoesma%2540microsoft.com%257C312055300a0b48a618af08d95c27c6df%257C72f988bf86f141af91ab2d7cd011db47%257C1%257C0%257C637642148186776896%257CUnknown%257CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%253D%257C1000%26amp%3Bsdata%3DwP5hJigPDkg4eJHvxl0QbeAjYLRpKjhCInIW1%252BDFUTg%253D%26amp%3Breserved%3D0%22%20target%3D%22_blank%22%20rel%3D%22noopener%20nofollow%20noreferrer%22%3EMSSQLSERVER_35250%20-%20SQL%20Server%20%7C%20Microsoft%20Docs%3C%2FA%3E%3C%2FLI%3E%0A%3C%2FUL%3E%0A%3CP%3EThese%20articles%20were%20selected%20for%20this%20experimentation%20phase%20due%20to%20high%20frequency%20of%20these%20problems%20being%20reported%20to%20Microsoft%20CSS.%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CH2%20id%3D%22toc-hId-2136854074%22%20id%3D%22toc-hId-2136854140%22%20id%3D%22toc-hId-2136854140%22%20id%3D%22toc-hId-2136854140%22%20id%3D%22toc-hId-2136854140%22%3ESeeking%20feedback%3C%2FH2%3E%0A%3CP%3EWhat%20are%20your%20thoughts%20on%20this%20experience%3F%20Please%20vote%20on%20this%20Github%20item%20and%20provide%20comments%20so%20we%20can%20improve%20the%20experience%20further.%20%3CA%20href%3D%22https%3A%2F%2Fnam06.safelinks.protection.outlook.com%2F%3Furl%3Dhttps%253A%252F%252Fgithub.com%252Fmicrosoft%252Fazuredatastudio%252Fissues%252F16648%26amp%3Bdata%3D04%257C01%257Cjukoesma%2540microsoft.com%257C312055300a0b48a618af08d95c27c6df%257C72f988bf86f141af91ab2d7cd011db47%257C1%257C0%257C637642148186806768%257CUnknown%257CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%253D%257C1000%26amp%3Bsdata%3D9rXgDzOCKnne7sOslZrFZVFYDeeIFOuYF0rzOEdSIUI%253D%26amp%3Breserved%3D0%22%20target%3D%22_blank%22%20rel%3D%22noopener%20nofollow%20noreferrer%22%3E%5BSeeking%20Feedback%5D%20From%20SQL%20Server%20docs%20articles%20to%20notebooks%20in%20Azure%20Data%20Studio%20%C2%B7%20Issue%20%2316648%3C%2FA%3E%3C%2FP%3E%0A%3CP%3E%3CBR%20%2F%3EFor%20more%20information%20on%20what%20the%20expected%20experience%20looks%20like%2C%20watch%20the%20animated%20gifs%20below%3A%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%3CSTRONG%3ELaunching%20and%20running%20a%20SQL%20Notebook%20in%20Azure%20Data%20Studio%3C%2FSTRONG%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%3CSPAN%20class%3D%22lia-inline-image-display-wrapper%20lia-image-align-inline%22%20image-alt%3D%229002article.gif%22%20style%3D%22width%3A%20747px%3B%22%3E%3CIMG%20src%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fimage%2Fserverpage%2Fimage-id%2F312134i27EFE244979B1ED3%2Fimage-size%2Flarge%3Fv%3Dv2%26amp%3Bpx%3D999%22%20role%3D%22button%22%20title%3D%229002article.gif%22%20alt%3D%229002article.gif%22%20%2F%3E%3C%2FSPAN%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%3CSTRONG%3ELaunching%20and%20running%20a%20PowerShell%20Notebook%20in%20Azure%20Data%20Studio%3C%2FSTRONG%3E%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%3CSTRONG%3E%3CSPAN%20class%3D%22lia-inline-image-display-wrapper%20lia-image-align-inline%22%20image-alt%3D%2235250article.gif%22%20style%3D%22width%3A%20999px%3B%22%3E%3CIMG%20src%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fimage%2Fserverpage%2Fimage-id%2F312137iC894DADD2E50C447%2Fimage-size%2Flarge%3Fv%3Dv2%26amp%3Bpx%3D999%22%20role%3D%22button%22%20title%3D%2235250article.gif%22%20alt%3D%2235250article.gif%22%20%2F%3E%3C%2FSPAN%3E%3C%2FSTRONG%3E%3C%2FP%3E%0A%3CH2%20id%3D%22toc-hId-329399611%22%20id%3D%22toc-hId-329399677%22%20id%3D%22toc-hId-329399677%22%20id%3D%22toc-hId-329399677%22%20id%3D%22toc-hId-329399677%22%3E%26nbsp%3B%3C%2FH2%3E%0A%3CH2%20id%3D%22toc-hId--1478054852%22%20id%3D%22toc-hId--1478054786%22%20id%3D%22toc-hId--1478054786%22%20id%3D%22toc-hId--1478054786%22%20id%3D%22toc-hId--1478054786%22%3ELearn%20more%3C%2FH2%3E%0A%3CUL%3E%0A%3CLI%3E%3CA%20href%3D%22https%3A%2F%2Fazure.microsoft.com%2Fen-us%2Fservices%2Fdeveloper-tools%2Fdata-studio%2F%23features%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EWhat%20is%20Azure%20Data%20Studio%3F%3C%2FA%3E%3C%2FLI%3E%0A%3CLI%3E%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Fsql%2Fazure-data-studio%2Fnotebooks%2Fnotebooks-guidance%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3EJupyter%20Notebooks%20in%20Azure%20Data%20Studio%3C%2FA%3E%3C%2FLI%3E%0A%3C%2FUL%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-TEASER%20id%3D%22lingo-teaser-2772504%22%20slang%3D%22en-US%22%3E%3CP%3EWhat%20if%20you%20have%20the%20ability%20to%20open%20your%20favorite%20troubleshooting%20DOC%20in%20a%20format%20where%20you%20execute%20all%20the%20code%20snippets%20directly%3F%20Give%20us%20your%20feedback%3C%2FP%3E%3C%2FLINGO-TEASER%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2798188%22%20slang%3D%22en-US%22%3ERe%3A%20Troubleshooting%20SQL%20Server%20made%20easy%20via%20Notebooks%20%E2%80%93%20seeking%20your%20feedback%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2798188%22%20slang%3D%22en-US%22%3E%3CP%3EThat%20looks%20really%20nice%20%3A)%3C%2Fimg%3E%3C%2FP%3E%3CP%3EDo%20you%20have%20a%20nice%20solution%20when%20my%20admin-account%20does%20not%20have%20internet%20acces%2C%20and%20I%20am%20reading%20the%20online%20documentation%20with%20another%20(office)%20account%3F%3C%2FP%3E%3CP%3EI%20might%20end%20up%20with%20some%20copy-paste%20or%20download-open%20in%20this%20situation.%3C%2FP%3E%3CP%3EBut%20still%20I%20like%20the%20concept%20-%20specially%20for%20trouble-shooting.%26nbsp%3B%3C%2FP%3E%3C%2FLINGO-BODY%3E
Co-Authors
Version history
Last update:
‎Sep 22 2021 10:01 AM
Updated by: