dbachecks

dbachecks is a framework created by and for SQL Server pros who need to validate their environments. Basically, we all share similar checklists and mostly just the server names and RPO/RTO/etc change.

This open source module allows us to crowd-source our checklists using Pester tests. Such checks include:

Backups are being performed
Identity columns are not about to max out
Servers have access to backup paths
Database integrity checks are being performed and corruption does not exist
Disk space is not about to run out
All enabled jobs have succeeded

Have questions about development? Please visit our Wiki. Anyone developing this module should visit that Wiki page (after fully reading this readme) for a brief overview.

Build Status

	Development Branch Build - Unit testing Click Here
	Master Branch Build - Module version update and Code Signing Click Here
	Master Branch Release - Release to PowerShell Gallery Click Here

Want to know how our CD process works? Read this blog post and see how the team manage it

Prerequisites

Client requirements

PowerShell 4+ is required.
Automatic installation of the dependent modules will only be provided via the PowerShell Gallery.

When you install from the Gallery, it'll auto-install:

dbatools
Pester
PSFramework

When you import, it'll auto-import

dbatools
Pester
PSFramework

If you have already installed the module and you update it, you may be required to update the Pester or the PSFramework modules before it will import. If you see a message like

Then you need to

Install-Module Pester -SkipPublisherCheck -Force
Import-Module Pester -Force

You may need to do the same thing for the PSFramework or dbatools modules also

SQL requirements

dbachecks uses dbatools for most of it's data gathering so it supports SQL Versions from SQL 2000 to SQL vNext including SQL running on Linux. (dbachecks will not install on PowerShell Core yet so can not be run on a Linux client) Obviously some of the Services and disk space checks will not work against instances running on Linux as they are using gWindows API calls.

Getting started

Checks are performed using Invoke-DbcCheck which is basically a wrapper for Invoke-Pester. This means that supported Invoke-Pester parameters work against Invoke-DbcCheck.

In this module, a "Check" is synonymous with a "Tag" in Pester. So you can Invoke-DbcCheck and specify a Check that you want to run. You can see a list of the available Checks with Get-DbcCheck.

Once you've decided on the Check(s) you want to run, it's time to ensure you have a list of servers to run the checks against.

Making server lists

Similar to the dbatools module, dbachecks accepts -SqlInstance and -ComputerName parameters.

Invoke-DbcCheck -SqlInstance $servers -Checks SuspectPage, LastBackup

If you have a simplified (single) environment, however, you can set a permanent list of servers. "Servers" include both SQL Server instances and Windows servers. Checks that access Windows Server (e.g. disk space checks) will utilize -ComputerName parameter. A pure SQL Server command(s) (such as the backup check) utilizes the -SqlInstance parameter.

# Set the servers you'll be working with
Set-DbcConfig -Name app.sqlinstance -Value sql2016, sql2017, sql2008, sql2008\express
Set-DbcConfig -Name app.computername -Value sql2016, sql2017, sql2008

# Look at the current configs
Get-DbcConfig

# Invoke a few tests
Invoke-DbcCheck -Checks SuspectPage, LastBackup

What it looks like

Other ways to execute checks against specific servers

Additional Invoke-DbcCheck examples:

Invoke-DbcCheck -Check Backup -SqlInstance sql2016
Invoke-DbcCheck -Check RecoveryModel -SqlInstance sql2017, sqlcluster

$sqlinstance = Get-DbaRegisteredServer -SqlInstance sql2017 -Group Express
Invoke-DbcCheck -Check Backup -SqlInstance $sqlinstance

Invoke-DbcCheck -Check Storage -ComputerName server1, server2

Check and ExcludeCheck

We tag each of our Checks using singular descriptions such as Backup, Database or Storage. You can see all the Pester related Tags using Get-DbcTagCollection or Get-DbcCheck.

Each Check generally has a few Tags but at least one Tag is unique. This allows us to essentially name a Check and using these Tags, you can either include (-Check) or Exclude (-ExcludeCheck) in your results. The Exclude will always take precedence.

For example, the Database Tag runs a number of Checks including Backup Checks. The command below will run all Database Checks except for the Backup Checks.

Invoke-DbcCheck -Check Database -ExcludeCheck Backup -SqlInstance sql2016 -SqlCredential (Get-Credential sqladmin)

All valid Pester syntax is valid for dbachecks so if you'd like to know more, you can review their documentation.

Reporting on the data

Since this is just PowerShell and Pester, results can be exported then easily converted to pretty reports. We've provided two options: Power BI and SMTP mail.

Power BI Visualizations!

We've also included a pre-built Power BI Desktop report! You can download Power BI Desktop from here or it is now offered via the Microsoft Store on Windows 10.

Note: We strongly recommend that you keep your PowerBI Desktop updated since we can add brand-new stuff that appears on the most recent releases.

To use the Power BI report, pipe the results of Invoke-DbcCheck to Update-DbcPowerBiDataSource (defaults to C:\Windows\temp\dbachecks), then launch the included dbachecks.pbix file using Start-DbcPowerBi. Once the Power BI report is open, just hit refresh.

# Run checks and export its JSON
Invoke-DbcCheck -SqlInstance sql2017 -Checks SuspectPage, LastBackup -Show Summary -PassThru | Update-DbcPowerBiDataSource

# Launch Power BI then hit refresh
Start-DbcPowerBi

The above report uses Update-DbcPowerBiDataSource's -Environment parameter.

# Run checks and export its JSON
Invoke-DbcCheck -SqlInstance $prod -Checks LastBackup -Show Summary -PassThru | 
Update-DbcPowerBiDataSource -Environment Prod

😍😍😍

Sending mail

We even included a command to make emailing the results easier!

$ouputDirectory = (Get-DbcConfigValue -Name app.maildirectory)
$filename = $outputDirectory + '\file.xml'
Invoke-Dbccheck -OutputFile $fileName -OutputFormat NunitXML

$outputpath = $ouputDirectory + "\index.html"
$reportunit = "ModulePath\bin\ReportUnit.exe"
& $reportunit $ouputDirectory

$htmlbody = Get-Content -Path $outputpath -ErrorAction SilentlyContinue | Out-String

Send-MailMessage -To clemaire@dbatools.io -From nobody@dbachecks.io -SMTP smtp.ad.local -body $htmlbody

If you'd like to test locally, check out PaperCut which is just a quick email viewer that happens to have a built-in SMTP server. It provides awesome, built-in functionality so you can send the reports!

Advanced usage

Skipping some internal tests

The Check LastGoodCheckDb includes a test for data purity. You may be in an environment that can't support data purity. If this check needs to be skipped, you can do the following:

Get-DbcConfig *skip*
Set-DbcConfig -Name skip.dbcc.datapuritycheck -Value $true

Need to skip a whole test? Just use the -ExcludeCheck which is auto-populated with both Check names and Pester Tags.

Setting a global SQL Credential

Set-DbcConfig persists the values. If you Set-DbcConfig -Name app.sqlcredential -Value (Get-Credential sa) it will set the SqlCredential for the whole module, but not your local console! So cool.

You can also manually change the SqlCredential or Credential by specifying it in Invoke-DbaCheck:

Invoke-DbaCheck -SqlInstance sql2017 -SqlCredential (Get-Credential sqladmin) -Check MaxMemory

Manipulating the underlying commands

You can also modify the parameters of the actual command that's being executed:

Set-Variable -Name PSDefaultParameterValues -Value @{ 'Get-DbaDiskSpace:ExcludeDrive' = 'C:\' } -Scope Global
Invoke-DbcCheck -Check Storage

Can I run tests not included the module?

If you have super specialized checks to run, you can add a new repository, update the app.checkrepos config and this will make all of your tests available to Invoke-DbcCheck. From here, you can pipe to Send-DbcMailMessage, Update-DbcPowerBiDataSource or parse however you would parse Pester results.

So first, add your repository

Set-DbcConfig -Name app.checkrepos -Value C:\temp\checks -Append

Then add additional checks. We recommend using the development guidelines for dbachecks.

I'd like to run my checks in SQL Server Agent

Great idea! Remember that this module requires PowerShell version 4.0, which doesn't always mesh with SQL Server's PowerShell Job Step. To run dbachecks, we recommend you use CmdExec. You can read more at dbatools.io/agent.

If you do choose to use the PowerShell step, don't forget to Set-Location somewhere outside of SQLSERVER:, otherwise, you'll get errors similar to this

I don't have access to the PowerShell Gallery, how can I download this?

This module has a number of dependencies which makes creating a GitHub-centric installer a bit of a pain. We suggest you use a machine with PowerShellGet installed and Save all the modules you need:

Save-Module -Name dbachecks, dbatools, PSFramework, Pester -Path C:\temp

Then move them to somewhere in your $env:PSModulePath, perhaps Documents\WindowsPowerShell\Modules or C:\Program Files\WindowsPowerShell\Modules.

Read more

Read more about dbachecks from a number of our original contributors!

Know of any more blog posts about dbachecks? - Please add them here.

Party

Nice work!

License

garethnewman/dbachecks

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages