sql-server-samples/samples/manage/sql-assessment-api/notebooks/SQLAssessmentAPITutorialNotebook.ipynb

SQL Assessment API Tutorial

You can use this tutorial to understand how to assess your SQL Server configuration for best practices. In this tutorial, you will learn:

1. How to install PowerShell SqlServer module that includes SQL Assessment API cmdlets.
2. How to assess your SQL Server and databases
3. How to save results in a sql table and graph over results
4. How to customize rules by disabling some rules, adding new ones, and changing thresholds

Supported products and platforms: SQL Server 2012 and up, both on Windows and Linux. Azure SQL DB Managed Instance. More products to come.

Microsoft ruleset (config.json) is published on SQL Assessment API GitHub repo and continuously improved.

Useful links at the bottom of the tutorial.

Quick primer on cmdlets

There are two cmdlets:

1. Get-SqlAssessmentItem shows a list of available rules for a given object (instance, database). Every rule has a target that describes what kind of SQL objects this rule applies to: SQL Server version, SQL Server platform, SQL Server engine edition. So by the availability of a rule, we mean that when you run Get-SqlAssessmentItem or Invoke-SqlAssessment, the API first verifies what rules aplly for the given object.

2. Invoke-SqlAssessment performs an assessment of a passed object and provides the results.

1. Setup

You need to install PowerShell SqlServer module using the following command. It is a good practice to run Import-Module at the beginning of your session as well. Get-Module will show you the version you have installed. The minimum version you want is 21.1.18206 (SQL Assessment API GA).

In [4]:

# Uncomment and run Install-Module only the first time 
# Install-Module -Name SqlServer -AllowClobber -Force
Import-Module -Name SqlServer
Get-Module

2. Invoke an assessment (SQL Server instance)

There are various ways to run the assessment cmdlet. The following statements give recommendations for local default instance. Pick whatever style works for your script.

In [6]:

# Option 1
Get-SqlInstance -ServerInstance 'localhost' | Invoke-SqlAssessment

In [8]:

# Option 2
$serverInstance = Get-SqlInstance -ServerInstance 'localhost'
Invoke-SqlAssessment $serverInstance

In [10]:

# Option 3
Get-Item SQLSERVER:\SQL\localhost\default | Invoke-SqlAssessment

In [12]:

# Option 4
Invoke-SqlAssessment SQLSERVER:\SQL\localhost\default

In [14]:

# Option 5
cd SQLSERVER:\SQL\localhost\default
Invoke-SqlAssessment -Verbose

In [16]:

# Option 6
cd SQLSERVER:\SQL\localhost
Get-Item default | Invoke-SqlAssessment

3. Invoke an assessment (SQL Server database)

You need to run Invoke-SqlAssessment against a database object to get database specific recommendations. Again, there are various ways of accomplishing this. Below are some examples.

In [18]:

# Option 1
$database = Get-SqlDatabase -ServerInstance 'localhost' -Name master
Invoke-SqlAssessment $database -Verbose

In [20]:

# Option 2
Invoke-SqlAssessment SQLSERVER:\SQL\localhost\default\Databases\master -Verbose

In [22]:

# Option 3
cd SQLSERVER:\SQL\localhost\default\Databases\master
Invoke-SqlAssessment

In [26]:

# Get recommendations for all databases on local instance:
Get-SqlDatabase -ServerInstance 'localhost' | Invoke-SqlAssessment -Verbose

4. Browse applicable rules

The full Microsoft ruleset is in config.json in the GitHub repo. If you want to list the rules that apply to a particular instance or database, you can use Get-SqlAssessmentItem cmdlet. Below are some different ways of listing the rules.

In [28]:

# Get all rules available for an object:
$serverInstance = Get-SqlInstance -ServerInstance 'localhost'
Get-SqlAssessmentItem $serverInstance | Select ID, Description | Format-Table

In [30]:

# Get all rules by a specific tag
$serverInstance = Get-SqlInstance -ServerInstance 'localhost'
Get-SqlAssessmentItem $serverInstance -Check TraceFlag

5. Run a specific rule

If you want to check a particular rule (maybe after you fixed it), you can run it by its name. You can also specify several rules in the –Check parameter, just delimit them by commas.

Every rule in the default ruleset has tags to group them into logical sets. In the example below, we look for backup related issues only. Backup value used for the –Check parameter is a tag. You can use both rule names and tags at the same time in a comma delimited list.

In [32]:

# Run a rule by its name
$serverInstance = Get-SqlInstance -ServerInstance 'localhost'
Invoke-SqlAssessment $serverInstance -Check TF634

In [36]:

# Run a group of rules using their tag
$database = Get-SqlDatabase -ServerInstance 'localhost' 
Invoke-SqlAssessment $database -Check Backup

6. Store results in a table

You probably want to save the results of an assessment to analyze and process later on. You can pipe the results of Invoke-SqlAssessment cmdlet into a table using Write-SqlTableData cmdlet. If the table doesn't exist, it creates the table and then inserts the results. If the table exists (subsequent runs), it appends the results to the table. Just remember to use -FlattenOutput parameter as it makes the Invoke-SqlAssessment output sutiable for Write-SqlTableData.

In [38]:

Get-SqlInstance -ServerInstance 'localhost' | Invoke-SqlAssessment -FlattenOutput |
Write-SqlTableData -ServerInstance 'localhost' -DatabaseName SQLAssessmentDemo -SchemaName Assessment -TableName Results -Force

Customization

In this section you will learn how to customize existing rules and create new ones.

You need to grab the json files in the Customization Sample JSON folder and place them in an accessible path. You need to edit the scripts below to point at the right path and server instance for your environment.

Disabling/Enabling rules

In [40]:

# Setup two parameters that are used in all the customization examples below
# $binariesPath="<replace this with the path to customization sample json files>"
$binariesPath="C:\Users\ebrue\OneDrive - Microsoft\Monitoring\API\Custimization Sample JSON"
$serverInstance = Get-SqlInstance -ServerInstance 'localhost'

In [74]:

# Disable a single rule using its ID (TF634)
# To see this in action, make sure you have trace flag 634 turned on in the instance you are testing. Otherwise this rule will not fire even when enabled.
# You will see that TF634 is not enabled (On=False)
Get-SqlAssessmentItem $serverInstance -Configuration $(join-path $binariesPath "DisableTF634.json")

In [76]:

# Disable all Trace Flag rules using a tag
# You will see that all TF rules are set to False (disabled)
Get-SqlAssessmentItem $serverInstance -Configuration $(join-path $binariesPath "DisableAllTF.json")

In [80]:

# Combine configurations
# This example disables all trace flag rules except for performance related ones using tags. 
# The order of json files is important. First we disable all TF rules, then enable performance rules which re-enables performance related TF rules.
Get-SqlAssessmentItem $serverInstance -Configuration $(join-path $binariesPath "DisableAllTF.json"), $(join-path $binariesPath "EnablePerformance.json")

Creating a new rule

The rules are defined in json files. In this example, we are creating a rule that checks for available database space. Go ahead and examine CustomRuleTSQLProbe.json.

A rule has many components such as which ruleset it belongs to, what type of objects, editions, versions, platforms it targets as well as more obvious components such as id, name, description, etc.

Condition is what gets evaluated. When an expression in Condition returns false, it means that the rule is violated and the user gets a recommendation from this rule.

Probe is what gets the data to be evaluated in the condition. Probes can be SQL or CLR. SQL probe is a T-SQL query to pull the required data right out of SQL Server. CLR probe is a reference to a .NET or Core assembly with a call to a method inside the library.

In [66]:

# Create new rule with TSQL probe
# This rule applies to databases and uses a TSQL statement to get the data for the rule. 
$database = Get-SqlDatabase -ServerInstance 'localhost' -Name master
Invoke-SqlAssessment $database -configuration $(join-path $binariesPath "CustomRuleTSQLProbe.json")

In [68]:

# Override threshold parameter
# CustomRuleThresholdChange.json defines a new threshold value for DBSpaceAvailable rule created above
$database = Get-SqlDatabase -ServerInstance 'localhost' -Name master
Invoke-SqlAssessment $database -configuration $(join-path $binariesPath "CustomRuleTSQLProbe.json"),$(join-path $binariesPath "CustomRuleThresholdChange.json")

Managed code probe

In [70]:

# Create a new rule with CLR probe
# !!! You need to set the path to the dll in CustomRuleCLRProbe.json file first
Invoke-SqlAssessment $serverInstance -configuration $(join-path $binariesPath "CustomRuleCLRProbe.json")

Useful links about SQL Assessment API

• Docs online page
• GitHub repo
• SQL Server blog with release announcements and other useful information