Skip to content

use-the-ssms-xe-profiler.md

Latest commit

 

History

History
51 lines (37 loc) · 2.79 KB

use-the-ssms-xe-profiler.md

File metadata and controls

51 lines (37 loc) · 2.79 KB
title Use the SSMS XEvent Profiler
description The XEvent Profiler displays a live viewer of extended events. Learn why to use this profiler, key features, and how to get started viewing extended events.
author erinstellato-ms
ms.author erinstellato
ms.reviewer mikeray
ms.date 10/02/2016
ms.service sql
ms.subservice xevents
ms.topic tutorial
helpviewer_keywords
extended events [SQL Server], system health session
extended events [SQL Server], system_health session
system_health session [SQL Server extended events]
system health session [SQL Server extended events]
monikerRange >=sql-server-2016||>=sql-server-linux-2017

Use the SSMS XEvent Profiler

[!INCLUDE SQL Server]

The XEvent Profiler is a SQL Server Management Studio (SSMS) feature that displays a live viewer window of Extended Events. This overview describes the reasons for using this profiler, key features, and instructions to get started viewing Extended Events.

Why would I use the XEvent Profiler?

Unlike SQL Profiler, XEvent profiler is directly integrated into SSMS and is built on top of the scalable Extended Events technology in the SQL engine. This feature enables quick access to a live streaming view of diagnostics events on the SQL Server. This view can be customized and those customizations can be shared with other SSMS users as a .viewsettings file. The session created by XE Profiler is less intrusive to the running SQL Server than a similar SQL trace would be when using SQL Profiler. This session can be customized by the user as well, using the existing XE session properties UI or by Transact-SQL.

Prerequisites

This feature is only available on SQL Server Management Studio (SSMS) v17.3 or later. Install the latest version of SQL Server Management Studio (SSMS).

Getting Started

To access the XEvent Profiler, follow these steps:

  1. Open SQL Server Management Studio.

  2. Connect to an instance of the SQL Server Database Engine or localhost.

  3. In Object Explorer, find the XE Profiler menu item and expand it by clicking the '+' sign.

    XEProfiler Menu

  4. Double-click Standard if you want to view all events in this session. Click T-SQL if you want to view the logged SQL statements. If a session is not already created, a session is created for you.

    XEProfiler Session

  5. You can now view events captured by the session.

    XEProfiler Viewer

See Also

Extended Events
Extended Events Tools