|
| 1 | +/* |
| 2 | + * Copyright 2018 Typelevel |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.typelevel.log4cats |
| 18 | + |
| 19 | +import cats.mtl.{LiftKind, Local} |
| 20 | +import cats.syntax.functor.* |
| 21 | +import cats.{~>, Monad, Show} |
| 22 | + |
| 23 | +sealed trait LocalLogger[F[_]] extends SelfAwareLogger[F] { |
| 24 | + def withAddedContext[A](ctx: Map[String, String])(fa: F[A]): F[A] |
| 25 | + |
| 26 | + def withAddedContext[A](ctx: (String, Show.Shown)*)(fa: F[A]): F[A] |
| 27 | + |
| 28 | + def error(ctx: Map[String, String])(msg: => String): F[Unit] |
| 29 | + def error(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] |
| 30 | + def warn(ctx: Map[String, String])(msg: => String): F[Unit] |
| 31 | + def warn(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] |
| 32 | + def info(ctx: Map[String, String])(msg: => String): F[Unit] |
| 33 | + def info(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] |
| 34 | + def debug(ctx: Map[String, String])(msg: => String): F[Unit] |
| 35 | + def debug(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] |
| 36 | + def trace(ctx: Map[String, String])(msg: => String): F[Unit] |
| 37 | + def trace(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] |
| 38 | + |
| 39 | + @deprecated( |
| 40 | + "use the overload that takes a `LiftKind` and `Monad` instead", |
| 41 | + since = "2.8.0" |
| 42 | + ) |
| 43 | + override def mapK[G[_]](fk: F ~> G): SelfAwareLogger[G] = super.mapK(fk) |
| 44 | + |
| 45 | + def liftTo[G[_]](implicit lift: LiftKind[F, G], G: Monad[G]): LocalLogger[G] |
| 46 | + |
| 47 | + override def withModifiedString(f: String => String): LocalLogger[F] |
| 48 | + |
| 49 | + @deprecated( |
| 50 | + "`StructuredLogger` is cumbersome and lacks `cats.mtl.Local` semantics", |
| 51 | + since = "2.8.0" |
| 52 | + ) |
| 53 | + def asStructuredLogger: SelfAwareStructuredLogger[F] |
| 54 | +} |
| 55 | + |
| 56 | +object LocalLogger { |
| 57 | + private[this] final class Impl[F[_]]( |
| 58 | + localLogContext: LocalLogContext[F], |
| 59 | + underlying: SelfAwareStructuredLogger[F] |
| 60 | + )(implicit F: Monad[F]) |
| 61 | + extends LocalLogger[F] |
| 62 | + with SelfAwareStructuredLogger[F] { |
| 63 | + def withAddedContext[A](ctx: Map[String, String])(fa: F[A]): F[A] = |
| 64 | + localLogContext.withAddedContext(ctx)(fa) |
| 65 | + def withAddedContext[A](ctx: (String, Show.Shown)*)(fa: F[A]): F[A] = |
| 66 | + localLogContext.withAddedContext(ctx*)(fa) |
| 67 | + |
| 68 | + override def addContext(ctx: Map[String, String]): Impl[F] = |
| 69 | + new Impl(localLogContext, underlying.addContext(ctx)) |
| 70 | + override def addContext(pairs: (String, Show.Shown)*): Impl[F] = |
| 71 | + new Impl(localLogContext, underlying.addContext(pairs*)) |
| 72 | + |
| 73 | + def isErrorEnabled: F[Boolean] = underlying.isErrorEnabled |
| 74 | + def isWarnEnabled: F[Boolean] = underlying.isWarnEnabled |
| 75 | + def isInfoEnabled: F[Boolean] = underlying.isInfoEnabled |
| 76 | + def isDebugEnabled: F[Boolean] = underlying.isDebugEnabled |
| 77 | + def isTraceEnabled: F[Boolean] = underlying.isTraceEnabled |
| 78 | + |
| 79 | + @deprecated( |
| 80 | + "use the overload that takes a `LiftKind` and `Monad` instead", |
| 81 | + since = "2.8.0" |
| 82 | + ) |
| 83 | + override def mapK[G[_]](fk: F ~> G): SelfAwareStructuredLogger[G] = |
| 84 | + super.mapK(fk) |
| 85 | + def liftTo[G[_]](implicit lift: LiftKind[F, G], G: Monad[G]): LocalLogger[G] = |
| 86 | + new Impl(localLogContext.liftTo[G], underlying.mapK(lift)) |
| 87 | + override def withModifiedString(f: String => String): Impl[F] = |
| 88 | + new Impl(localLogContext, underlying.withModifiedString(f)) |
| 89 | + |
| 90 | + @deprecated( |
| 91 | + "`StructuredLogger` is cumbersome and lacks `cats.mtl.Local` semantics", |
| 92 | + since = "2.8.0" |
| 93 | + ) |
| 94 | + def asStructuredLogger: SelfAwareStructuredLogger[F] = this |
| 95 | + |
| 96 | + def error(message: => String): F[Unit] = |
| 97 | + F.ifM(underlying.isErrorEnabled)( |
| 98 | + for (localCtx <- localLogContext.currentLogContext) |
| 99 | + yield underlying.error(localCtx)(message), |
| 100 | + F.unit |
| 101 | + ) |
| 102 | + def error(t: Throwable)(message: => String): F[Unit] = |
| 103 | + F.ifM(underlying.isErrorEnabled)( |
| 104 | + for (localCtx <- localLogContext.currentLogContext) |
| 105 | + yield underlying.error(localCtx, t)(message), |
| 106 | + F.unit |
| 107 | + ) |
| 108 | + def error(ctx: Map[String, String])(msg: => String): F[Unit] = |
| 109 | + F.ifM(underlying.isErrorEnabled)( |
| 110 | + for (localCtx <- localLogContext.currentLogContext) |
| 111 | + yield underlying.error(localCtx ++ ctx)(msg), |
| 112 | + F.unit |
| 113 | + ) |
| 114 | + def error(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] = |
| 115 | + F.ifM(underlying.isErrorEnabled)( |
| 116 | + for (localCtx <- localLogContext.currentLogContext) |
| 117 | + yield underlying.error(localCtx ++ ctx, t)(msg), |
| 118 | + F.unit |
| 119 | + ) |
| 120 | + |
| 121 | + def warn(message: => String): F[Unit] = |
| 122 | + F.ifM(underlying.isWarnEnabled)( |
| 123 | + for (localCtx <- localLogContext.currentLogContext) |
| 124 | + yield underlying.warn(localCtx)(message), |
| 125 | + F.unit |
| 126 | + ) |
| 127 | + def warn(t: Throwable)(message: => String): F[Unit] = |
| 128 | + F.ifM(underlying.isWarnEnabled)( |
| 129 | + for (localCtx <- localLogContext.currentLogContext) |
| 130 | + yield underlying.warn(localCtx, t)(message), |
| 131 | + F.unit |
| 132 | + ) |
| 133 | + def warn(ctx: Map[String, String])(msg: => String): F[Unit] = |
| 134 | + F.ifM(underlying.isWarnEnabled)( |
| 135 | + for (localCtx <- localLogContext.currentLogContext) |
| 136 | + yield underlying.warn(localCtx ++ ctx)(msg), |
| 137 | + F.unit |
| 138 | + ) |
| 139 | + def warn(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] = |
| 140 | + F.ifM(underlying.isWarnEnabled)( |
| 141 | + for (localCtx <- localLogContext.currentLogContext) |
| 142 | + yield underlying.warn(localCtx ++ ctx, t)(msg), |
| 143 | + F.unit |
| 144 | + ) |
| 145 | + |
| 146 | + def info(message: => String): F[Unit] = |
| 147 | + F.ifM(underlying.isInfoEnabled)( |
| 148 | + for (localCtx <- localLogContext.currentLogContext) |
| 149 | + yield underlying.info(localCtx)(message), |
| 150 | + F.unit |
| 151 | + ) |
| 152 | + def info(t: Throwable)(message: => String): F[Unit] = |
| 153 | + F.ifM(underlying.isInfoEnabled)( |
| 154 | + for (localCtx <- localLogContext.currentLogContext) |
| 155 | + yield underlying.info(localCtx, t)(message), |
| 156 | + F.unit |
| 157 | + ) |
| 158 | + def info(ctx: Map[String, String])(msg: => String): F[Unit] = |
| 159 | + F.ifM(underlying.isInfoEnabled)( |
| 160 | + for (localCtx <- localLogContext.currentLogContext) |
| 161 | + yield underlying.info(localCtx ++ ctx)(msg), |
| 162 | + F.unit |
| 163 | + ) |
| 164 | + def info(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] = |
| 165 | + F.ifM(underlying.isInfoEnabled)( |
| 166 | + for (localCtx <- localLogContext.currentLogContext) |
| 167 | + yield underlying.info(localCtx ++ ctx, t)(msg), |
| 168 | + F.unit |
| 169 | + ) |
| 170 | + |
| 171 | + def debug(message: => String): F[Unit] = |
| 172 | + F.ifM(underlying.isDebugEnabled)( |
| 173 | + for (localCtx <- localLogContext.currentLogContext) |
| 174 | + yield underlying.debug(localCtx)(message), |
| 175 | + F.unit |
| 176 | + ) |
| 177 | + def debug(t: Throwable)(message: => String): F[Unit] = |
| 178 | + F.ifM(underlying.isDebugEnabled)( |
| 179 | + for (localCtx <- localLogContext.currentLogContext) |
| 180 | + yield underlying.debug(localCtx, t)(message), |
| 181 | + F.unit |
| 182 | + ) |
| 183 | + def debug(ctx: Map[String, String])(msg: => String): F[Unit] = |
| 184 | + F.ifM(underlying.isDebugEnabled)( |
| 185 | + for (localCtx <- localLogContext.currentLogContext) |
| 186 | + yield underlying.debug(localCtx ++ ctx)(msg), |
| 187 | + F.unit |
| 188 | + ) |
| 189 | + def debug(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] = |
| 190 | + F.ifM(underlying.isDebugEnabled)( |
| 191 | + for (localCtx <- localLogContext.currentLogContext) |
| 192 | + yield underlying.debug(localCtx ++ ctx, t)(msg), |
| 193 | + F.unit |
| 194 | + ) |
| 195 | + |
| 196 | + def trace(message: => String): F[Unit] = |
| 197 | + F.ifM(underlying.isTraceEnabled)( |
| 198 | + for (localCtx <- localLogContext.currentLogContext) |
| 199 | + yield underlying.trace(localCtx)(message), |
| 200 | + F.unit |
| 201 | + ) |
| 202 | + def trace(t: Throwable)(message: => String): F[Unit] = |
| 203 | + F.ifM(underlying.isTraceEnabled)( |
| 204 | + for (localCtx <- localLogContext.currentLogContext) |
| 205 | + yield underlying.trace(localCtx, t)(message), |
| 206 | + F.unit |
| 207 | + ) |
| 208 | + def trace(ctx: Map[String, String])(msg: => String): F[Unit] = |
| 209 | + F.ifM(underlying.isTraceEnabled)( |
| 210 | + for (localCtx <- localLogContext.currentLogContext) |
| 211 | + yield underlying.trace(localCtx ++ ctx)(msg), |
| 212 | + F.unit |
| 213 | + ) |
| 214 | + def trace(ctx: Map[String, String], t: Throwable)(msg: => String): F[Unit] = |
| 215 | + F.ifM(underlying.isTraceEnabled)( |
| 216 | + for (localCtx <- localLogContext.currentLogContext) |
| 217 | + yield underlying.trace(localCtx ++ ctx, t)(msg), |
| 218 | + F.unit |
| 219 | + ) |
| 220 | + } |
| 221 | + |
| 222 | + def apply[F[_]: Monad]( |
| 223 | + localLogContext: LocalLogContext[F], |
| 224 | + underlying: SelfAwareStructuredLogger[F] |
| 225 | + ): LocalLogger[F] = |
| 226 | + new Impl(localLogContext, underlying) |
| 227 | + |
| 228 | + def fromLocal[F[_]: Monad]( |
| 229 | + underlying: SelfAwareStructuredLogger[F] |
| 230 | + )(implicit localCtx: Local[F, Map[String, String]]): LocalLogger[F] = |
| 231 | + apply(LocalLogContext.fromLocal, underlying) |
| 232 | +} |
0 commit comments