Jak prawidłowo zarządzać cyklem życia logów utworzonych za pomocą wtyczek za pomocą logowania Java z log4j2

Question

Mój zespół pracuje nad wtyczką do NetBeans, która używa logowania do określonego pliku. System rejestrowania wykorzystuje SLF4J + Log4J2; tylko informacje o konfiguracji, że jestem świadomy jest plikiem log4j2.xml z właściwości rejestrowania dla wtyczki i dodaje:

LoggerContext loggerContext = (LoggerContext)LogManager.getContext(false); 
    loggerContext.reconfigure(); 

(Fakt, że używam slf4j i NetBeans naprawdę nie jest istotne tutaj).

Pytanie, które mam, to, jaki jest właściwy sposób rozpoczęcia rejestrowania po uruchomieniu wtyczki i zatrzymaniu rejestrowania po wyjściu wtyczki? (JVM utrzymuje się na zabawę z NetBeans więc pliki dziennika nie są automatycznie zamykane.)

Spojrzałam LoggerContext i widzę stop() i terminate() metod, ale nie mogę znaleźć żadnej dokumentacji, jak aplikacje mają używać LoggerContext , więc nie wiem, czy ten materiał jest wewnętrznym szczegółem, czy czymś, co powinna użyć aplikacja.

---

Niektóre bardziej specyficzne szczegóły:

Nasz plugin cyklu wyglądał na poniższym wykresie (tylko jedna instancja jest dopuszczalne, aby uruchomić na raz). "A" i "B" odnoszą się do konfiguracji logów, które chcielibyśmy zastosować.

 [Something starts within the JVM to load log4j classes first. 
     It might be our plugin, it might be something else. 
A  log4j's default mechanism kicks in to create log configuration A] 
| 
| [time passes] 
| 
| [our plugin starts] 
A [log4j classes first loaded, 
| default mechanism kicks in to create log configuration A] 
A setup log configuration B 
A B log event 1 
A B log event 2 
A B log event 3 
A shutdown log configuration B 
| [our plugin exits] 
| 
| [time passes] 
| 
| [our plugin starts] 
A setup log configuration B 
A B log event 1 
A B log event 2 
A B log event 3 
A shutdown log configuration B 
| [our plugin exits] 
| 
| [time passes] 
| 
    [JVM exits] 

Konfiguracja A jest skojarzona z JVM i jest domyślną konfiguracją utworzoną przez log4j przy pierwszym ładowaniu przez maszynę JVM.

Konfiguracja B jest zarządzana programowo przez wtyczkę i powinna mieć jawne uruchomienie/wyłączenie niezależnie od konfiguracji A (i nie powinno to wpłynąć na konfigurację A).

Czy jest jakiś sposób osiągnięcia tego z log4j 2.0?

Answer 1

W Log4j 2.5 można wywołać Configurator.shutdown(). Za pomocą Log4j 2.6 możesz wywołać LogManager.shutdown().

Answer 2

Można bezpiecznie używać oddzielnych LoggerContext s dla różnych składników aplikacji.

terminate() i stop() są całkowicie identyczne. W rzeczywistości ten pierwszy po prostu nazywa to drugie i nic więcej nie robi. terminate() jest częścią własnego api LoggerContext, a stop() jest częścią szerszego interfejsu LifeCycle.

Jeśli chcesz odpowiednio rozdzielić konteksty rejestrowania, użyj mechanizmu selektorów kontekstowych. Lo4j2 udostępnia interfejs ContextSelector dla klas odpowiedzialnych za wybór kontekstu, który zostanie zwrócony przez LogManager.getContext(). Istnieje kilka implementacji po wyjęciu z pudełka:

• BasicContextSelector wybiera kontekst na podstawie bieżącego wątku.
• BundleContextSelector do używania w środowisku OSGI.
• JndiContextSelector dla wielu aplikacji internetowych w jednym kontenerze serwletów.
• ClassLoaderContextSelector wybiera kontekst na podstawie programu ładującego klasy dzwoniącego.

Aby określić, którego selektora chcesz użyć, ustaw opcję Java Log4jContextSelector.

Na przykład, jeśli wtyczki uruchamiane w osobnych wątkach, można wybrał BasicContextSelector:

-DLog4jContextSelector=org.apache.logging.log4j.core.selector.BasicContextSelector 

i używać oddzielnych LoggerContext s dla ciebie plugins ten sposób (kod ten musi być prowadzony w wątku Wtyczka jest):

// Create a separate context for the plugin 
LoggerContext pluginContext = new LoggerContext("PluginContext"); 

// Setup pluginContext... 

// BasicContextSelector uses ContextAnchor.THREAD_CONTEXT 
// to bind contexts to threads: 
ContextAnchor.THREAD_CONTEXT.set(pluginContext); 

// Your plugin works and has access to your logging context 
LogManager.getContext(false); // Returns pluginContext 

// Stop and remove the plugin's logging context 
pluginContext.stop(); 
ContextAnchor.THREAD_CONTEXT.set(null); 

zależności od architektury swoich wtyczek, można użyć jednego z tych implementacji lub dostarczyć własne, jest to dość proste, to po prostu trzeba wdrożyć następujące metody:

• getContext() do tworzenia nowych kontekstów (lub zwracania istniejących) w oparciu o parametry dostarczone do LogManager.getContext(...).
• getLoggerContexts(), aby zwrócić kolekcję dostępnych kontekstów (te, które zostały wcześniej utworzone).
• removeContext() do usuwania kontekstów z pamięci, gdy są zatrzymane (zakończone).