独自の TraceListener 実装でそのリスナー独自の構成パラメータを指定するには

.NET アプリ全般的な話。

トレース機能とトレースリスナ

.NET Framework には Trace クラスや TraceSource クラスなどによるトレース機能（ある種のロギング機能といっていいだろう）が備わっている。

アプリ本体側から Trace.Write とかすると、そのアプリケーションに設定されている "トレースリスナ" オブジェクトに引き渡され、各トレースリスナオブジェクトが然るべきところに書き込みを行う、という寸法だ。

たとえば、Windows OS のイベントログに書き込むというトレースリスナが .NET Framework には標準装備されている。
これをアプリにセットアップしておくと、アプリからのトレース出力が、Windows のイベントログに書き込まれるようになる。

アプリへのトレースリスナの組み込みは、コード上から明示的に行えるほか、App.config や Web.config などアプリケーション構成ファイルにて指定することができる。

トレースリスナは自作できる

当然のことながら、トレースリスナは自作できる。

TraceListener クラスから派生した自作クラスを用意し、Write メソッド、WriteLine メソッドを override して実装するだけ。

とは override した Write/WriteLine メソッド内で、好きなようにトレース出力を扱えばよい。

こんな風に、MongoDB に書き込む事例もある。

無聊を託つ - TraceListner into MongoDB
http://takepara.blogspot.com/2011/10/tracelistner-into-mongodb.html

自作トレースリスナにパラメータ指定するには?

さて、トレースリスナを自作する場合、独自のパラメータ指定ができたほうが便利なことも多いだろう。

たとえばトレース出力を片っ端からメール送信するトレースリスナを自作する場合、宛先や件名などを App.config のトレースリスナ設定行に記述しておきたいのではないだろうか。

もちろん、appSettings 構成セクションを使えばお気楽である。
ただ、トレースリスナ設定行とセクションが違うので、設定箇所が離れてしまうのが難点か。
appSettings 構成セクションがどんどん "汚染" されるのも、ちょっといただけない。

ということで実は、.NET Framework はそんな要望にすでに応えており、トレースリスナ設定行に独自パラメータを併記できるようになっていた。

まずアプリケーション構成ファイルのトレースリスナ設定行には、次の要領で独自パラメータを XML 属性として記述しておく。

<system.diagnostics>
<trace>
　<listeners>
　　<add name="MyListener" type="MyListenerClass, MyAssembly" to="foo@bar.com" sibject="wow!"/>
　</listeners>
</trace>
</system.diagnostics>

自作トレースリスナで GetSupportedAttributes メソッドをオーバーライドする。
ここで、独自パラメータ名を返すようにするのだ。

protected override string[] GetSupportedAttributes()
{
　var attrs = new List(base.GetSupportedAttributes() ?? new string[0]);
　attr.Add("to");
　attr.Add("subject");
　return attrs.ToArray();
}

こうしておくと、自作トレースリスナのコード上で、基底クラス TraceListener の Attributes プロパティを参照したときに、独自パラメータを参照できる。

public override void WriteLine(string message)
{
　var to = this.Attributes["to"];
　var subject = this.Attributes["subject"];
　...
}

以上、ご参考まで。