Skip to content

Commit

Permalink
add support for Log4J 2 like for Log4J
Browse files Browse the repository at this point in the history
  • Loading branch information
evernat committed Jan 3, 2016
1 parent 6eff218 commit 068139d
Show file tree
Hide file tree
Showing 10 changed files with 233 additions and 3 deletions.
2 changes: 2 additions & 0 deletions javamelody-core/build.xml
Expand Up @@ -65,6 +65,8 @@
<include name="xwork-2.1.0.jar" />
<include name="xstream-1.4.2.jar" />
<include name="log4j-1.2.16.jar" />
<include name="log4j-api-2.5.jar" />
<include name="log4j-core-2.5.jar" />
<include name="slf4j-api-1.5.11.jar" />
<include name="logback-classic-0.9.19.jar" />
<include name="logback-core-0.9.19.jar" />
Expand Down
6 changes: 6 additions & 0 deletions javamelody-core/pom.xml
Expand Up @@ -98,6 +98,12 @@
<version>1.2.16</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.5</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
Expand Down
Expand Up @@ -283,6 +283,11 @@ private static void initLogs() {
Log4JAppender.getSingleton().register();
}

if (LOG.LOG4J2_ENABLED) {
// si log4j2 est disponible on branche aussi l'appender pour le counter de logs
Log4J2Appender.getSingleton().register();
}

if (LOG.LOGBACK_ENABLED) {
// si logback est disponible on branche aussi l'appender pour le counter de logs
LogbackAppender.getSingleton().register();
Expand Down
14 changes: 14 additions & 0 deletions javamelody-core/src/main/java/net/bull/javamelody/LOG.java
Expand Up @@ -31,6 +31,7 @@
*/
final class LOG {
static final boolean LOG4J_ENABLED = isLog4jEnabled();
static final boolean LOG4J2_ENABLED = isLog4j2Enabled();
static final boolean LOGBACK_ENABLED = isLogbackEnabled();

static final int MAX_DEBUGGING_LOGS_COUNT = 50;
Expand Down Expand Up @@ -137,6 +138,17 @@ private static boolean isLog4jEnabled() {
}
}

private static boolean isLog4j2Enabled() {
try {
Class.forName("org.apache.logging.log4j.Logger");
// v2.4.1 is needed, so check ConfigurationBuilder which exists since v2.4
Class.forName("org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder");
return true;
} catch (final Throwable e) { // NOPMD
return false;
}
}

private static boolean isLogbackEnabled() {
try {
Class.forName("ch.qos.logback.classic.Logger");
Expand Down Expand Up @@ -167,6 +179,8 @@ private static JavaMelodyLogger getJavaMelodyLogger() {
// sinon, on prend selon ce qui est présent Logback ou Log4J ou java.util.logging
if (LOGBACK_ENABLED) {
return new LogbackLogger();
} else if (LOG4J2_ENABLED) {
return new Log4J2Logger();
} else if (LOG4J_ENABLED) {
return new Log4JLogger();
} else {
Expand Down
116 changes: 116 additions & 0 deletions javamelody-core/src/main/java/net/bull/javamelody/Log4J2Appender.java
@@ -0,0 +1,116 @@
/*
* Copyright 2008-2016 by Emeric Vernat
*
* This file is part of Java Melody.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.bull.javamelody;

import java.io.Serializable;

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.AbstractConfiguration;
import org.apache.logging.log4j.core.config.LoggerConfig;
import org.apache.logging.log4j.core.filter.ThresholdFilter;
import org.apache.logging.log4j.core.layout.PatternLayout;

/**
* Appender pour les logs de log4j2, configuré automatiquement par {@link MonitoringFilter}.
* @author Emeric Vernat
*/
public class Log4J2Appender extends AbstractAppender {
private static final long serialVersionUID = 1L;
private static final String MESSAGE_PATTERN = "%-5p [%c] %m%n";
private static final Level THRESHOLD = Level.WARN;

private static final String APPENDER_NAME = Log4J2Appender.class.getName();
private static final PatternLayout LAYOUT = PatternLayout.createLayout(MESSAGE_PATTERN, null,
null, null, null, true, true, null, null);
private static final ThresholdFilter FILTER = ThresholdFilter.createFilter(THRESHOLD, null,
null);

private static final Log4J2Appender SINGLETON = new Log4J2Appender();

/**
* Constructeur.
*/
public Log4J2Appender() {
this(APPENDER_NAME, FILTER, LAYOUT);
}

/**
* Constructeur.
* @param name String
* @param filter Filter
* @param layout Layout
*/
public Log4J2Appender(final String name, final Filter filter,
final Layout<? extends Serializable> layout) {
super(name, filter, layout, true);
}

static Log4J2Appender getSingleton() {
return SINGLETON;
}

void register() {
if (LogManager.getContext(false) instanceof LoggerContext) {
final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
if (ctx.getConfiguration() instanceof AbstractConfiguration) {
final AbstractConfiguration config = (AbstractConfiguration) ctx.getConfiguration();
final Appender appender = getSingleton();
appender.start();
config.addAppender(appender);
final Logger rootLogger = LogManager.getRootLogger();
final LoggerConfig loggerConfig = config.getLoggerConfig(rootLogger.getName());
loggerConfig.addAppender(appender, null, null);
ctx.updateLoggers();
}
}
}

void deregister() {
if (LogManager.getContext(false) instanceof LoggerContext) {
final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
if (ctx.getConfiguration() instanceof AbstractConfiguration) {
final AbstractConfiguration config = (AbstractConfiguration) ctx.getConfiguration();
final Appender appender = getSingleton();
appender.stop();
config.removeAppender(appender.getName());
final Logger rootLogger = LogManager.getRootLogger();
final LoggerConfig loggerConfig = config.getLoggerConfig(rootLogger.getName());
loggerConfig.removeAppender(appender.getName());
ctx.updateLoggers();
}
}
}

/**
* {@inheritDoc}
*/
@Override
public void append(final LogEvent event) {
final Throwable throwable = event.getThrown();
final String message = getLayout().toSerializable(event).toString();
LoggingHandler.addErrorLogToCounter(message, throwable);
}
}
@@ -0,0 +1,70 @@
/*
* Copyright 2008-2016 by Emeric Vernat
*
* This file is part of Java Melody.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.bull.javamelody;

import javax.servlet.http.HttpServletRequest;

/**
* JavaMelodyLogger pour Log4J 2.
* @author Emeric Vernat
*/
class Log4J2Logger implements JavaMelodyLogger {
private static final org.apache.logging.log4j.Logger LOGGER = org.apache.logging.log4j.LogManager
.getLogger(INTERNAL_LOGGER_NAME);

/** {@inheritDoc} */
@Override
public void info(String msg) {
LOGGER.info(msg);
}

/** {@inheritDoc} */
@Override
public void info(String msg, Throwable throwable) {
LOGGER.info(msg, throwable);
}

/** {@inheritDoc} */
@Override
public void warn(String msg, Throwable throwable) {
LOGGER.warn(msg, throwable);
}

/** {@inheritDoc} */
@Override
public void debug(String msg) {
LOGGER.debug(msg);
}

/** {@inheritDoc} */
@Override
public void debug(String msg, Throwable throwable) {
LOGGER.debug(msg, throwable);
}

/** {@inheritDoc} */
@Override
public void logHttpRequest(HttpServletRequest httpRequest, String requestName, long duration,
boolean systemError, int responseSize, String loggerName) {
final org.apache.logging.log4j.Logger logger = org.apache.logging.log4j.LogManager
.getLogger(loggerName);
if (logger.isInfoEnabled()) {
logger.info(LOG.buildLogMessage(httpRequest, duration, systemError, responseSize));
}
}
}
17 changes: 16 additions & 1 deletion javamelody-core/src/test/java/net/bull/javamelody/TestLog.java
Expand Up @@ -25,6 +25,7 @@
import java.util.Collections;

import org.apache.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.LoggerFactory;
Expand All @@ -36,6 +37,7 @@
public class TestLog {
private LogbackAppender logbackAppender;
private Log4JAppender log4jAppender;
private Log4J2Appender log4j2Appender;
private LoggingHandler loggingHandler;

/** Initialisation. */
Expand All @@ -44,13 +46,17 @@ public void setUp() {
Utils.initialize();
logbackAppender = new LogbackAppender();
log4jAppender = new Log4JAppender();
log4j2Appender = new Log4J2Appender();
loggingHandler = new LoggingHandler();
}

/** Test. */
@Test
public void testGetSingleton() {
assertNotNull("getSingleton not null", LogbackAppender.getSingleton());
assertNotNull("getSingleton not null", Log4J2Appender.getSingleton());
assertSame("getSingleton same", Log4J2Appender.getSingleton(),
Log4J2Appender.getSingleton());
assertNotNull("getSingleton not null", Log4JAppender.getSingleton());
assertSame("getSingleton same", Log4JAppender.getSingleton(), Log4JAppender.getSingleton());
assertNotNull("getSingleton not null", LoggingHandler.getSingleton());
Expand All @@ -67,13 +73,15 @@ public void testRegister() {
.list(Logger.getRootLogger().getAllAppenders()).size();
logbackAppender.register();
log4jAppender.register();
log4j2Appender.register();
loggingHandler.register();
final int countAppendersAfter = Collections
.list(Logger.getRootLogger().getAllAppenders()).size();
assertSame("register", countAppendersBefore + 1, countAppendersAfter);
} finally {
logbackAppender.deregister();
log4jAppender.deregister();
log4j2Appender.deregister();
loggingHandler.deregister();
}
}
Expand All @@ -98,11 +106,13 @@ public void testFlush() {
public void testDeregister() {
logbackAppender.register();
log4jAppender.register();
log4j2Appender.register();
loggingHandler.register();
final int countAppendersBefore = Collections.list(Logger.getRootLogger().getAllAppenders())
.size();
logbackAppender.deregister();
log4jAppender.deregister();
log4j2Appender.deregister();
loggingHandler.deregister();
final int countAppendersAfter = Collections.list(Logger.getRootLogger().getAllAppenders())
.size();
Expand All @@ -124,6 +134,7 @@ public void testAppend() {
try {
logbackAppender.register();
log4jAppender.register();
log4j2Appender.register();
loggingHandler.register();
final Counter logCounter = LoggingHandler.getLogCounter();
logCounter.clear();
Expand All @@ -135,18 +146,22 @@ public void testAppend() {
Logger.getRootLogger().info("test info log4j");
Logger.getRootLogger().warn("test warn log4j");
Logger.getRootLogger().warn("test warn log4j", new IllegalStateException("test"));
LogManager.getRootLogger().error("test error log4j 2");
LogManager.getRootLogger().error("test error log4j 2",
new IllegalStateException("test"));
java.util.logging.Logger.getLogger(java.util.logging.Logger.GLOBAL_LOGGER_NAME)
.warning("test 2");
java.util.logging.Logger.getLogger(java.util.logging.Logger.GLOBAL_LOGGER_NAME)
.info("test 3");
final int requestsCountAfter = logCounter.getRequestsCount();
// cela peut ne pas être égal si un autre thread a loggué des warnings en même temps
if (requestsCountAfter < requestsCountBefore + 3) {
if (requestsCountAfter < requestsCountBefore + 4) {
fail("testAppend failed, requests : " + logCounter.getRequests());
}
} finally {
logbackAppender.deregister();
log4jAppender.deregister();
log4j2Appender.deregister();
loggingHandler.deregister();
}
}
Expand Down
Binary file not shown.
Binary file not shown.
6 changes: 4 additions & 2 deletions javamelody-core/src/test/test-webapp/jsp/log.jsp
@@ -1,13 +1,15 @@
<%@page import="org.slf4j.LoggerFactory"%>
<%@page import="org.apache.log4j.Logger"%>
<%@page import="org.apache.logging.log4j.LogManager"%>
<%@ page session="false" %>

<%
Logger.getRootLogger().warn("test Log4J");
Logger.getLogger("test").warn("test Log4J");
LogManager.getLogger("test").error("test Log4J 2");
LoggerFactory.getLogger("test").warn("test Logback");
java.util.logging.Logger.getGlobal().warning("test java.util.logging");
%>

Warning logged in Log4J, and in Logback and in java.util.logging.
Warning logged in Log4J and in Log4J 2 and in Logback and in java.util.logging.
<br/>
<a href="../index.jsp">back</a>

0 comments on commit 068139d

Please sign in to comment.