Jaki jest najlepszy wzorzec do używania tego samego rejestratora Log4net w wielu złożeniach w rozwiązaniu?

Question

Mam rozwiązanie składające się z głównej aplikacji WinForm, z powiązanymi wewnętrznie napisanymi bibliotekami DLL klasy, z których chcę się logować. Rejestrowanie powinno być wykonywane przez ten sam program rejestrujący, niezależnie od tego, czy jest to główny klient UI lub powiązane z nim dll. Biblioteki DLL mogą oczywiście być używane przez inne aplikacje, które mają różne rejestratory w innych rozwiązaniach, ale w tych okolicznościach będą miały inną konfigurację log4net i być może inny zestaw dopełniaczy.

Jednym z podejść byłoby utworzenie singletonu w głównej aplikacji i zalogowanie się z niego, jednak ponieważ log4net jest jego własnym singletonem, do którego można się odwoływać, o ile przekazujemy ten sam ciąg (lub typ) do log4net.LogManager.GetLogger będziemy logować się do tego samego miejsca docelowego (w moim przypadku chcę użyć RollingFileAppender).

To działa. Jednak biorąc pod uwagę, że biblioteka DLL będzie miała kilka klas, oznaczałoby to, że każda instancja klasy lub klasa statyczna, z której chcemy się logować, wymagały i) argumentu definiującego nazwę rejestratora (w celu zalogowania się do tego samego miejsca docelowego) i ii) w każdym punkcie wejścia trzeba zadzwonić pod numer log4net.LogManager.GetLogger(loggerName).

Jaki jest najlepszy wzór do zastosowania? Czy właściwym podejściem byłoby stworzenie pojedynczej instancji w każdym zespole? Moją obawą jest to, że nadal będziemy musieli przekazać nazwę rejestratora do każdego punktu wejścia dla biblioteki dll, co wydaje się przesadą. Aby uniknąć podania nazwy rejestratora, mogę założyć, że zawsze jest równa System.Reflection.Assembly.GetCallingAssembly().GetName().Name.

Jeśli jest to zbyt trudne dla log4net, czy istnieją inne łatwiejsze rozwiązania, takie jak blok logowań Enterprise? A może najlepszym rozwiązaniem jest podejście zorientowane na aspekt (AOP)?

Reference for anti-pattern approach for singleton here.

Answer 1

Prawie rok później, ale pomyślałem, że i tak przyczynię się do tego!

Na podstawie Twojego komentarza do wpisu Carla, myślę, że może źle zrozumiałeś działanie log4net. Tak, loggername identyfikuje rejestrator. Tak, logger może mieć wielu aplikantów. ALE, wiele rejestratorów może również pisać do aplikacji SAME. Tak więc, możesz skonfigurować rejestratory "A", "B" i "C" dla wszystkich logów do pliku "X". Można uzyskać rejestratory tak:

ILog logger_a = LogManager.GetLogger("A"); 
ILog logger_b = LogManager.GetLogger("B"); 
ILog logger_c = LogManager.GetLogger("C"); 

Teraz, jeśli log z któregokolwiek z tych rejestratorów, wszystkie one mogą iść w tym samym miejscu (plik „X”) Jeśli skonfigurowano je w ten sposób.

Zaletą NIE używania tej samej nazwy rejestratora w aplikacji jest możliwość kontrolowania poziomu logowania w różnych miejscach aplikacji za pośrednictwem pliku konfiguracyjnego. Tak więc, jeśli kod, który używa rejestratorów "A" i "B" działa dobrze, ale kod, który używa logger "C" ma problem, możesz wyłączyć "A" i "B", i włączyć " C "do samego końca. W ten sposób będziesz miał mniej informacji do przebicia, aby znaleźć swój problem.

Większość ludzi (lub przynajmniej większość przykładów log4net) faktycznie tworzy instancję statycznego rejestratora dla każdego CLASS, nazwanego dla tej klasy (nie pamiętam dokładnej składni, ale łatwo jest znaleźć przykłady). Zapewnia to bardzo wysoki poziom szczegółowości w kontrolowaniu rejestrowania.

W pliku app.config można kontrolować wszystkie rejestratory na tym samym poziomie, konfigurując pojedynczy program rejestrujący o nazwie "*" lub można skonfigurować określone rejestratory (przy użyciu w pełni kwalifikowanej nazwy) lub można nawet skonfigurować według części w pełni kwalifikowanego typu. Na przykład bardzo łatwo można utworzyć wszystkie klasy w dzienniku ABC obszaru nazw na poziomie "informacji", wszystkie klasy w dzienniku DEF przestrzeni nazw na poziomie "błędu", a wszystkie klasy w przestrzeni nazw GHI w ogóle się nie logują. I wszystkie te rejestratory mogą logować się do tego samego miejsca docelowego (np. Plik X).

mogło być za późno, aby pomóc, ale być może nie ...

Answer 2

Domyślam się, że możesz mieć nazwę LoggerName w pliku app.config.

Czy mogę zapytać, dlaczego nazwa logger musi być taka sama dla całej aplikacji?

Answer 3

Zastosowaliśmy podejście do używania log4net podobnego do tego.

Używamy log4net zarówno w głównych zestawach bibliotek aplikacji, jak i klas. Napisaliśmy wokół niego klasę opakowującą, dzięki czemu wszystkie rejestracje pojawiają się z taką samą konfiguracją z dowolnego miejsca, w którym ją nazywamy, a także w celu zapewnienia, że ​​jest to singleton. Ta klasa opakowania jest wywoływana z dowolnego miejsca w naszej aplikacji.

W rezultacie biblioteki klas i główna aplikacja wylogowują się do tego samego pliku dziennika o tej samej konfiguracji, co jest tym, czego chcieliśmy. Czy to właśnie chciałeś osiągnąć?

Answer 4

Najpierw należy utworzyć klasę opakowania (aby oddzielić aplikację od dostawcy rejestrowania).

Ta klasa opakowania może przyjąć identyfikator rejestratora. Jeśli korzystasz z kontenera IoC, możesz po prostu wprowadzić nazwę rejestratora lub istniejącą, wstępnie skonfigurowaną instancję.

Jeśli używasz Jedności (inne pojemniki są podobne), można zrobić coś takiego

// During application initialization 
IUnityContainer myContainer = new UnityContainer(); 
LoggingService concreteLoggingService = new LoggingService("logID"); 
myContainer.RegisterInstance<ILoggingService>(concreteLoggingService); 

// This would be injected, so you wouldn't see this, but it's here for consistency 
ILoggingService loggingService = myContainer.Resolve<ILoggingService>(); 
loggingService.LogMessage("message"); 

Teraz ta zakłada masz kontenera IoC.Alternatywnie można utworzyć lokalizator usług:

// During application initialization 
ServiceLocator.Register<ILoggingService>(new LoggingService("logID")); 

// Retrieved as needed 
ILoggingService loggingServce = LoggingServiceLocator.Locate<ILoggingService>(); 
loggingService.LogMessage("message"); 

W drugim przypadku należy wpisać cały kod instalacyjny. W przypadku kontenera IoC otrzymasz go natychmiast po wyjęciu z opakowania.

Answer 5

Co powiesz na wdrożenie własnego TraceListener, abyś mógł używać aplikacji Trace.Write w całej aplikacji?

Answer 6

nigdy nie widziałem innego, wzór sensowne, użytkowaniu niż ten dla log4net:

Na górze każdej klasy, która potrzebuje rejestrowanie, do:

private static ILog Log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); 

w warstwach gospodarza AssemblyInfo.cs, należy:

[assembly: log4net.Config.XmlConfigurator] 

Podczas uruchamiania komputera uruchom programową konfigurację aplikacji itd. Lub użyj prostej konfiguracji app.config.

Koniec historii. Brak opakowań. Brak wyprowadzenia z powyższego.

Każdy inny wzorzec użycia, na który natknąłem się, ma na celu obejście nie do końca zrozumiałego doprecyzowania log4net, w tym niektórych/wszystkich odpowiedzi tutaj.