Trace Event Commands

CREATE EVENT TRACE

Creates a trace event.

Syntax

CREATE EVENT TRACE
    event_name
    [ WITH (<event_characteristic>, ...) ];

Where <event_characteristic> is an key/value pair, such as:

  • Query_text = on captures the query text

  • Duration_threshold_ms = 1000 traces all queries with runtimes over 1 second

  • Trace_all_failed_executions= on traces all queries that have failed, even when their runtimes are less than Duration_threshold_ms

Remarks

  • The event_name and event_characteristic keys are not case-sensitive.

  • Currently, Query_completion is the only usable event type.

  • The ALTER TRACE permission is required to create trace events.

  • Since event_characteristic key-value pairs are optional, each event trace has its own default values for a default configuration.

DROP EVENT TRACE

Drops a trace event.

Syntax

DROP EVENT TRACE event_name;

Remarks

  • The ALTER TRACE permission is required to drop trace events.

Last modified: July 29, 2024

Was this article helpful?