commands

^

Invoke-DbaWhoIsActive

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Outputs results of Adam Machanic's sp_WhoIsActive DataTable

Description

Output results of Adam Machanic's sp_WhoIsActive

This command was built with Adam's permission. To read more about sp_WhoIsActive, please visit:

Updates: http://sqlblog.com/blogs/adam_machanic/archive/tags/who+is+active/default.aspx

Also, consider donating to Adam if you find this stored procedure helpful: http://tinyurl.com/WhoIsActiveDonate

Syntax

Invoke-DbaWhoIsActive
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object>]
    [[-Filter] <String>]
    [[-FilterType] <String>]
    [[-NotFilter] <String>]
    [[-NotFilterType] <String>]
    [-ShowOwnSpid]
    [-ShowSystemSpids]
    [[-ShowSleepingSpids] <Int32>]
    [-GetFullInnerText]
    [[-GetPlans] <Int32>]
    [-GetOuterCommand]
    [-GetTransactionInfo]
    [[-GetTaskInfo] <Int32>]
    [-GetLocks]
    [-GetAverageTime]
    [-GetAdditonalInfo]
    [-FindBlockLeaders]
    [[-DeltaInterval] <Int32>]
    [[-OutputColumnList] <String>]
    [[-SortOrder] <String>]
    [[-FormatOutput] <Int32>]
    [[-DestinationTable] <String>]
    [-ReturnSchema]
    [[-Schema] <String>]
    [-Help]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Invoke-DbaWhoIsActive -SqlInstance sqlserver2014a

Execute sp_whoisactive on sqlserver2014a. This command expects sp_WhoIsActive to be in the master database. Logs into the SQL Server with Windows credentials.

Example: 2
PS C:\> Invoke-DbaWhoIsActive -SqlInstance sqlserver2014a -SqlCredential $credential -Database dbatools

Execute sp_whoisactive on sqlserver2014a. This command expects sp_WhoIsActive to be in the dbatools database. Logs into the SQL Server with SQL Authentication.

Example: 3
PS C:\> Invoke-DbaWhoIsActive -SqlInstance sqlserver2014a -GetAverageTime

Similar to running sp_WhoIsActive @get_avg_time

Example: 4
PS C:\> Invoke-DbaWhoIsActive -SqlInstance sqlserver2014a -GetOuterCommand -FindBlockLeaders

Similar to running sp_WhoIsActive @get_outer_command = 1, @find_block_leaders = 1

Required Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2000 or higher.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-Database

The database where sp_WhoIsActive is installed. Defaults to master. If the sp_WhoIsActive is not installed, the command will warn and exit.

Alias
Required False
Pipeline false
Default Value
-Filter

FiltersBoth inclusive and exclusive Set either filter to '' to disable Session is a session ID, and either 0 or '' can be used to indicate "all" sessions All other filter types support % or _ as wildcards

Alias As
Required False
Pipeline false
Default Value
-FilterType

Valid filter types are: session, program, database, login, and host

Alias
Required False
Pipeline false
Default Value Session
Accepted Values Session,Program,Database,Login,Host
-NotFilter

FiltersBoth inclusive and exclusive Set either filter to '' to disable Session is a session ID, and either 0 or '' can be used to indicate "all" sessions All other filter types support % or _ as wildcards

Alias
Required False
Pipeline false
Default Value
-NotFilterType

Valid filter types are: session, program, database, login, and host

Alias
Required False
Pipeline false
Default Value Session
Accepted Values Session,Program,Database,Login,Host
-ShowOwnSpid

Retrieve data about the calling session?

Alias
Required False
Pipeline false
Default Value False
-ShowSystemSpids

Retrieve data about system sessions?

Alias
Required False
Pipeline false
Default Value False
-ShowSleepingSpids

Controls how sleeping SPIDs are handled, based on the idea of levels of interest 0 does not pull any sleeping SPIDs 1 pulls only those sleeping SPIDs that also have an open transaction 2 pulls all sleeping SPIDs

Alias
Required False
Pipeline false
Default Value 0
-GetFullInnerText

If 1, gets the full stored procedure or running batch, when available If 0, gets only the actual statement that is currently running in the batch or procedure

Alias
Required False
Pipeline false
Default Value False
-GetPlans

Get associated query plans for running tasks, if available If 1, gets the plan based on the request's statement offset If 2, gets the entire plan based on the request's plan_handle

Alias
Required False
Pipeline false
Default Value 0
-GetOuterCommand

Get the associated outer ad hoc query or stored procedure call, if available

Alias
Required False
Pipeline false
Default Value False
-GetTransactionInfo

Enables pulling transaction log write info and transaction duration

Alias
Required False
Pipeline false
Default Value False
-GetTaskInfo

Get information on active tasks, based on three interest levels Level 0 does not pull any task-related information Level 1 is a lightweight mode that pulls the top non-CXPACKET wait, giving preference to blockers Level 2 pulls all available task-based metrics, including: number of active tasks, current wait stats, physical I/O, context switches, and blocker information

Alias
Required False
Pipeline false
Default Value 0
-GetLocks

Gets associated locks for each request, aggregated in an XML format

Alias
Required False
Pipeline false
Default Value False
-GetAverageTime

Get average time for past runs of an active query (based on the combination of plan handle, sql handle, and offset)

Alias
Required False
Pipeline false
Default Value False
-GetAdditonalInfo

Get additional non-performance-related information about the session or request text_size, language, date_format, date_first, quoted_identifier, arithabort, ansi_null_dflt_on, ansi_defaults, ansi_warnings, ansi_padding, ansi_nulls, concat_null_yields_null, transaction_isolation_level, lock_timeout, deadlock_priority, row_count, command_type If a SQL Agent job is running, an subnode called agent_info will be populated with some or all of the following: job_id, job_name, step_id, step_name, msdb_query_error (in the event of an error) If @get_task_info is set to 2 and a lock wait is detected, a subnode called block_info will be populated with some or all of the following: lock_type, database_name, object_id, file_id, hobt_id, applock_hash, metadata_resource, metadata_class_id, object_name, schema_name

Alias
Required False
Pipeline false
Default Value False
-FindBlockLeaders

Walk the blocking chain and count the number of total SPIDs blocked all the way down by a given session Also enables task_info Level 1, if @get_task_info is set to 0

Alias
Required False
Pipeline false
Default Value False
-DeltaInterval

Pull deltas on various metrics Interval in seconds to wait before doing the second data pull

Alias
Required False
Pipeline false
Default Value 0
-OutputColumnList

List of desired output columns, in desired order Note that the final output will be the intersection of all enabled features and all columns in the list. Therefore, only columns associated with enabled features will actually appear in the output. Likewise, removing columns from this list may effectively disable features, even if they are turned on Each element in this list must be one of the valid output column names. Names must be delimited by square brackets. White space, formatting, and additional characters are allowed, as long as the list contains exact matches of delimited valid column names.

Alias
Required False
Pipeline false
Default Value [dd%][session_id][sql_text][sql_command][login_name][wait_info][tasks][tran_log%][cpu%][temp%][block%][reads%][writes%][context%][physical%][query_plan][locks][%]
-SortOrder

Column(s) by which to sort output, optionally with sort directions. Valid column choices: session_id, physical_io, reads, physical_reads, writes, tempdb_allocations, tempdb_current, CPU, context_switches, used_memory, physical_io_delta, reads_delta, physical_reads_delta, writes_delta, tempdb_allocations_delta, tempdb_current_delta, CPU_delta, context_switches_delta, used_memory_delta, tasks, tran_start_time, open_tran_count, blocking_session_id, blocked_session_count, percent_complete, host_name, login_name, database_name, start_time, login_time Note that column names in the list must be bracket-delimited. Commas and/or white space are not required.

Alias
Required False
Pipeline false
Default Value [start_time] ASC
-FormatOutput

Formats some of the output columns in a more "human readable" form 0 disables output format 1 formats the output for variable-width fonts 2 formats the output for fixed-width fonts

Alias
Required False
Pipeline false
Default Value 1
-DestinationTable

If set to a non-blank value, the script will attempt to insert into the specified destination table. Please note that the script will not verify that the table exists, or that it has the correct schema, before doing the insert. Table can be specified in one, two, or three-part format

Alias
Required False
Pipeline false
Default Value
-ReturnSchema

If set to 1, no data collection will happen and no result set will be returned; instead, a CREATE TABLE statement will be returned via the @schema parameter, which will match the schema of the result set that would be returned by using the same collection of the rest of the parameters. The CREATE TABLE statement will have a placeholder token of <table_name> in place of an actual table name.

Alias
Required False
Pipeline false
Default Value False
-Schema

If set to 1, no data collection will happen and no result set will be returned; instead, a CREATE TABLE statement will be returned via the @schema parameter, which will match the schema of the result set that would be returned by using the same collection of the rest of the parameters. The CREATE TABLE statement will have a placeholder token of <table_name> in place of an actual table name.

Alias
Required False
Pipeline false
Default Value
-Help

Help! What do I do?

Alias
Required False
Pipeline false
Default Value False
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Invoke-DbaWhoIsActive on GitHub.
Want to see the Bill Of Health for this command? Check out Invoke-DbaWhoIsActive.