xp_trace_setcpufilter (T-SQL)

Specifies the CPU filter, or the minimum and maximum CPU time in milliseconds to include for the events specified. Microsoft® SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for all events with a CPU time greater than the minimum, if any, and less than the maximum, if any.

Syntax

xp_trace_setcpufilter {queue_handle,     minimum_cpu, maximum_cpu}

Arguments

queue_handle

Is an integer representing the handle for the trace queue. queue_handle is used to reference the trace queue and is placed in an output parameter by xp_trace_addnewqueue.

minimum_cpu

Is an integer specifying the minimum number of CPU milliseconds for which to trace. If 0, there is no minimum_cpu value. The maximum value that can be used is 2³² or 4294967296.

maximum_cpu

Is an integer specifying the maximum number of CPU milliseconds for which to trace. If 0, there is no maximum_cpu value. The maximum value that can be used is 2³² or 4294967296.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setcpufilter returns this message:

The command(s) completed successfully.

Permissions

Execute permissions for xp_trace_setcpufilter default to members of the sysadmin fixed server role but can be granted to other users.

Examples

This example configures the CPU filter for the trace queue and specifies a minimum of 100 CPU milliseconds and a maximum of 5000 milliseconds.

USE master

DECLARE @queue_handle int, @column_value int

SET @column_value = 16|32|8192|128|512

EXEC xp_trace_addnewqueue 1000,

    5,

    95,

    90,

    @column_value,

    @queue_handle OUTPUT

EXEC xp_trace_setcpufilter @queue_handle,

    100,

    5000

See Also