拡張イベントオブジェクトの一覧を出力する：SQL Server動的管理ビューレファレンス（83）

「Microsoft SQL Server」が稼働するデータベースシステムを運用する管理者に向け、「動的管理ビュー」の活用を軸にしたトラブル対策のためのノウハウを紹介していきます。今回は、拡張イベントオブジェクトの一覧を出力する方法について解説します。

[伊東敏章，＠IT]

SQL Server動的管理ビュー一覧

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

概要

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

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

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

　「sys.dm_xe_objects」動的管理ビューでは、拡張イベントオブジェクトの一覧の出力が可能です。この一覧には、拡張イベントセッションで採取対象とできるイベントやイベント発生時に実行できるアクション、イベント記録先として設定できるターゲットの種類の一覧などの情報が含まれています。

• sys.dm_xe_objects（Transact-SQL）

出力内容

列名	データ型	説明
name	nvarchar（60）	オブジェクトの名前 特定の種類のオブジェクトのパッケージ内で一意
object_type	nvarchar（60）	オブジェクトの種類 次のいずれかの値になる 　event 　action 　target 　pred_source 　pred_compare 　type
package_guid	uniqueidentifier	オブジェクトを公開するパッケージのGUID 「sys.dm_xe_packages.package_id」との間に多対一のリレーションシップがある
description	nvarchar（256）	アクションの説明
capabilities	int	オブジェクトの機能を表すビットマップ
capabilities_desc	nvarchar（256）	オブジェクトの機能の説明の一覧 ・全てのオブジェクトの種類に適用される機能 private：内部的に使用するオブジェクト CREATE／ALTER EVENT SESSION DDLではアクセスできない。監査イベントとターゲット、内部的に使用される少数のオブジェクトはこのカテゴリーに分類される ・イベントに適用される機能 No_block：イベントはどのような理由でもブロックできない重要なコードパス内にあり、NO_EVENT_LOSSを指定したイベントセッションに追加することはできない ・全てのオブジェクトの種類に適用される機能 Process_whole_buffers：ターゲットはイベントごとではなく、イベントのバッファーをまとめて使用することを示す Singleton：ターゲットのインスタンスが1つだけ存在する。複数のイベントセッションで同じシングルトンターゲットが参照される。インスタンスは1つで、そのインスタンスが一意の各イベントを1回だけ認識することを示す Synchronous：ターゲットは呼び出し元のコード行に制御が返される前に、イベントを生成しているスレッドで実行される
type_name	nvarchar（60）	「pred_source」オブジェクトおよび「pred_compare」オブジェクトの名前
type_package_guid	uniqueidentifier	オブジェクトの型を公開するパッケージのGUID
type_size	int	データ型のサイズ（バイト単位）。有効なオブジェクトの種類に対してのみ使用される

動作例

　「sys.dm_xe_objects」動的管理ビューを出力すると、全てのイベントについての列の情報の一覧が出力されます（図1）。

図1　「sys.dm_xe_objects」動的管理ビューにより全てのイベントオブジェクトの一覧を出力した

　この中で「object_type」列が「event」となっており「capabilities_desc」列に「private」が含まれないものが、拡張イベントセッションのADD EVENTで設定できるイベントとなるようです。パッケージ名は「sys.dm_xe_packages」動的管理ビューと組み合わせて取得する必要があります（図2、図3）。

図2　「object_type」列が「event」となっているイベントオブジェクトを出力したところ

図3　拡張イベントセッションの構成画面で選択できるイベントの一覧と一致していることが分かる

　「object_type」列を「action」に限定してグローバルアクションの一覧を出力するなど、「object_type」列の値によって出力対象を変えられます（図4、図5、図6）。

図4　「object_type」列を「action」に限定することでグローバルアクションの一覧を出力できる

図5　「object_type」列を「target」に限定することでターゲットの一覧を出力できる

図6　「object_type」列を「pred_source」に限定することでグローバル述語ソースの一覧を出力できる

　なお、イベントに付随するフィールドの一覧については「sys.dm_xe_objects」動的管理ビューには含まれていないため、「sys.dm_xe_object_columns」動的管理ビューと組み合わせる必要があります。

図7　「sys.dm_xe_object_columns」動的管理ビューと組み合わせることでフィールドの一覧を出力できる

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

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

筆者紹介

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

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

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

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