raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

+act #3671 Implementing support for MDC values defined by the application. Fixes #3671.

Browse source 
* Added LogEvent subclasses with new field for transporting the MDC custom values.
* Slf4jLogger now takes MDC values from new LogEvent field, puts all in MDC before appending the log, and removes all after.
* New trait DiagnosticLoggingAdapter was introduced, which extends LoggingAdapter and adds MDC support with methods to get, set and clear MDC values.
* New factory method added to Logging for getting loggers with MDC support.
* BusLogging was changed to create new LogEvents including the MDC values.
* Actors can mixin with DiagnosticActorLogging which defines a diagnostic logger "log", has a hook to override for defining MDC values per message, and overrides aroundReceive for setting and clearing MDC around receive execution.
* Proper documentation was added for Scala and Java under the Logging/Slf4j section.
This commit is contained in:
Gaston M. Tonietti 2013-10-18 01:10:10 -03:00
parent 05f402c236
commit 9e9d5541b4
12 changed files with 645 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

142
akka-actor-tests/src/test/java/akka/event/LoggingAdapterTest.java Normal file
View file

@ -0,0 +1,142 @@
package akka.event;
import akka.actor.ActorRef;
import akka.actor.ActorSystem;
import akka.actor.Props;
import akka.testkit.JavaTestKit;
import akka.event.Logging.Error;
import akka.event.ActorWithMDC.Log;
import static akka.event.Logging.*;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import org.junit.Test;
import scala.concurrent.duration.Duration;
import java.util.*;
import java.util.concurrent.TimeUnit;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
public class LoggingAdapterTest {
private static final Config config = ConfigFactory.parseString(
"akka.loglevel = DEBUG\n" +
"akka.actor.serialize-messages = off"
);
@Test
public void mustFormatMessage() {
final ActorSystem system = ActorSystem.create("test-system", config);
final LoggingAdapter log = Logging.getLogger(system, this);
new LogJavaTestKit(system) {{
system.eventStream().subscribe(getRef(), LogEvent.class);
log.error("One arg message: {}", "the arg");
expectLog(ErrorLevel(), "One arg message: the arg");
Throwable cause = new IllegalStateException("This state is illegal");
log.error(cause, "Two args message: {}, {}", "an arg", "another arg");
expectLog(ErrorLevel(), "Two args message: an arg, another arg", cause);
int[] primitiveArgs = {10, 20, 30};
log.warning("Args as array of primitives: {}, {}, {}", primitiveArgs);
expectLog(WarningLevel(), "Args as array of primitives: 10, 20, 30");
Date now = new Date();
UUID uuid = UUID.randomUUID();
Object[] objArgs = {"A String", now, uuid};
log.info("Args as array of objects: {}, {}, {}", objArgs);
expectLog(InfoLevel(), "Args as array of objects: A String, " + now.toString() + ", " + uuid.toString());
log.debug("Four args message: {}, {}, {}, {}", 1, 2, 3, 4);
expectLog(DebugLevel(), "Four args message: 1, 2, 3, 4");
}};
}
@Test
public void mustCallMdcForEveryLog() throws Exception {
final ActorSystem system = ActorSystem.create("test-system", config);
new LogJavaTestKit(system) {{
system.eventStream().subscribe(getRef(), LogEvent.class);
ActorRef ref = system.actorOf(Props.create(ActorWithMDC.class));
ref.tell(new Log(ErrorLevel(), "An Error"), system.deadLetters());
expectLog(ErrorLevel(), "An Error", "Map(messageLength -> 8)");
ref.tell(new Log(WarningLevel(), "A Warning"), system.deadLetters());
expectLog(WarningLevel(), "A Warning", "Map(messageLength -> 9)");
ref.tell(new Log(InfoLevel(), "Some Info"), system.deadLetters());
expectLog(InfoLevel(), "Some Info", "Map(messageLength -> 9)");
ref.tell(new Log(DebugLevel(), "No MDC for 4th call"), system.deadLetters());
expectLog(DebugLevel(), "No MDC for 4th call");
ref.tell(new Log(Logging.DebugLevel(), "And now yes, a debug with MDC"), system.deadLetters());
expectLog(DebugLevel(), "And now yes, a debug with MDC", "Map(messageLength -> 29)");
}};
}
@Test
public void mustSupportMdcNull() throws Exception {
final ActorSystem system = ActorSystem.create("test-system", config);
new LogJavaTestKit(system) {{
system.eventStream().subscribe(getRef(), LogEvent.class);
ActorRef ref = system.actorOf(Props.create(ActorWithMDC.class));
ref.tell(new Log(InfoLevel(), "Null MDC"), system.deadLetters());
expectLog(InfoLevel(), "Null MDC", "Map()");
}};
}
/*
* #3671: Let the application specify custom MDC values
* Java backward compatibility check
*/
@Test
public void mustBeAbleToCreateLogEventsWithOldConstructor() throws Exception {
assertNotNull(new Error(new Exception(), "logSource", this.getClass(), "The message"));
assertNotNull(new Error("logSource", this.getClass(), "The message"));
assertNotNull(new Warning("logSource", this.getClass(), "The message"));
assertNotNull(new Info("logSource", this.getClass(), "The message"));
assertNotNull(new Debug("logSource", this.getClass(), "The message"));
}
private static class LogJavaTestKit extends JavaTestKit {
private static final String emptyMDC = "Map()";
public LogJavaTestKit(ActorSystem system) {
super(system);
}
void expectLog(Object level, String message) {
expectLog(level, message, null, emptyMDC);
}
void expectLog(Object level, String message, Throwable cause) {
expectLog(level, message, cause, emptyMDC);
}
void expectLog(Object level, String message, String mdc) {
expectLog(level, message, null, mdc);
}
void expectLog(final Object level, final String message, final Throwable cause, final String mdc) {
new ExpectMsg<Void>(Duration.create(3, TimeUnit.SECONDS), "LogEvent") {
protected Void match(Object event) {
LogEvent log = (LogEvent) event;
assertEquals(message, log.message());
assertEquals(level, log.level());
assertEquals(mdc, log.mdc().toString());
if(cause != null) {
Error error = (Error) log;
assertSame(cause, error.cause());
}
return null;
}
};
}
}
}