Czy możesz skonfigurować log4net w kodzie zamiast używać pliku konfiguracyjnego?

136

Rozumiem, dlaczego log4net używa app.configplików do konfigurowania logowania - dzięki czemu możesz łatwo zmienić sposób rejestrowania informacji bez konieczności ponownej kompilacji kodu. Ale w moim przypadku nie chcę pakować app.configpliku z moim plikiem wykonywalnym. Nie mam ochoty modyfikować ustawień logowania.

Czy istnieje sposób, aby skonfigurować logowanie w kodzie zamiast używania app.config?

Oto mój prosty plik konfiguracyjny:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>
  <log4net>
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <file value="Logs\EventLog.txt" />
      <appendToFile value="false" />
      <rollingStyle value="Size" />
      <maxSizeRollBackups value="5" />
      <maximumFileSize value="1GB" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
      </layout>
    </appender>
    <appender name="MemoryAppender" type="log4net.Appender.MemoryAppender">
    </appender>
    <root>
      <level value="Info" />
      <appender-ref ref="RollingLogFileAppender" />
      <appender-ref ref="MemoryAppender" />
    </root>
  </log4net>
</configuration>

EDYTOWAĆ:

Żeby było jasne: moim celem jest brak pliku XML. Nawet jako zasób osadzony, który zamieniam w strumień. Moim celem było zdefiniowanie loggera całkowicie programowo. Ciekawe, czy to możliwe, a jeśli tak, gdzie mógłbym znaleźć przykład składni.

Michael Mankus
źródło

Odpowiedzi:

223

KOŃCOWE ROZWIĄZANIE: 1

Oto co zrobiłem dla każdego, kto może się na to natknąć w przyszłości. Zrobiłem klasę statyczną poniżej:

using log4net;
using log4net.Repository.Hierarchy;
using log4net.Core;
using log4net.Appender;
using log4net.Layout;

namespace Spectrum.Logging
{
    public class Logger
    {
        public static void Setup()
        {
            Hierarchy hierarchy = (Hierarchy)LogManager.GetRepository();

            PatternLayout patternLayout = new PatternLayout();
            patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
            patternLayout.ActivateOptions();

            RollingFileAppender roller = new RollingFileAppender();
            roller.AppendToFile = false;
            roller.File = @"Logs\EventLog.txt";
            roller.Layout = patternLayout;
            roller.MaxSizeRollBackups = 5;
            roller.MaximumFileSize = "1GB";
            roller.RollingStyle = RollingFileAppender.RollingMode.Size;
            roller.StaticLogFileName = true;            
            roller.ActivateOptions();
            hierarchy.Root.AddAppender(roller);

            MemoryAppender memory = new MemoryAppender();
            memory.ActivateOptions();
            hierarchy.Root.AddAppender(memory);

            hierarchy.Root.Level = Level.Info;
            hierarchy.Configured = true;
        }
    }
}

A potem wszystko, co musiałem zrobić, to zastąpić kod, w którym wywołałem plik XML, następującym wywołaniem:

//XmlConfigurator.Configure(new FileInfo("app.config")); // Not needed anymore
Logger.Setup();

1 (ta odpowiedź została zredagowana w pytaniu przez PO, pozwoliłem sobie uczynić ją odpowiedzią społeczności, zobacz tutaj dlaczego )

Philipp M
źródło
2
Uwaga, jeśli używasz zmiennych w łańcuchu roller.File, możesz użyć klasy log4net.Util.PatternString do sformatowania go przed przypisaniem wyniku do foller.File.
Eric Scherrer
1
Skończyło się na tym, że za pomocą tej metody otrzymałem zduplikowane wpisy dziennika. Rozwiązałem to, dodając "hierarchy.Root.RemoveAllAppenders ();" na początek Setup ().
Philip Bergström
4
Jak z tego wszystkiego mogę uzyskać ILog?
Mickey Perlstein
3
Nie działa dla mnie, chyba że zadzwonię, BasicConfigurator.Configure(hierarchy);zamiast tylko ustawić hierarchy.Configured = true;.
Eivind Gussiås Løkseth
3
Upewnij się, że proces, który ma być zapisywany w pliku dziennika, ma uprawnienia do zapisu w folderze, w którym ma być zapisywany plik dziennika. Aby zdiagnozować problemy z log4net, dodaj log4net.Util.LogLog.InternalDebugging = true;przed jakimkolwiek innym wywołaniem log4net, a następnie uruchom w debugerze i sprawdź dane wyjściowe. log4net powie ci, gdzie coś poszło nie tak.
Manfred,
12

Można też uciec XML całkowicie pisałem próbkę przy minimalnej konfiguracji programowej tutaj .

Krótko mówiąc, oto czego potrzebujesz

var tracer = new TraceAppender();
var hierarchy = (Hierarchy)LogManager.GetRepository();
hierarchy.Root.AddAppender(tracer);
var patternLayout = new PatternLayout {ConversionPattern = "%m%n"};
patternLayout.ActivateOptions();
tracer.Layout = patternLayout;
hierarchy.Configured = true;
oleksii
źródło
6
do czego służy klasa Hierarchy?
user20358
11

Tak, możesz skonfigurować log4net dzwoniąc:

log4net.Config.XmlConfigurator.Configure(XmlElement element)

Zobacz dokumentację log4net .

Joe
źródło
Link nie żyje
Toby Smith
@TobySmith - naprawiono.
Joe
4

Alternatywnie możesz utworzyć niestandardowy atrybut, który dziedziczy po log4net.Config.ConfiguratorAttribute i zakodować konfigurację w tym miejscu:

using log4net.Appender;
using log4net.Config;
using log4net.Core;
using log4net.Layout;
using log4net.Repository;
using log4net.Repository.Hierarchy;
using System;
using System.Reflection;

namespace ConsoleApplication1
{
    [AttributeUsage(AttributeTargets.Assembly)]
    public class MyConfiguratorAttribute : ConfiguratorAttribute
    {
        public MyConfiguratorAttribute()
            : base(0)
        {
        }

        public override void Configure(Assembly sourceAssembly, ILoggerRepository targetRepository)
        {
            var hierarchy = (Hierarchy)targetRepository;
            var patternLayout = new PatternLayout();
            patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
            patternLayout.ActivateOptions();

            var roller = new RollingFileAppender();
            roller.AppendToFile = false;
            roller.File = @"Logs\EventLog.txt";
            roller.Layout = patternLayout;
            roller.MaxSizeRollBackups = 5;
            roller.MaximumFileSize = "1GB";
            roller.RollingStyle = RollingFileAppender.RollingMode.Size;
            roller.StaticLogFileName = true;
            roller.ActivateOptions();
            hierarchy.Root.AddAppender(roller);

            hierarchy.Root.Level = Level.Info;
            hierarchy.Configured = true;
        }
    }
}

Następnie dodaj następujące elementy do pliku .cs:

[assembly: ConsoleApplication1.MyConfigurator]
Jas
źródło
1

Dla tych, którzy nie chcą dodawać appender do głównego rejestratora, ale do obecnego / innego loggera:

//somewhere you've made a logger
var logger = LogManager.GetLogger("MyLogger");

// now add appender to it
var appender = BuildMyAppender();
((log4net.Repository.Hierarchy.Logger)logger).AddAppender(appender);

logger.Debug("MyLogger with MyAppender must work now");

// and remove it later if this code executed multiple times (loggers are cached, so you'll get logger with your appender attached next time "MyLogger")
((log4net.Repository.Hierarchy.Logger)logger).RemoveAppender(sbAppender);
Vladislav Kostenko
źródło
0

Zaakceptowana odpowiedź działa po znalezieniu dwóch zastrzeżeń:

  • Na początku nie działało, ale po wykorzystaniu pełnej ścieżki absolutnej dla roller.Filenieruchomości, zaczęło działać.
  • Musiałem użyć tego w F # (w skrypcie FSX), więc miałem pewne problemy podczas konwertowania go z C #. Jeśli interesuje Cię wynik końcowy (w tym sposób pobrania pakietu nuget log4net), zobacz poniżej:

nuget_log4net.fsx:

#!/usr/bin/env fsharpi

open System
open System.IO
open System.Net

#r "System.IO.Compression.FileSystem"
open System.IO.Compression

type DummyTypeForLog4Net () =
    do ()

module NetTools =

    let DownloadNuget (packageId: string, packageVersion: string) =
    use webClient = new WebClient()
    let fileName = sprintf "%s.%s.nupkg" packageId packageVersion

    let pathToUncompressTo = Path.Combine("packages", packageId)
    if (Directory.Exists(pathToUncompressTo)) then
        Directory.Delete(pathToUncompressTo, true)
    Directory.CreateDirectory(pathToUncompressTo) |> ignore
    let fileToDownload = Path.Combine(pathToUncompressTo, fileName)

    let nugetDownloadUri = Uri (sprintf "https://www.nuget.org/api/v2/package/%s/%s" packageId packageVersion)
    webClient.DownloadFile (nugetDownloadUri, fileToDownload)

    ZipFile.ExtractToDirectory(fileToDownload, pathToUncompressTo)

let packageId = "log4net"
let packageVersion = "2.0.5"
NetTools.DownloadNuget(packageId, packageVersion)

let currentDirectory = Directory.GetCurrentDirectory()

// https://stackoverflow.com/a/19538654/6503091
#r "packages/log4net/lib/net45-full/log4net"

open log4net
open log4net.Repository.Hierarchy
open log4net.Core
open log4net.Appender
open log4net.Layout
open log4net.Config

let patternLayout = PatternLayout()
patternLayout.ConversionPattern <- "%date [%thread] %-5level %logger - %message%newline";
patternLayout.ActivateOptions()

let roller = RollingFileAppender()
roller.AppendToFile <- true
roller.File <- Path.Combine(currentDirectory, "someLog.txt")
roller.Layout <- patternLayout
roller.MaxSizeRollBackups <- 5
roller.MaximumFileSize <- "1GB"
roller.RollingStyle <- RollingFileAppender.RollingMode.Size
roller.StaticLogFileName <- true
roller.ActivateOptions ()

let hierarchy = box (LogManager.GetRepository()) :?> Hierarchy
hierarchy.Root.AddAppender (roller)

hierarchy.Root.Level <- Level.Info
hierarchy.Configured <- true
BasicConfigurator.Configure(hierarchy)

let aType = typedefof<DummyTypeForLog4Net>
let logger = LogManager.GetLogger(aType)

logger.Error(new Exception("exception test"))
ympostor
źródło