Log4Net、ログにカスタムフィールドを追加する方法


98

私はlog4net.Appender.AdoNetAppenderアペンダーを使用しています。
私のlog4netテーブルは次のフィールドです[Date],[Thread],[Level],[Logger],[Message],[Exception]

log4netテーブルに別のフィールド(SalesIdなど)を追加する必要がありますが、エラーメッセージまたは情報メッセージをログに記録するときに「SalesId」をログに記録するには、xmlとコードでどのように指定しますか?

例えば log.Info("SomeMessage", SalesId)

これがlog4net xmlです

  <appender name="SalesDBAppender" type="log4net.Appender.AdoNetAppender">
    <bufferSize value="1" />
    <connectionType value ="System.Data.SqlClient.SqlConnection" />
    <connectionString value="Data Source=..." />
    <commandText value="INSERT INTO Log4Net ([Date],[Thread],[Level],[Logger],[Message],[Exception]) VALUES (@log_date, @thread, @log_level, @logger, @message, @exception)" />
    <parameter>
      <parameterName value="@log_date" />
      <dbType value="DateTime" />
      <layout type="log4net.Layout.RawTimeStampLayout" />
    </parameter>
    <parameter>
      <parameterName value="@thread" />
      <dbType value="String" />
      <size value="255" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%thread" />
      </layout>
    </parameter>
    <parameter>
      <parameterName value="@log_level" />
      <dbType value="String" />
      <size value="50" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%level" />
      </layout>
    </parameter>
    <parameter>
      <parameterName value="@logger" />
      <dbType value="String" />
      <size value="255" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%logger" />
      </layout>
    </parameter>
    <parameter>
      <parameterName value="@message" />
      <dbType value="String" />
      <size value="4000" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%message" />
      </layout>
    </parameter>
    <parameter>
      <parameterName value="@exception" />
      <dbType value="String" />
      <size value="2000" />
      <layout type="log4net.Layout.ExceptionLayout" />
    </parameter>
  </appender>

回答:


190

1)コマンドテキストを変更します。 INSERT INTO Log4Net ([Date],[Thread],[Level],[Logger],[Message],[Exception],[MyColumn]) VALUES (@log_date, @thread, @log_level, @logger, @message, @exception, @CustomColumn)

2)カスタム列のパラメーター定義を追加します。

<parameter>
   <parameterName value="@CustomColumn"/>
   <dbType value="String" />
   <size value="255" />
   <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%property{CustomColumn}" />
  </layout>
</parameter>

3)次に、log4netのコンテキストの1つを使用して、値をパラメーターに転送します。

// thread properties...
log4net.LogicalThreadContext.Properties["CustomColumn"] = "Custom value";
log.Info("Message"); 

// ...or global properties
log4net.GlobalContext.Properties["CustomColumn"] = "Custom value";

2
誰かがブラウザ機能のロギングに最適なコンテキストを提案できますか?
VivekDev 2015年

1
@DumbDev、通常はスレッドコンテキストを使用します。GlobalContextは、頻繁に変更されないプロパティを設定するのに役立ちます。
Marcelo De Zen

1
ただし、WebアプリケーションでThreadContextを使用する場合は注意が必要です。これらはスレッドをジャンプする傾向があり、それに応じてThreadContextが移動されないためです。
Robba

4
@theberserker LogicalThreadContextはタスクで使用してThreadContextも問題ありませんが、常に特定のスレッドにバインドされているため、使用できません。
Marcelo De Zen

5
それは私の意見だが、それはこのよう少し奇妙なようで、私は...新しいLoggingEventなインスタンスに追加する複数の引数を受け取るオーバーロードを予想
A77

6

Log4Netで使用可能な3種類のロギングコンテキスト。

  1. Log4Net.GlobalContext:-このコンテキストは、すべてのアプリケーションスレッドおよびドメインで共有されます。2つのスレッドがGlobalContextに同じプロパティを設定すると、1つの値が他の値をオーバーライドします。

  2. Log4Net.ThreadContext:-このコンテキストスコープは、スレッドの呼び出しに限定されています。ここでは、2つのスレッドが互いに上書きすることなく、同じプロパティを異なる値に設定できます。

  3. Log4Net.ThreadLogicalContext:-このコンテキストはThreadContextと同様に動作します。カスタムスレッドプールアルゴリズムを使用している場合、またはCLRをホストしている場合は、これがある程度使用されることがあります。

次のコードをprogram.csファイルに追加します。

static void Main( string[] args )
{
    log4net.Config.XmlConfigurator.Configure();
    log4net.ThreadContext.Properties[ "myContext" ] = "Logging from Main";
    Log.Info( "this is an info message" );
    Console.ReadLine();
}

2)カスタム列のパラメーター定義を追加します。

  <log4net>      
    <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%logger (%property{myContext}) [%level]- %message%newline" />
      </layout>
    </appender> 
  </log4net>

3

これは、パーソナライズされた設定がいくつかある作業バージョンです。生成された例外コードを格納するためのカスタム列を追加しました。

1)カスタム列(exceptionCodeはこちら)をLog4net構成に追加します。

<commandText value="INSERT INTO Log([Date],[Thread],[Level],[Logger],[Message],[Exception],[ExceptionCode]) 
VALUES (@log_date, @thread, @log_level, @logger, @message, @exception,@exceptionCode)" />

<parameter>
    <parameterName value="@exceptionCode" />
    <dbType value="String" />
    <size value="11" />
    <layout type="Common.Utils.LogHelper.Log4NetExtentedLoggingPatternLayout">
        <conversionPattern value="%exceptionCode{Code}" />
    </layout>
</parameter>

2)Log4NetExtentedLoggingCustomParameters.cs

namespace Common.Utils.LogHelper
{
    public class Log4NetExtentedLoggingCustomParameters
    {
        public string ExceptionCode { get; set; }

        public string Message { get; set; }

        public override string ToString()
        {
            return Message;
        }
    }
}

3)Log4NetExtentedLoggingPatternConverter.cs

namespace Common.Utils.LogHelper
{
    public class Log4NetExtentedLoggingPatternConverter : PatternConverter
    {
        protected override void Convert(TextWriter writer, object state)
        {
            if (state == null)
            {
                writer.Write(SystemInfo.NullText);
                return;
            }

            var loggingEvent = state as LoggingEvent;
            var messageObj = loggingEvent.MessageObject as Log4NetExtentedLoggingCustomParameters;

            if (messageObj == null)
            {
                writer.Write(SystemInfo.NullText);
            }
            else
            {
                switch (this.Option.ToLower()) //this.Option = "Code"
                {
                    case "code": //config conversionPattern parameter -> %exceptionCode{Code}
                        writer.Write(messageObj.ExceptionCode);
                        break;  
                    default:
                        writer.Write(SystemInfo.NullText);
                        break;
                }
            }
        }
    }
}

4)Log4NetExtentedLoggingPatternLayout.cs

namespace Common.Utils.LogHelper
{
    public class Log4NetExtentedLoggingPatternLayout : PatternLayout
    {
        public Log4NetExtentedLoggingPatternLayout()
        {
            var customConverter = new log4net.Util.ConverterInfo()
            {
                Name = "exceptionCode",
                Type = typeof(Log4NetExtentedLoggingPatternConverter)
            };

            AddConverter(customConverter);
        }
    }
}

5)Logger.cs //新しい列でロガーを楽しんでください!:)

namespace Common.Utils.LogHelper
{
    public class Logger
    {
        static ILog Logger = LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

        public static string LogError(string message, Exception exception = null)
        {
            var logWithErrCode = GetLogWithErrorCode(message);
            Logger.Error(logWithErrCode, exception);
            return logWithErrCode.ExceptionCode;
        }

        private static Log4NetExtentedLoggingCustomParameters GetLogWithErrorCode(string message)
        {
            var logWithErrCode = new Log4NetExtentedLoggingCustomParameters();
            logWithErrCode.ExceptionCode = GenerateErrorCode(); //this method is absent for simplicity. Use your own implementation
            logWithErrCode.Message = message;
            return logWithErrCode;
        }
    }
}

参照:

http://blog.stvjam.es/2014/01/logging-custom-objects-and-fields-with

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.