Log4Net, como adicionar um campo personalizado ao meu registro

98

Eu uso o appender log4net.Appender.AdoNetAppender.
Minha tabela log4net são os seguintes campos[Date],[Thread],[Level],[Logger],[Message],[Exception]

Eu precisaria adicionar outro campo à tabela log4net (por exemplo, SalesId), mas como especificaria no meu xml e no código para registrar o "SalesId" ao registrar uma mensagem de erro ou de informação?

por exemplo log.Info("SomeMessage", SalesId)

Aqui está o 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>
Eminem
fonte

Respostas:

190

1) Modifique o texto do comando: INSERT INTO Log4Net ([Date],[Thread],[Level],[Logger],[Message],[Exception],[MyColumn]) VALUES (@log_date, @thread, @log_level, @logger, @message, @exception, @CustomColumn)

2) Adicione a definição do parâmetro para a coluna personalizada:

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

3) Em seguida, use um dos contextos do log4net para transferir valores para o parâmetro:

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

// ...or global properties
log4net.GlobalContext.Properties["CustomColumn"] = "Custom value";
Marcelo De Zen
fonte
2
Alguém pode sugerir qual contexto é o melhor para registrar os recursos do navegador.
VivekDev
1
@DumbDev, normalmente você usará o contexto Thread. O GlobalContext é útil para definir propriedades que não mudam com muita frequência.
Marcelo De Zen
1
Você deve ter muito cuidado ao usar o ThreadContext em um aplicativo da Web, pois eles tendem a pular threads e o ThreadContext não será movido junto com ele.
Robba
4
@theberserker LogicalThreadContextpode ser usado com o Tarefas, mas não pode ser usado ThreadContext, porque ele sempre está vinculado a um determinado tópico.
Marcelo De Zen
5
É minha opinião, mas parece um pouco estranho dessa forma, eu esperava uma sobrecarga que levasse mais argumentos para adicionar à nova instância LoggingEvent.
A77
6

Três tipos de contexto de registro disponíveis no Log4Net.

  1. Log4Net.GlobalContext: - Este contexto é compartilhado por todos os encadeamentos e domínios do aplicativo. Se dois encadeamentos definirem a mesma propriedade no GlobalContext, um valor substituirá o outro.

  2. Log4Net.ThreadContext: - Este escopo de contexto limitado ao thread de chamada. Aqui, dois threads podem definir a mesma propriedade com valores diferentes sem substituir um ao outro.

  3. Log4Net.ThreadLogicalContext: - Este contexto se comporta de forma semelhante ao ThreadContext. se estiver trabalhando com um algoritmo de pool de threads customizado ou hospedando o CLR, você pode encontrar alguma utilidade para este.

Adicione o seguinte código ao seu arquivo 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) Adicione a definição do parâmetro para a coluna personalizada:

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

Aqui está uma versão funcional com algumas preferências personalizadas. Eu adicionei uma coluna personalizada para armazenar um código de exceção gerado.

1) Adicione sua coluna personalizada (exceptionCode aqui) para a configuração 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 // Aproveite seu logger com a nova coluna! :)

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;
        }
    }
}

referências:

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

Ali Karaca
fonte