-
Notifications
You must be signed in to change notification settings - Fork 787
/
Logger.scala
107 lines (96 loc) · 4.06 KB
/
Logger.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
* Copyright 2014 http4s.org
*
* 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 org.http4s
package server
package middleware
import cats.arrow.FunctionK
import cats.data.OptionT
import cats.effect.kernel.Async
import cats.effect.kernel.MonadCancelThrow
import cats.syntax.all._
import cats.~>
import fs2.Stream
import org.typelevel.ci.CIString
/** Simple Middleware for Logging All Requests and Responses
*/
object Logger {
private[this] val logger = Platform.loggerFactory.getLogger
def defaultRedactHeadersWhen(name: CIString): Boolean =
Headers.SensitiveHeaders.contains(name) || name.toString.toLowerCase.contains("token")
def apply[G[_], F[_]](
logHeaders: Boolean,
logBody: Boolean,
fk: F ~> G,
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
logAction: Option[String => F[Unit]] = None,
)(http: Http[G, F])(implicit G: MonadCancelThrow[G], F: Async[F]): Http[G, F] = {
val log: String => F[Unit] = logAction.getOrElse { s =>
logger.info(s).to[F]
}
ResponseLogger(logHeaders, logBody, fk, redactHeadersWhen, log.pure[Option])(
RequestLogger(logHeaders, logBody, fk, redactHeadersWhen, log.pure[Option])(http)
)
}
def logBodyText[G[_], F[_]](
logHeaders: Boolean,
logBody: Stream[F, Byte] => Option[F[String]],
fk: F ~> G,
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
logAction: Option[String => F[Unit]] = None,
)(http: Http[G, F])(implicit G: MonadCancelThrow[G], F: Async[F]): Http[G, F] = {
val log: String => F[Unit] = logAction.getOrElse { s =>
logger.info(s).to[F]
}
ResponseLogger.impl(logHeaders, Right(logBody), fk, redactHeadersWhen, log.pure[Option])(
RequestLogger.impl(logHeaders, Right(logBody), fk, redactHeadersWhen, log.pure[Option])(http)
)
}
def httpApp[F[_]: Async](
logHeaders: Boolean,
logBody: Boolean,
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
logAction: Option[String => F[Unit]] = None,
)(httpApp: HttpApp[F]): HttpApp[F] =
apply(logHeaders, logBody, FunctionK.id[F], redactHeadersWhen, logAction)(httpApp)
def httpAppLogBodyText[F[_]: Async](
logHeaders: Boolean,
logBody: Stream[F, Byte] => Option[F[String]],
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
logAction: Option[String => F[Unit]] = None,
)(httpApp: HttpApp[F]): HttpApp[F] =
logBodyText(logHeaders, logBody, FunctionK.id[F], redactHeadersWhen, logAction)(httpApp)
def httpRoutes[F[_]: Async](
logHeaders: Boolean,
logBody: Boolean,
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
logAction: Option[String => F[Unit]] = None,
)(httpRoutes: HttpRoutes[F]): HttpRoutes[F] =
apply(logHeaders, logBody, OptionT.liftK[F], redactHeadersWhen, logAction)(httpRoutes)
def httpRoutesLogBodyText[F[_]: Async](
logHeaders: Boolean,
logBody: Stream[F, Byte] => Option[F[String]],
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
logAction: Option[String => F[Unit]] = None,
)(httpRoutes: HttpRoutes[F]): HttpRoutes[F] =
logBodyText(logHeaders, logBody, OptionT.liftK[F], redactHeadersWhen, logAction)(httpRoutes)
def logMessage[F[_], A <: Message[F]](message: A)(
logHeaders: Boolean,
logBody: Boolean,
redactHeadersWhen: CIString => Boolean = defaultRedactHeadersWhen,
)(log: String => F[Unit])(implicit F: Async[F]): F[Unit] =
org.http4s.internal.Logger
.logMessage(message)(logHeaders, logBody, redactHeadersWhen)(log)
}