拡張イベントオブジェクトの列のスキーマ情報を出力する：SQL Server動的管理ビューレファレンス（82）

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

[伊東敏章，＠IT]

SQL Server動的管理ビュー一覧

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

概要

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

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

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

　「sys.dm_xe_object_columns」動的管理ビューでは、拡張イベントの採取対象となるイベントオブジェクトごとに含まれる列のスキーマ情報の一覧を取得できます。スキーマ情報にはフィールドの一覧なども含まれており、この一覧を使用することで、拡張イベントセッションに設定したイベントごとに設定可能なフィールドの一覧を抽出できます。

• sys.dm_xe_object_columns（Transact-sql）

出力内容

列名	データ型	説明
name	nvarchar（256）	列の名前
column_id	int	列の識別子 「column_type」との組み合わせによりオブジェクト内で一意となる
object_name	nvarchar（256）	列が所属するオブジェクトの名前
object_package_guid	uniqueidentifier	列が所属するオブジェクトを含むパッケージのGUID
type_name	nvarchar（256）	列のデータ型の名前
type_package_guid	uniqueidentifier	列のデータ型を含むパッケージのGUID
column_type	nvarchar（60）	この列の使用方法 次のいずれかの値になる readonly：変更されない静的な値 data：実行時データ customizable：変更可能な値 ※この値を変えると、オブジェクトの動作が変更される可能性がある
column_value	nvarchar（256）	列に関連付けられた静的な値
capabilities	int	列の機能を表すビットマップ
capabilities_desc	nvarchar（256）	列の機能についての説明
description	nvarchar（3072）	列の説明

動作例

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

図1　「sys.dm_xe_object_columns」動的管理ビューにより全ての列情報が出力された

　「sys.dm_xe_object_columns」動的管理ビューだけでは対象のイベントの詳細が分かりませんので、「sys.dm_xe_objects」動的管理ビュー、「sys.dm_xe_packages」動的管理ビューと組み合わせます。

　各動的管理ビューのパッケージ名やイベント名を限定することで、特定のイベントの情報のみを出力できます（図2）。

図2　「sql_statement_completed」の列情報のみを出力したところ

　「column_type」列が「data」となっている列が、イベントフィールドとしてイベントに含まれ、採取条件のフィルターとして設定できるグローバルフィルター以外の列となっていました（図3、図4）。「column_type」列が「customizable」となっている列は、イベント発生時に情報を含めるか含めないかなど、動作を変更できる列を示しているようです。

図3　「column_type」列が「data」となっている列と、パッケージ名のないフィルター（述語）が一致していることが分かる

図4　「column_type」列が「data」「customizable」となっている列とイベントフィールドが一致していることが分かる

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

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

筆者紹介

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

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

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

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