Integration Services (SSIS) のログ記録
SQL Server Integration Services には、パッケージ、コンテナー、およびタスクにログ記録を実装するために使用できる、ログ プロバイダーが含まれています。 ログ記録を行うと、パッケージに関する実行時の情報をキャプチャできるので、パッケージを実行するたびに監査やトラブルシューティングに役立ちます。 たとえば、パッケージを実行した演算子の名前と、パッケージの開始および完了時刻をログにキャプチャできます。
Integration Services サーバーでのパッケージ実行中に発生するログ記録のスコープを構成できます。 詳細については、「SSIS サーバーでのパッケージ実行のログ記録を有効にする」を参照してください。
dtexec コマンド プロンプト ユーティリティを使用してパッケージを実行する際にも、ログ記録を使用できます。 ログ記録をサポートするコマンド プロンプトの引数の詳細については、「dtexec ユーティリティ」を参照してください。
SQL Server Data Tools でのログ記録の構成
ログはパッケージに関連付けられ、パッケージ レベルで設定します。 パッケージ内の各タスクやコンテナーによって、パッケージのログに情報を書き込むこともできます。 パッケージのログ機能が有効にされていない場合でも、そのパッケージに含まれるタスクやコンテナーのログ機能を有効にできます。 たとえば、親パッケージのログ機能を有効にしなくても、SQL 実行タスクのログ機能を有効にできます。 パッケージ、コンテナー、およびタスクは、複数のログに対して書き込みが可能です。 パッケージにのみログ機能を有効にできます。または、そのパッケージに含まれる任意の個別のタスクまたはコンテナーを選択して、ログ機能を有効にできます。
パッケージにログを追加するには、ログ プロバイダーとログの場所を選択します。 ログ プロバイダーは、ログ データの形式を指定します。たとえば、SQL Server データベースやテキスト ファイルなどを指定できます。
Integration Services には、次のログ プロバイダーが含まれています。
テキスト ファイルのログ プロバイダー。ログ エントリを、コンマ区切り (CSV) 形式で、ASCII テキスト ファイルに書き込みます。 このプロバイダーで使用されるファイル名の既定の拡張子は、.log です。
SQL Server Profiler のログ プロバイダー。SQL Server Profiler を使用して表示できるトレースを書き込みます。 このプロバイダーで使用されるファイル名の既定の拡張子は、.trc です。
.gif "注意")
注64 ビット モードで実行されているパッケージでは、SQL Server Profiler のログ プロバイダーを使用できません。
SQL Server のログ プロバイダー。ログ エントリを、SQL Server データベースの sysssislog テーブルに書き込みます。
Windows イベント ログのログ プロバイダー。エントリを、ローカル コンピューター上にある Windows イベント ログのアプリケーション ログに書き込みます。
XML ファイルのログ プロバイダー。ログ ファイルを XML ファイルに書き込みます。 このプロバイダーで使用されるファイル名の既定の拡張子は、.xml です。
ログ プロバイダーをパッケージに追加したり、ログ記録をプログラムによって構成する場合、SSIS デザイナーの [SSIS ログの構成] ダイアログ ボックスに表示される名前を使用せず、ProgID または ClassID のどちらかを使用してログ プロバイダーを識別できます。
次の表に、Integration Services に含まれるログ プロバイダーの ProgID と ClassID、およびログ プロバイダーが書き込むログの場所の一覧を示します。
ログ プロバイダー |
ProgID |
ClassID |
場所 |
|---|---|---|---|
テキスト ファイル |
DTS.LogProviderTextFile |
{0A039101-ACC1-4E06-943F-279948323883} |
ログ プロバイダーが使用するファイル接続マネージャーでテキスト ファイルのパスを指定します。 |
SQL Server Profiler |
DTS.LogProviderSQLProfiler |
{E93F6300-AE0C-4916-A7BF-A8D0CE12C77A} |
ログ プロバイダーが使用するファイル接続マネージャーで SQL Server Profiler が使用するファイルのパスを指定します。 |
SQL Server |
DTS.LogProviderSQLServer |
{94150B25-6AEB-4C0D-996D-D37D1C4FDEDA} |
ログ プロバイダーが使用する OLE DB 接続マネージャーで、ログ エントリ用の sysssislog テーブルを格納する SQL Server データベースを指定します。 |
Windows イベント ログ |
DTS.LogProviderEventLog |
{071CC8EB-C343-4CFF-8D58-564B92FCA3CF} |
Windows イベント ビューアーのアプリケーション ログには、Integration Services のログ情報が表示されます。 |
XML ファイル |
DTS.LogProviderXMLFile |
{440945A4-2A22-4F19-B577-EAF5FDDC5F7A} |
ログ プロバイダーが使用するファイル接続マネージャーで XML ファイルのパスを指定します。 |
また、カスタム ログ プロバイダーを作成することもできます。 詳細については、「カスタム ログ プロバイダーの作成」を参照してください。
パッケージ内のログ プロバイダーは、パッケージのログ プロバイダー コレクションのメンバーです。 SSIS デザイナーを使用してパッケージを作成し、ログ記録を実装する際、SSIS デザイナーの [パッケージ エクスプローラー] タブ上の [ログ プロバイダー] フォルダーに、コレクション メンバーの一覧が表示されます。
ログ プロバイダーを構成するには、ログ プロバイダーの名前と説明を入力し、ログ プロバイダーが使用する接続マネージャーを指定します。 SQL Server のログ プロバイダーでは、OLE DB 接続マネージャーが使用されます。 テキスト ファイル、SQL Server Profiler、および XML ファイルのログ プロバイダーでは、ファイル接続マネージャーが使用されます。 Windows イベント ログのログ プロバイダーでは、Windows イベント ログに直接書き込まれるので、接続マネージャーが使用されません。 詳細については、「OLE DB 接続マネージャー」および「ファイル接続マネージャー」を参照してください。
ログ記録のカスタマイズ
イベント メッセージまたはカスタム メッセージのログ機能をカスタマイズするために、Integration Services には、ログ エントリに通常書き込まれる情報のスキーマが用意されています。 Integration Services のログ スキーマは、ログ記録できる情報を定義します。 ログ エントリごとにログ スキーマから要素を選択します。
パッケージおよびパッケージ内のコンテナーやタスクが、同じ情報をログ記録する必要はありません。また、同一パッケージやコンテナーのタスクが別々の情報をログ記録することができます。 たとえば、パッケージではパッケージが開始されたときにオペレーターに関する情報をログに書き込み、あるタスクではタスク失敗の原因を書き込み、別のタスクではエラー発生時に情報を書き込むという処理が可能です。 パッケージおよびパッケージ内のコンテナーやタスクが複数のログを使用する場合、同じ情報がすべてのログに書き込まれます。
ログ記録するイベントと各イベントに対して書き込む情報を指定して、必要に応じたログ記録のレベルを選択できます。 これにより、他のイベントに比べて有益な情報が得られるイベントがわかります。 たとえば、PreExecute イベントについてはコンピューター名とオペレーター名のみをログ記録し、Error イベントについては利用可能なすべての情報を記録するとよいでしょう。
ログ ファイルがディスク領域を大量に消費したり、過剰にログが記録されたりするとパフォーマンスが低下します。これを防止するため、特定のイベントとログ記録する情報項目を選択して、ログ記録を制限することができます。 たとえば、エラーが発生した日付とコンピューター名のみを記録するようにログを設定できます。
SSIS デザイナーの [SSIS ログの構成] ダイアログ ボックスを使用して、ログ オプションを定義できます。
ログ スキーマ
次の表に、ログ スキーマの要素を示します。
要素 |
説明 |
||
|---|---|---|---|
Computer |
ログ イベントが発生したコンピューターの名前。 |
||
Operator |
パッケージを起動したユーザーの ID。 |
||
SourceName |
ログ イベントが発生したコンテナーまたはタスクの名前。 |
||
SourceID |
ログ イベントが発生したパッケージ、For ループ コンテナー、Foreach ループ コンテナー、シーケンス コンテナー、またはタスクの一意識別子。 |
||
ExecutionID |
パッケージ実行インスタンスの GUID。
|
||
MessageText |
ログ エントリに関連付けられるメッセージ。 |
||
DataBytes |
ログ エントリ固有のバイト配列。 このフィールドの意味は、ログ エントリによって異なります。 |
次の表は、[SSIS ログの構成] ダイアログ ボックスの [詳細] タブでは利用できないログ スキーマ内の 3 つの追加要素について説明しています。
要素 |
説明 |
|---|---|
StartTime |
コンテナーまたはタスクの実行が開始した時間。 |
EndTime |
コンテナーまたはタスクの実行が停止した時間。 |
DataCode |
コンテナーまたはタスクの実行結果を示す DTSExecResult 列挙体の値を通常含んだ整数値 (省略可能)。
|
ログ エントリ
Integration Services では、あらかじめ定義されたイベントのログ エントリをサポートし、多くの Integration Services オブジェクトにカスタム ログ エントリを提供します。 SSIS デザイナーの [SSIS ログの構成] ダイアログ ボックスに、これらのイベントとカスタム ログ エントリが一覧表示されます。
次の表に、実行時イベント発生時にログ エントリを書き込むために有効にできる、あらかじめ定義されたイベントを示します。 これらのログ エントリは、実行可能ファイル、パッケージ、そのパッケージに含まれるタスクおよびコンテナーに適用されます。 ログ エントリ名は、ログ エントリが書き込まれる原因となった、発生実行時イベントの名前と同じです。
イベント |
説明 |
|---|---|
OnError |
エラー発生時にログ エントリを書き込みます。 |
OnExecStatusChanged |
デバッグ中に (コンテナー以外の) タスクが中断または再開されたときにログ エントリを書き込みます。 |
OnInformation |
実行可能ファイルの検証および実行中に、情報を報告するログ エントリを書き込みます。 |
OnPostExecute |
実行可能ファイルの実行が終了した直後にログ エントリを書き込みます。 |
OnPostValidate |
実行可能ファイルの検証が終了したときにログ エントリを書き込みます。 |
OnPreExecute |
実行可能ファイルの実行直前にログ エントリを書き込みます。 |
OnPreValidate |
実行可能ファイルの検証が開始される前にログ エントリを書き込みます。 |
OnProgress |
実行可能ファイルの処理で測定可能な進捗があったときにログ エントリを書き込みます。 |
OnQueryCancel |
タスク処理中に、実行のキャンセルが可能な時点に達したときにログ エントリを書き込みます。 |
OnTaskFailed |
タスクが失敗したときにログ エントリを書き込みます。 |
OnVariableValueChanged |
変数の値が変更されたときにログ エントリを書き込みます。 |
OnWarning |
警告が発生したときにログ エントリを書き込みます。 |
PipelineComponentTime |
各データ フロー コンポーネントに対する検証および実行の各フェーズのログ エントリを書き込みます。 ログ エントリは、各フェーズの処理時間を示します。 |
Diagnostic |
診断情報を提供するログ エントリを書き込みます。 たとえば、外部データ プロバイダーを呼び出す前と後にメッセージをログに書き込むことができます。 詳細については、「パッケージ実行のトラブルシューティング ツール」を参照してください。 |
パッケージおよび多くのタスクには、ログ機能を有効にできるカスタム ログ エントリがあります。 たとえば、メール送信タスクには SendMailTaskBegin カスタム ログ エントリがあります。これを使用すると、電子メール メッセージの送信前に、メール送信タスクの実行開始時の情報をログに書き込むことができます。 詳細については、「ログ記録用のカスタム メッセージ」を参照してください。
パッケージのコピーの区別
ログ データには、ログ エントリが属しているパッケージの名前と GUID が含まれます。 既存のパッケージをコピーして新しいパッケージを作成する場合、既存のパッケージの名前と GUID もコピーされます。 したがって、同じ GUID と名前が付いたパッケージが 2 つになり、ログ データ内のパッケージの区別が困難になります。
このようなあいまいさを回避するには、新しいパッケージの名前と GUID を更新する必要があります。 SQL Server データ ツール (SSDT) のプロパティ ウィンドウで、ID プロパティの GUID を再生成し、Name の値を更新できます。 プログラムから、または dtutil コマンド プロンプトを使用して、GUID と名前を変更することもできます。 詳細については、「パッケージのプロパティを設定する」および「dtutil ユーティリティ」を参照してください。
親のログ オプション
一般的に、タスク、For ループ コンテナー、Foreach ループ コンテナー、シーケンス コンテナーのログ オプションは、それらが含まれているパッケージや親コンテナーのログ オプションと同じです。 この場合、親コンテナーからログ オプションを継承するように設定できます。 たとえば、SQL 実行タスクが含まれている For ループ コンテナーがある場合、SQL 実行タスクでは For ループ コンテナーに設定されたログ オプションを使用できます。 親のログ オプションを使用するには、コンテナーの LoggingMode プロパティを UseParentSetting に設定します。 このプロパティは、SQL Server データ ツール (SSDT) の [プロパティ] ウィンドウ、または SSIS デザイナーの [SSIS ログの構成] ダイアログ ボックスで設定できます。
ログのテンプレート
[SSIS ログの構成] ダイアログ ボックスでは、頻繁に使用するログ構成をテンプレートとして作成および保存して、複数のパッケージでそのテンプレート使用できます。 これにより、複数のパッケージで一貫したログ記録の方法を簡単に使用でき、テンプレートを更新して適用することによって簡単にパッケージのログ設定を修正できます。 テンプレートは XML ファイルとして格納されます。
[SSIS ログの構成] ダイアログ ボックスを使用してログ機能を設定するには
パッケージおよびタスクのログ記録を有効にします。 ログは、パッケージ レベル、コンテナー レベル、またはタスク レベルで記録できます。 パッケージ、コンテナー、タスクに対して、それぞれ異なるログを指定できます。
ログ プロバイダーを選択して、パッケージのログを追加します。 ログはパッケージ レベルでのみ作成可能で、タスクやコンテナーではパッケージで作成されたログのいずれかを使用します。 各ログは、テキスト ファイル、SQL Server Profiler、SQL Server、Windows のイベント ログ、または XML ファイルのいずれかのログ プロバイダーに関連付けられます。 詳細については、「SQL Server Data Tools でパッケージのログ記録を有効にする」を参照してください。
ログに取り込むイベントと、各イベントのログ スキーマ情報を選択します。 詳細については、「保存されている構成ファイルを使用してログ記録を構成する」を参照してください。
ログ プロバイダーの構成
プロパティの設定は、SSIS デザイナーから行うか、プログラムによって行います。
ログ プロバイダーは、パッケージにログ記録を実装する手順の中で作成して構成します。 詳細については、「Integration Services (SSIS) のログ記録」を参照してください。
ログ プロバイダーを作成した後にプロパティを表示および変更するには、SQL Server データ ツール (SSDT) のプロパティ ウィンドウを使用します。
プログラムによってこれらのプロパティを設定する方法の詳細については、LogProvider クラスのドキュメントを参照してください。
データ フロー タスクのログ機能の構成
データ フロー タスクには、パフォーマンスの監視と調整に使用できるカスタム ログ エントリが数多くあります。 たとえば、メモリ リークを起こす可能性のあるコンポーネントを監視したり、特定のコンポーネントの実行所要時間を追跡できます。 カスタム ログ エントリの一覧とサンプルのログ出力については、「データ フロー タスク」を参照してください。
PipelineComponentTime イベントの使用
カスタム ログ エントリの中で最も役に立つのは、PipelineComponentTime イベントです。 このログ エントリは、データ フローの各コンポーネントが主要な 5 つの処理手順それぞれで要するミリ秒数を報告します。 次の表で、これらの処理手順について説明します。 Integration Services の開発者は、これらの手順を PipelineComponent の主要メソッドと見なすことができます。
手順 |
説明 |
|---|---|
Validate |
コンポーネントは、有効なプロパティ値と構成設定を確認します。 |
PreExecute |
コンポーネントは、データ行の処理を開始する前に 1 回限りの処理を実行します。 |
PostExecute |
コンポーネントは、すべてのデータ行を処理した後に 1 回限りの処理を実行します。 |
ProcessInput |
変換コンポーネントまたは変換先コンポーネントは、上流変換元または変換から渡されたデータの受信行を処理します。 |
PrimeOutput |
変換元コンポーネントまたは変換コンポーネントは、下流変換コンポーネントまたは変換先コンポーネントに渡されるデータのバッファーを入力します。 |
PipelineComponentTime イベントを有効にすると、Integration Services では、各コンポーネントが実行した処理手順ごとに 1 つのメッセージをログに記録します。 以下のログ エントリに、Integration Services CalculatedColumns パッケージ サンプルでログに記録されるメッセージのサブセットを示します。
The component "Calculate LineItemTotalCost" (3522) spent 356 milliseconds in ProcessInput.
The component "Sum Quantity and LineItemTotalCost" (3619) spent 79 milliseconds in ProcessInput.
The component "Calculate Average Cost" (3662) spent 16 milliseconds in ProcessInput.
The component "Sort by ProductID" (3717) spent 125 milliseconds in ProcessInput.
The component "Load Data" (3773) spent 0 milliseconds in ProcessInput.
The component "Extract Data" (3869) spent 688 milliseconds in PrimeOutput filling buffers on output "OLE DB Source Output" (3879).
The component "Sum Quantity and LineItemTotalCost" (3619) spent 141 milliseconds in PrimeOutput filling buffers on output "Aggregate Output 1" (3621).
The component "Sort by ProductID" (3717) spent 16 milliseconds in PrimeOutput filling buffers on output "Sort Output" (3719).
これらのログ エントリは、データ フロー タスクが、次の手順にほとんどの時間を要することを示しています。ここでは、手順を降順に示します。
"Extract Data" という名前の OLE DB ソースは、データの読み込みに 688 ミリ秒費やしました。
"Calculate LineItemTotalCost" という名前の派生列変換は、受信行での計算の実行に 356 ミリ秒費やしました。
"Sum Quantity and LineItemTotalCost" という名前の集計変換は、計算の実行と次の変換へのデータの受け渡しに合計 220 ミリ秒 (PrimeOutput に 141 ミリ秒、ProcessInput に 79 秒) 費やしました。
関連タスク
次の一覧では、ログ記録機能に関連するタスクの実行方法を示すトピックへのリンクを示します。
関連コンテンツ
|
.gif "Integration Services のアイコン (小)")
最新の Integration Services の入手完全かつ詳細なログ記録用の DTLoggedExec ツール (CodePlex プロジェクト)