Log4Net, comment ajouter un champ personnalisé à ma journalisation

98

J'utilise l'appender log4net.Appender.AdoNetAppender.
Ma table log4net sont les champs suivants[Date],[Thread],[Level],[Logger],[Message],[Exception]

J'aurais besoin d'ajouter un autre champ à la table log4net (par exemple SalesId), mais comment spécifierais-je dans mon xml et dans le code pour enregistrer le "SalesId" lors de la journalisation d'un message d'erreur ou d'information?

par exemple log.Info("SomeMessage", SalesId)

Voici le xml log4net

  <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>
c#  log4net  appender 
— Eminem
source

Réponses:

190

1) Modifiez le texte de la commande: INSERT INTO Log4Net ([Date],[Thread],[Level],[Logger],[Message],[Exception],[MyColumn]) VALUES (@log_date, @thread, @log_level, @logger, @message, @exception, @CustomColumn)

2) Ajoutez la définition de paramètre pour la colonne personnalisée:

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

3) Ensuite, utilisez l'un des contextes de log4net pour transférer des valeurs au paramètre:

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

// ...or global properties
log4net.GlobalContext.Properties["CustomColumn"] = "Custom value";
— Marcelo De Zen
source
2
Quelqu'un peut-il suggérer quel contexte est le meilleur pour enregistrer les capacités du navigateur?
— VivekDev
1
@DumbDev, vous utiliserez généralement le contexte Thread. Le GlobalContext est utile pour définir des propriétés qui ne changent pas très souvent.
— Marcelo De Zen
1
Vous devez être très prudent lorsque vous utilisez ThreadContext dans une application Web, car ceux-ci ont tendance à sauter les threads et le ThreadContext ne sera pas déplacé avec lui.
— Robba
4
@theberserker LogicalThreadContextpeut être utilisé avec Tasks, mais il n'est pas acceptable ThreadContext, car il est toujours lié à un thread particulier.
— Marcelo De Zen
5
C'est mon avis, mais cela semble un peu bizarre de cette façon, je m'attendais à une surcharge qui prend plus d'arguments à ajouter à la nouvelle instance de LoggingEvent ..
— A77
6

Trois types de contexte de journalisation disponibles dans Log4Net.

  1. Log4Net.GlobalContext: - Ce contexte partagé entre tous les threads et domaines d'application. Si deux threads définissent la même propriété sur GlobalContext, une valeur remplacera l'autre.

  2. Log4Net.ThreadContext: - Cette portée de contexte est limitée à l'appel de thread. Ici, deux threads peuvent définir la même propriété sur des valeurs différentes sans se substituer l'une à l'autre.

  3. Log4Net.ThreadLogicalContext: - Ce contexte se comporte de la même manière que ThreadContext. si vous travaillez avec un algorithme de pool de threads personnalisé ou hébergez le CLR, vous trouverez peut-être une utilité pour celui-ci.

Ajoutez le code suivant à votre fichier 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) Ajoutez la définition de paramètre pour la colonne personnalisée:

  <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
source
3

Voici une version fonctionnelle avec quelques préférences personnalisées. J'ai ajouté une colonne personnalisée pour stocker un code d'exception généré.

1) Ajoutez votre colonne personnalisée (exceptionCode ici) à la configuration 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 // Profitez de votre enregistreur avec la nouvelle colonne! :)

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

références:

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

— Ali Karaca
source
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.