カスタムログプロバイダーの作成

[アーティクル]
05/07/2013

Integration Services ランタイム環境には広範なログ記録機能があります。ログを使用すると、パッケージの実行中に発生するイベントをキャプチャできます。 Integration Services では、さまざまなログプロバイダーを使用でき、ログを作成して XML、テキスト、データベースなどの形式で保存したり、Windows イベントログに格納したりできます。これらのログプロバイダーまたは出力形式の中に要件を満たすものがない場合は、カスタムログプロバイダーを作成できます。

カスタムログプロバイダーの作成手順は、Integration Services の他のカスタムオブジェクトの作成手順と同様です。

基本クラスを継承する新しいクラスを作成します。ログプロバイダー用の基本クラスは LogProviderBase です。
クラスに、オブジェクトの種類を識別する属性を適用します。ログプロバイダー用の属性は DtsLogProviderAttribute です。
基本クラスのメソッドとプロパティの実装をオーバーライドします。ログプロバイダーでは、ConfigString プロパティ、OpenLog メソッド、Log メソッド、および CloseLog メソッドが対象です。
カスタムログプロバイダーのカスタムユーザーインターフェイスは、SQL Server Integration Services では実装されていません。

カスタムログプロバイダーの概要

プロジェクトおよびクラスの作成

すべてのマネージログプロバイダーは LogProviderBase 基本クラスから派生するため、カスタムログプロバイダーを作成するには、最初に任意のマネージプログラミング言語でクラスライブラリプロジェクトを作成し、基本クラスを継承するクラスを作成します。この派生クラスで、基本クラスのメソッドとプロパティをオーバーライドして、カスタム機能を実装します。

プロジェクトを構成し、生成するアセンブリを厳密な名前のキーファイルで署名します。

注
多くの Integration Services ログプロバイダーには、カスタムユーザーインターフェイスがあります。カスタムユーザーインターフェイスには IDtsLogProviderUI が実装され、[SSIS ログの構成] ダイアログボックスの [構成] ボックスが、使用可能な接続マネージャーがフィルター選択されたドロップダウンリストに置き換えられます。ただし、カスタムログプロバイダーのカスタムユーザーインターフェイスは、Integration Services では実装されていません。

多くの Integration Services ログプロバイダーには、カスタムユーザーインターフェイスがあります。カスタムユーザーインターフェイスには IDtsLogProviderUI が実装され、[SSIS ログの構成] ダイアログボックスの [構成] ボックスが、使用可能な接続マネージャーがフィルター選択されたドロップダウンリストに置き換えられます。ただし、カスタムログプロバイダーのカスタムユーザーインターフェイスは、Integration Services では実装されていません。

DtsLogProvider 属性の適用

作成したクラスに DtsLogProviderAttribute 属性を適用して、そのクラスがログプロバイダーとして識別されるようにします。この属性には、ログプロバイダーの名前や説明など、デザイン時の情報を指定します。この属性の DisplayName プロパティと Description プロパティは、SQL Server データツール (SSDT) でパッケージのログ記録を構成するときに、[SSIS ログの構成] エディターに表示される [名前] 列と [説明] 列に対応します。

重要
この属性の LogProviderType プロパティは使用されません。ただし、このプロパティには値を入力する必要があります。そうしないと、使用可能なログプロバイダーの一覧にカスタムログプロバイダーが表示されません。

注
Integration Services では、カスタムログプロバイダーのカスタムユーザーインターフェイスは実装されていません。そのため、DtsLogProviderAttribute の UITypeName プロパティに値を指定しても、影響がありません。

<DtsLogProvider(DisplayName:="MyLogProvider", Description:="A simple log provider.", LogProviderType:="Custom")> _
Public Class MyLogProvider
     Inherits LogProviderBase
    ' TODO: Override the base class methods.
End Class

[DtsLogProvider(DisplayName="MyLogProvider", Description="A simple log provider.", LogProviderType="Custom")]
public class MyLogProvider : LogProviderBase
{
    // TODO: Override the base class methods.
}