mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-01-14 01:25:37 -05:00
Update read me for sample extensions (#1003)
* update readme for sample extensions * Address comments * Address comments
This commit is contained in:
@@ -1,4 +1,25 @@
|
||||
# server reports for SQL Operations Studio
|
||||
# Server reports for SQL Operations Studio
|
||||
|
||||
Welcome to **server reports** for SQL Operations Studio! Server reports give useful insights about the server.
|
||||
Welcome to **Server Reports** for SQL Operations Studio! Server Reports give useful insights about the server related to performance. These can be used to see current activity as well as historical activity. Here is a list of some of the available reports.
|
||||
|
||||
* DB Space Usage
|
||||
* DB Buffer Usage
|
||||
* CPU Utilization
|
||||
* Backup Growth Trend
|
||||
* Wait counts
|
||||
|
||||
<img src="https://github.com/Microsoft/sqlopsstudio/tree/master/samples/serverReports/images/server_reports.png" alt="Server Reports" style="width:480px;"/>
|
||||
|
||||
This extension is inspired by SQL Server Management Studio (SSMS)'s reports. We will continually add more useful server insights and tasks.
|
||||
|
||||
## Building your own reports
|
||||
This extension is also useful as a sample dashboard extension. It demonstrates building a dedicated dashboard extension with a set of insights built in. You can get started building your own reports by following the [extension authoring guide].
|
||||
|
||||
See the [Server Reports Extension Project] in the SQL Operations Studio repository on Github for the extension source code.
|
||||
|
||||
[Server Reports Extension Project]:https://github.com/Microsoft/sqlopsstudio/tree/master/samples/serverReports
|
||||
[extension authoring guide]:https://github.com/Microsoft/sqlopsstudio/wiki/Getting-started-with-Extensibility
|
||||
|
||||
|
||||
## Contributions and "thank you"
|
||||
Special thank to Paul Randal, Aaron Bertrand, and Glenn Berry for providing useful queries.
|
||||
BIN
samples/serverReports/images/server_reports.png
Normal file
BIN
samples/serverReports/images/server_reports.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
BIN
samples/serverReports/images/sqlserver.png
Normal file
BIN
samples/serverReports/images/sqlserver.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
@@ -4,10 +4,12 @@
|
||||
"description": "Server Reports",
|
||||
"version": "0.1.0",
|
||||
"publisher": "Microsoft",
|
||||
"preview": true,
|
||||
"engines": {
|
||||
"vscode": "^1.19.0",
|
||||
"vscode": "^1.17.0",
|
||||
"sqlops": "*"
|
||||
},
|
||||
"icon": "images/sqlserver.png",
|
||||
"license": "SEE LICENSE IN LICENSE.txt",
|
||||
"repository": "https://github.com/Microsoft/sqlopsstudio",
|
||||
"categories": [
|
||||
|
||||
@@ -1,19 +1,37 @@
|
||||
# sp_whoisactive for SQL Operations Studio
|
||||
|
||||
Welcome to **sp_whoisactive** for SQL Operations Studio! Sp_whoisactive is a procedure written by Adam Machanic. It is a very useful tool for activity monitoring and troubleshooting.
|
||||
Welcome to **sp_whoisactive** for SQL Operations Studio! Sp_whoisactive is a procedure written by Adam Machanic, a Microsoft MVP for SQL Server. It is a very useful tool for activity monitoring and troubleshooting. This extension provides the insights provided by this tool as graphs and tasks inside a SQL Operations Studio dashboard extension.
|
||||
|
||||
To quote one of the posts about sp_whoisactive on [Adam Machanic’s blog]:
|
||||
## Tasks and insights:
|
||||
|
||||
Here are some quick facts on Who is Active:
|
||||
<img src="https://github.com/Microsoft/sqlopsstudio/tree/master/samples/sp_whoIsActive/images/insights_section.png" alt="insights" style="width:480px;"/>
|
||||
|
||||
|
||||
## Why use sp_whoisactive?
|
||||
Here are some quick facts on Who is Active from [Adam Machanic’s blog]:
|
||||
|
||||
* Who is Active is a DMV-based monitoring stored procedure that uses **15 different views to show a large amount of data about what’s running on your server**
|
||||
* Who is Active was designed to be **extremely flexible**, and includes options to not only get different types of data, but also to change the output column list and sort order
|
||||
* Who is Active was **designed with performance in mind** at every step; users report that under normal conditions response times are generally subsecond, with slightly longer response times on servers that are extremely taxed
|
||||
* Who is Active is **compatible with all versions of SQL Server after SQL Server 2005 RTM**. It does require that the host database (generally master) is not set for SQL Server 2000 compatibility mode
|
||||
|
||||
If you haven't installed sp_whoisactive in your server, you can use "Install sp_whoisactive" task to create the procedure.
|
||||
## Documentation:
|
||||
|
||||
<img src="https://github.com/Microsoft/sqlopsstudio/tree/master/samples/sp_whoIsActive/images/documentation_section.png" alt="documentation" style="width:480px;"/>
|
||||
|
||||
If you haven't installed sp_whoisactive in your server, you can use the "Install sp_whoisactive" task to create the procedure.
|
||||
|
||||
See [sp_whoisactive Documentation] for more infomation.
|
||||
|
||||
## Building your own insights and tasks
|
||||
This extension is also useful as a sample dashboard extension. It demonstrates building a dedicated dashboard extension with a set of insights and tasks built in. You can get started building your own extension by following the [extension authoring guide].
|
||||
|
||||
See [sp_whoisactive extension project] in the SQL Operations Studio for the extension source code.
|
||||
|
||||
[Adam Machanic’s blog]:http://sqlblog.com/blogs/adam_machanic/default.aspx
|
||||
[sp_whoisactive Documentation]:http://whoisactive.com/
|
||||
[sp_whoisactive Documentation]:http://whoisactive.com/
|
||||
[sp_whoisactive extension project]:https://github.com/Microsoft/sqlopsstudio/tree/master/samples/sp_whoIsActive
|
||||
[extension authoring guide]:https://github.com/Microsoft/sqlopsstudio/wiki/Getting-started-with-Extensibility
|
||||
|
||||
## Contributions and "thank you"
|
||||
Special thank to Adam Machanic for partnering with us and make this sp_whoisactive extension possible.
|
||||
|
||||
BIN
samples/sp_whoIsActive/images/documentation_section.png
Normal file
BIN
samples/sp_whoIsActive/images/documentation_section.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
BIN
samples/sp_whoIsActive/images/insights_section.png
Normal file
BIN
samples/sp_whoIsActive/images/insights_section.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
BIN
samples/sp_whoIsActive/images/sqlserver.png
Normal file
BIN
samples/sp_whoIsActive/images/sqlserver.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
@@ -4,10 +4,12 @@
|
||||
"description": "sp_whoisactive for SQL Operations Studio",
|
||||
"version": "0.1.0",
|
||||
"publisher": "Microsoft",
|
||||
"preview": true,
|
||||
"engines": {
|
||||
"vscode": "^1.19.0",
|
||||
"vscode": "^1.17.0",
|
||||
"sqlops": "*"
|
||||
},
|
||||
"icon": "images/sqlserver.png",
|
||||
"license": "SEE LICENSE IN LICENSE.txt",
|
||||
"repository": "https://github.com/Microsoft/sqlopsstudio",
|
||||
"categories": [
|
||||
|
||||
Reference in New Issue
Block a user