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

Add Throwable "cause" variants to warning log API

Browse source 
Add default implementation of 2-ary notifyWarning for compatibility
This commit is contained in:
emanb29 2021-07-10 23:01:55 -07:00 • committed by Patrik Nordwall
parent 12ecd42989
commit 044bb2dc0a
2 changed files with 57 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -26,6 +26,7 @@ import java.time.Duration;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
public class LoggingAdapterTest extends JUnitSuite {
@ -158,8 +159,9 @@ public class LoggingAdapterTest extends JUnitSuite {
assertEquals(level, log.level());
assertEquals(mdc, log.getMDC().toString());
if (cause != null) {
Error error = (Error) log;
assertSame(cause, error.cause());
assertTrue(event instanceof LogEventWithCause);
LogEventWithCause causedEvent = (LogEventWithCause) event;
assertSame(cause, causedEvent.cause());
}
return null;
});

58
akka-actor/src/main/scala/akka/event/Logging.scala
View file

@ -1199,6 +1199,7 @@ trait LoggingAdapter {
protected def notifyError(message: String): Unit
protected def notifyError(cause: Throwable, message: String): Unit
protected def notifyWarning(message: String): Unit
protected def notifyWarning(@unused cause: Throwable, message: String): Unit = notifyWarning(message)
protected def notifyInfo(message: String): Unit
protected def notifyDebug(message: String): Unit
@ -1286,6 +1287,49 @@ trait LoggingAdapter {
if (isErrorEnabled) notifyError(format(template, arg1, arg2, arg3, arg4))
}
/**
* Log message at warning level, including the exception that indicated the warning.
* @see [[LoggingAdapter]]
*/
def warning(cause: Throwable, message: String): Unit = {
if (isWarningEnabled) notifyWarning(cause, message)
}
/**
* Message template with 1 replacement argument.
*
* If `arg1` is an `Array` it will be expanded into replacement arguments, which is useful when
* there are more than four arguments.
* @see [[LoggingAdapter]]
*/
def warning(cause: Throwable, template: String, arg1: Any): Unit = {
if (isWarningEnabled) notifyWarning(cause, format1(template, arg1))
}
/**
* Message template with 2 replacement arguments.
* @see [[LoggingAdapter]]
*/
def warning(cause: Throwable, template: String, arg1: Any, arg2: Any): Unit = {
if (isWarningEnabled) notifyWarning(cause, format(template, arg1, arg2))
}
/**
* Message template with 3 replacement arguments.
* @see [[LoggingAdapter]]
*/
def warning(cause: Throwable, template: String, arg1: Any, arg2: Any, arg3: Any): Unit = {
if (isWarningEnabled) notifyWarning(cause, format(template, arg1, arg2, arg3))
}
/**
* Message template with 4 replacement arguments.
* @see [[LoggingAdapter]]
*/
def warning(cause: Throwable, template: String, arg1: Any, arg2: Any, arg3: Any, arg4: Any): Unit = {
if (isWarningEnabled) notifyWarning(cause, format(template, arg1, arg2, arg3, arg4))
}
/**
* Log message at warning level.
* @see [[LoggingAdapter]]
@ -1975,15 +2019,17 @@ class BusLogging(val bus: LoggingBus, val logSource: String, val logClass: Class
def isInfoEnabled = loggingFilter.isInfoEnabled(logClass, logSource)
def isDebugEnabled = loggingFilter.isDebugEnabled(logClass, logSource)
protected def notifyError(message: String): Unit =
override protected def notifyError(message: String): Unit =
bus.publish(Error(logSource, logClass, message, mdc))
protected def notifyError(cause: Throwable, message: String): Unit =
override protected def notifyError(cause: Throwable, message: String): Unit =
bus.publish(Error(cause, logSource, logClass, message, mdc))
protected def notifyWarning(message: String): Unit =
override protected def notifyWarning(message: String): Unit =
bus.publish(Warning(logSource, logClass, message, mdc))
protected def notifyInfo(message: String): Unit =
override protected def notifyWarning(cause: Throwable, message: String): Unit =
bus.publish(Warning(cause, logSource, logClass, message, mdc))
override protected def notifyInfo(message: String): Unit =
bus.publish(Info(logSource, logClass, message, mdc))
protected def notifyDebug(message: String): Unit =
override protected def notifyDebug(message: String): Unit =
bus.publish(Debug(logSource, logClass, message, mdc))
}
@ -2006,6 +2052,7 @@ object NoLogging extends LoggingAdapter {
final protected override def notifyError(message: String): Unit = ()
final protected override def notifyError(cause: Throwable, message: String): Unit = ()
final protected override def notifyWarning(message: String): Unit = ()
final protected override def notifyWarning(cause: Throwable, message: String): Unit = ()
final protected override def notifyInfo(message: String): Unit = ()
final protected override def notifyDebug(message: String): Unit = ()
}
@ -2029,6 +2076,7 @@ object NoMarkerLogging extends MarkerLoggingAdapter(null, "source", classOf[Stri
final protected override def notifyError(message: String): Unit = ()
final protected override def notifyError(cause: Throwable, message: String): Unit = ()
final protected override def notifyWarning(message: String): Unit = ()
final protected override def notifyWarning(cause: Throwable, message: String): Unit = ()
final protected override def notifyInfo(message: String): Unit = ()
final protected override def notifyDebug(message: String): Unit = ()
final override def error(marker: LogMarker, cause: Throwable, message: String): Unit = ()