Skip to content

Commit 6ed1ece

Browse files
committed
Add Navigation section and Back to top links
1 parent 2ee15e7 commit 6ed1ece

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
11
# SQL Server First Responder Kit
2+
<a name="header1"></a>
23
[![licence badge]][licence]
34
[![stars badge]][stars]
45
[![forks badge]][forks]
56
[![issues badge]][issues]
67

8+
Navigation
9+
- [How to Get Support](#how-to-get-support)
10+
- [sp_Blitz: Overall Health Check](#sp_blitz-overall-health-check)
11+
- [Advanced sp_Blitz Parameters](#advanced-sp_blitz-parameters)
12+
- [Writing sp_Blitz Output to a Table](#writing-sp_blitz-output-to-a-table)
13+
- [Skipping Checks or Databases](#skipping-checks-or-databases)
14+
- [sp_BlitzCache: Find the Most Resource-Intensive Queries](#sp_blitzcache-find-the-most-resource-intensive-queries)
15+
- [Advanced sp_BlitzCache Parameters](#advanced-sp_blitzcache-parameters)
16+
- [sp_BlitzIndex: Tune Your Indexes](#sp_blitzindex-tune-your-indexes)
17+
- [Advanced sp_BlitzIndex Parameters](#advanced-sp_blitzindex-parameters)
18+
- [sp_BlitzFirst: Real-Time Performance Advice](#sp_blitzfirst-real-time-performance-advice)
19+
- [Advanced sp_BlitzFirst Parameters](#advanced-sp_blitzfirst-parameters)
20+
- [Parameters Common to Many of the Stored Procedures](#parameters-common-to-many-of-the-stored-procedures)
21+
- [License MIT](#license)
22+
723
You're a DBA, sysadmin, or developer who manages Microsoft SQL Servers. It's your fault if they're down or slow. These tools help you understand what's going on in your server.
824

925
* When you want an overall health check, run [sp_Blitz](#sp_blitz-overall-health-check).
@@ -15,8 +31,8 @@ To install, [download the latest release ZIP](https://github.com/BrentOzarULTD/S
1531

1632
Only Microsoft-supported versions of SQL Server are supported here - sorry, 2005 and 2000. Some of these may work some of the time on 2005, but no promises, and don't file a support issue when they fail. (For example, we know the output tables won't work on SQL 2005 because one of the output fields is a DATETIMEOFFSET datatype, which isn't available in 2005.)
1733

18-
## How to Get Support
1934

35+
## How to Get Support
2036
Everyone here is expected to abide by the [Contributor Covenant Code of Conduct](CONTRIBUTING.md#the-contributor-covenant-code-of-conduct).
2137

2238
Want to talk to the developers? [Get an invite to SQLCommunity.slack.com](https://sqlps.io/slack/), and we're in the [#FirstResponderKit channel](https://sqlcommunity.slack.com/messages/firstresponderkit/).
@@ -25,8 +41,10 @@ Got a question? Ask it on [DBA.StackExchange.com](http://dba.stackexchange.com).
2541

2642
Want to contribute by writing, testing, or documenting code, or suggesting a new check? [Read the contributing.md file](CONTRIBUTING.md).
2743

28-
## sp_Blitz: Overall Health Check
44+
[*Back to top*](#header1)
45+
2946

47+
## sp_Blitz: Overall Health Check
3048
Run sp_Blitz daily or weekly for an overall health check. Just run it from SQL Server Management Studio, and you'll get a prioritized list of issues on your server right now:
3149

3250
![sp_Blitz](http://u.brentozar.com/github-images/sp_Blitz.png)
@@ -46,10 +64,14 @@ Commonly used parameters:
4664
* @CheckServerInfo = 1 - includes additional rows at priority 250 with server configuration details like service accounts.
4765
* @IgnorePrioritiesAbove = 50 - if you want a daily bulletin of the most important warnings, set @IgnorePrioritiesAbove = 50 to only get the urgent stuff.
4866

67+
[*Back to top*](#header1)
68+
4969
### Advanced sp_Blitz Parameters
5070

5171
In addition to the [parameters common to many of the stored procedures](#parameters-common-to-many-of-the-stored-procedures), here are the ones specific to sp_Blitz:
5272

73+
[*Back to top*](#header1)
74+
5375
#### Writing sp_Blitz Output to a Table
5476

5577
```SQL
@@ -58,6 +80,8 @@ sp_Blitz @OutputDatabaseName = 'DBAtools', @OutputSchemaName = 'dbo', @OutputTab
5880

5981
Checks for the existence of a table DBAtools.dbo.BlitzResults, creates it if necessary, then adds the output of sp_Blitz into this table. This table is designed to support multiple outputs from multiple servers, so you can track your server's configuration history over time.
6082

83+
[*Back to top*](#header1)
84+
6185
#### Skipping Checks or Databases
6286

6387
```SQL
@@ -78,48 +102,69 @@ Checks for the existence of a table named Fred - just kidding, named DBAtools.db
78102
* If both DatabaseName and CheckID are populated, then that check will be skipped for that database
79103
* If CheckID is populated but DatabaseName is null, then that check will be skipped for all databases
80104

105+
[*Back to top*](#header1)
106+
81107

82108
## sp_BlitzCache: Find the Most Resource-Intensive Queries
83109

84110
(stub - describe the big picture here)
85111

112+
[*Back to top*](#header1)
113+
86114
### Advanced sp_BlitzCache Parameters
87115

88116
In addition to the [parameters common to many of the stored procedures](#parameters-common-to-many-of-the-stored-procedures), here are the ones specific to sp_BlitzCache:
89117

90118
(stub - describe the lesser-used stuff)
91119

120+
[*Back to top*](#header1)
121+
122+
92123
## sp_BlitzIndex: Tune Your Indexes
93124

94125
(stub - describe the big picture here)
95126

127+
[*Back to top*](#header1)
128+
96129
### Advanced sp_BlitzIndex Parameters
97130

98131
In addition to the [parameters common to many of the stored procedures](#parameters-common-to-many-of-the-stored-procedures), here are the ones specific to sp_BlitzIndex:
99132

100133
(stub - describe the lesser-used stuff)
101134

135+
[*Back to top*](#header1)
136+
137+
102138
## sp_BlitzFirst: Real-Time Performance Advice
103139

104140
(stub - describe the big picture here)
105141

142+
[*Back to top*](#header1)
143+
106144
### Advanced sp_BlitzFirst Parameters
107145

108146
In addition to the [parameters common to many of the stored procedures](#parameters-common-to-many-of-the-stored-procedures), here are the ones specific to sp_BlitzFirst:
109147

110148
(stub - describe the lesser-used stuff)
111149

150+
[*Back to top*](#header1)
151+
152+
112153
## Parameters Common to Many of the Stored Procedures
113154

114155
* @Help = 1 - returns a result set or prints messages explaining the stored procedure's input and output. Make sure to check the Messages tab in SSMS to read it.
115156
* @ExpertMode = 1 - turns on more details useful for digging deeper into results.
116157
* @OutputDatabaseName, @OutputSchemaName, @OutputTableName - pass all three of these in, and the stored proc's output will be written to a table. We'll create the table if it doesn't already exist.
117158
* @OutputServerName - not functional yet. To track (or help!) implementation status: https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/issues/293
118159

160+
[*Back to top*](#header1)
161+
162+
119163
## License
120164

121165
[The SQL Server First Responder Kit uses the MIT License.](LICENSE.md)
122166

167+
[*Back to top*](#header1)
123168

124169
[licence badge]:https://img.shields.io/badge/license-MIT-blue.svg
125170
[stars badge]:https://img.shields.io/github/stars/BrentOzarULTD/SQL-Server-First-Responder-Kit.svg

0 commit comments

Comments
 (0)