拡張イベントパッケージの一覧を出力する：SQL Server動的管理ビューレファレンス（84）

SQL Server動的管理ビュー一覧

　本連載では、「Microsoft SQL Server（以下、SQL Server）」で使用可能な動的管理ビューについて、動作概要や出力内容などを紹介していきます。今回は動的管理ビュー「sys.dm_xe_packages」における、拡張イベントパッケージの一覧を出力する方法について解説します。対応バージョンは、SQL Server（サポートされている全てのバージョン）です。

概要

　SQL Serverでは、拡張イベント（XEvent）の機能を使用することで、SQL Serverの内部で発生したイベントや付随する情報を記録して、パフォーマンス問題の解析や問題の原因特定に必要なデータを収集できます。

　類似の機能として、以前からSQL Serverトレースがありました。拡張イベントはより新しい機能となり、採取パフォーマンスの改善や対象のイベント、収集できる情報の増加、記録方法の選択肢の増加がなされました。

　拡張イベントを収集するには、あらかじめ拡張イベントセッションを構成して、採取対象とするイベントや含める情報、記録先などを設定しておく必要があります。そして、拡張イベントを採取する期間にあわせて、拡張イベントセッションを開始、停止します。

　「sys.dm_xe_packages」動的管理ビューでは、拡張イベントエンジンに登録されたパッケージの一覧を出力できます。拡張イベントでは、これらの登録されたパッケージによって、イベントやイベント発生時に実行できるアクション、記録先であるターゲットなどが提供されています。

• sys.dm_xe_packages（Transact-SQL）

出力内容

動作例

　「sys.dm_xe_packages」動的管理ビューを実行すると、拡張イベントパッケージの一覧が表示されます（図1）。

図1　拡張イベントパッケージの一覧を出力したところ

　T-SQLを使用して拡張イベントセッションを構成する場合、拡張イベントセッションへのイベントの追加は、CREATE／ALTER EVENT SESSIONステートメントにADD EVENT句を追加します。ADD EVENT句では、パッケージ名とイベント名を使用して対象のイベントを指定します。「sys.dm_xe_objects」動的管理ビューと「sys.dm_xe_packages」動的管理ビューを組み合わせることで、パッケージ名を含めたイベント名を取得できます。

図2　ADD EVENT句で指定可能なパッケージ名を含めたイベント名の一覧を出力したところ

　拡張イベントセッションは、SQL Server Management StudioからGUIを使用して構成したり、T-SQLスクリプト化したりできますので、あまりT-SQLを使用して設定する場合はないかもしれませんが、もしT-SQLのみを使用して構成が必要な場合には、「sys.dm_xe_packages」動的管理ビューなどの拡張イベント関連の動的管理ビューの参照が必須となりそうです。

※本Tipsは、「Windows Server 2019」上に「SQL Server 2019」をインストールした環境を想定して解説しています。

筆者紹介

椎名 武史（しいな たけし）

日本ユニシス株式会社所属。Microsoft MVP for Data Platform（2017〜）。入社以来 SQL Serverの評価／設計／構築／教育などに携わりながらも、主にサポート業務に従事。SQL Serverのトラブル対応で社長賞の表彰を受けた経験も持つ。休日は学生時代の仲間と市民駅伝に参加し、銭湯で汗を流してから飲み会へと流れる。

伊東 敏章（いとう としあき）

日本ユニシス株式会社所属。入社以来SQL Server一筋で評価／設計／構築／教育などに携わりながらも、主にサポート業務に従事。社内のプログラミングコンテストで4回の優勝経験も持つ。趣味は輪行で週末は自転車を持っての旅行。目標は色々な日本百選を制覇すること。