Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blocker Slf4j Logger Backer #762

Merged
merged 5 commits into from
Jul 25, 2023
Merged

Blocker Slf4j Logger Backer #762

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e012920
Blocker Slf4j Logger Backer
diogocanut Jun 14, 2023
2acda52
Fix: MiMa binary compatibility
diogocanut Jul 8, 2023
483be8a
Use Sync delay for checking configuration
diogocanut Jul 24, 2023
9612966
Interacting with MDC should not be blocking
diogocanut Jul 24, 2023
7a3b4f7
Creating new instance of class shouldn't be blocking
diogocanut Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions slf4j/src/main/scala/org/typelevel/log4cats/slf4j/Slf4jLogger.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ object Slf4jLogger extends Slf4jLoggerCompat {
def getLoggerFromSlf4j[F[_]: Sync](logger: JLogger): SelfAwareStructuredLogger[F] =
new Slf4jLoggerInternal.Slf4jLogger(logger)

def getLoggerFromBlockingSlf4j[F[_]: Sync](logger: JLogger): SelfAwareStructuredLogger[F] =
new Slf4jLoggerInternal.Slf4jLogger(logger, Sync.Type.Blocking)

def create[F[_]: Sync](implicit name: LoggerName): F[SelfAwareStructuredLogger[F]] =
Sync[F].delay(getLoggerFromName(name.value))

Expand All @@ -46,4 +49,7 @@ object Slf4jLogger extends Slf4jLoggerCompat {

def fromSlf4j[F[_]: Sync](logger: JLogger): F[SelfAwareStructuredLogger[F]] =
Sync[F].delay(getLoggerFromSlf4j[F](logger))

def fromBlockingSlf4j[F[_]: Sync](logger: JLogger): F[SelfAwareStructuredLogger[F]] =
Sync[F].blocking(getLoggerFromBlockingSlf4j[F](logger))
diogocanut marked this conversation as resolved.
Show resolved Hide resolved
}
60 changes: 31 additions & 29 deletions slf4j/src/main/scala/org/typelevel/log4cats/slf4j/internal/Slf4jLoggerInternal.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ private[slf4j] object Slf4jLoggerInternal {
private[this] def contextLog[F[_]](
isEnabled: F[Boolean],
ctx: Map[String, String],
logging: () => Unit
logging: () => Unit,
sync: Sync.Type
)(implicit F: Sync[F]): F[Unit] = {

val ifEnabled = F.delay {
val ifEnabled = F.suspend(sync) {
diogocanut marked this conversation as resolved.
Show resolved Hide resolved
val backup = MDC.getCopyOfContextMap()

for {
Expand All @@ -59,63 +60,64 @@ private[slf4j] object Slf4jLoggerInternal {
)
}

final class Slf4jLogger[F[_]](val logger: JLogger)(implicit F: Sync[F])
extends SelfAwareStructuredLogger[F] {
override def isTraceEnabled: F[Boolean] = F.delay(logger.isTraceEnabled)
override def isDebugEnabled: F[Boolean] = F.delay(logger.isDebugEnabled)
override def isInfoEnabled: F[Boolean] = F.delay(logger.isInfoEnabled)
override def isWarnEnabled: F[Boolean] = F.delay(logger.isWarnEnabled)
override def isErrorEnabled: F[Boolean] = F.delay(logger.isErrorEnabled)
final class Slf4jLogger[F[_]](val logger: JLogger, sync: Sync.Type = Sync.Type.Delay)(implicit
diogocanut marked this conversation as resolved.
Show resolved Hide resolved
F: Sync[F]
) extends SelfAwareStructuredLogger[F] {
override def isTraceEnabled: F[Boolean] = F.suspend(sync)(logger.isTraceEnabled)
override def isDebugEnabled: F[Boolean] = F.suspend(sync)(logger.isDebugEnabled)
override def isInfoEnabled: F[Boolean] = F.suspend(sync)(logger.isInfoEnabled)
override def isWarnEnabled: F[Boolean] = F.suspend(sync)(logger.isWarnEnabled)
override def isErrorEnabled: F[Boolean] = F.suspend(sync)(logger.isErrorEnabled)
diogocanut marked this conversation as resolved.
Show resolved Hide resolved

override def trace(t: Throwable)(msg: => String): F[Unit] =
isTraceEnabled
.ifM(F.delay(logger.trace(msg, t)), F.unit)
.ifM(F.suspend(sync)(logger.trace(msg, t)), F.unit)
override def trace(msg: => String): F[Unit] =
isTraceEnabled
.ifM(F.delay(logger.trace(msg)), F.unit)
.ifM(F.suspend(sync)(logger.trace(msg)), F.unit)
override def trace(ctx: Map[String, String])(msg: => String): F[Unit] =
contextLog(isTraceEnabled, ctx, () => logger.trace(msg))
contextLog(isTraceEnabled, ctx, () => logger.trace(msg), sync)
override def debug(t: Throwable)(msg: => String): F[Unit] =
isDebugEnabled
.ifM(F.delay(logger.debug(msg, t)), F.unit)
.ifM(F.suspend(sync)(logger.debug(msg, t)), F.unit)
override def debug(msg: => String): F[Unit] =
isDebugEnabled
.ifM(F.delay(logger.debug(msg)), F.unit)
.ifM(F.suspend(sync)(logger.debug(msg)), F.unit)
override def debug(ctx: Map[String, String])(msg: => String): F[Unit] =
contextLog(isDebugEnabled, ctx, () => logger.debug(msg))
contextLog(isDebugEnabled, ctx, () => logger.debug(msg), sync)
override def info(t: Throwable)(msg: => String): F[Unit] =
isInfoEnabled
.ifM(F.delay(logger.info(msg, t)), F.unit)
.ifM(F.suspend(sync)(logger.info(msg, t)), F.unit)
override def info(msg: => String): F[Unit] =
isInfoEnabled
.ifM(F.delay(logger.info(msg)), F.unit)
.ifM(F.suspend(sync)(logger.info(msg)), F.unit)
override def info(ctx: Map[String, String])(msg: => String): F[Unit] =
contextLog(isInfoEnabled, ctx, () => logger.info(msg))
contextLog(isInfoEnabled, ctx, () => logger.info(msg), sync)
override def warn(t: Throwable)(msg: => String): F[Unit] =
isWarnEnabled
.ifM(F.delay(logger.warn(msg, t)), F.unit)
.ifM(F.suspend(sync)(logger.warn(msg, t)), F.unit)
override def warn(msg: => String): F[Unit] =
isWarnEnabled
.ifM(F.delay(logger.warn(msg)), F.unit)
.ifM(F.suspend(sync)(logger.warn(msg)), F.unit)
override def warn(ctx: Map[String, String])(msg: => String): F[Unit] =
contextLog(isWarnEnabled, ctx, () => logger.warn(msg))
contextLog(isWarnEnabled, ctx, () => logger.warn(msg), sync)
override def error(t: Throwable)(msg: => String): F[Unit] =
isErrorEnabled
.ifM(F.delay(logger.error(msg, t)), F.unit)
.ifM(F.suspend(sync)(logger.error(msg, t)), F.unit)
override def error(msg: => String): F[Unit] =
isErrorEnabled
.ifM(F.delay(logger.error(msg)), F.unit)
.ifM(F.suspend(sync)(logger.error(msg)), F.unit)
override def error(ctx: Map[String, String])(msg: => String): F[Unit] =
contextLog(isErrorEnabled, ctx, () => logger.error(msg))
contextLog(isErrorEnabled, ctx, () => logger.error(msg), sync)
override def trace(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] =
contextLog(isTraceEnabled, ctx, () => logger.trace(msg, t))
contextLog(isTraceEnabled, ctx, () => logger.trace(msg, t), sync)
override def debug(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] =
contextLog(isDebugEnabled, ctx, () => logger.debug(msg, t))
contextLog(isDebugEnabled, ctx, () => logger.debug(msg, t), sync)
override def info(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] =
contextLog(isInfoEnabled, ctx, () => logger.info(msg, t))
contextLog(isInfoEnabled, ctx, () => logger.info(msg, t), sync)
override def warn(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] =
contextLog(isWarnEnabled, ctx, () => logger.warn(msg, t))
contextLog(isWarnEnabled, ctx, () => logger.warn(msg, t), sync)
override def error(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] =
contextLog(isErrorEnabled, ctx, () => logger.error(msg, t))
contextLog(isErrorEnabled, ctx, () => logger.error(msg, t), sync)
}
}