case class DefaultServerLog[F[_]](doLogWhenReceived: (String) => F[Unit], doLogWhenHandled: (String, Option[Throwable]) => F[Unit], doLogAllDecodeFailures: (String, Option[Throwable]) => F[Unit], doLogExceptions: (String, Throwable) => F[Unit], noLog: F[Unit], logWhenReceived: Boolean = false, logWhenHandled: Boolean = true, logAllDecodeFailures: Boolean = false, logLogicExceptions: Boolean = true, showEndpoint: (AnyEndpoint) => String = _.showShort, showRequest: (ServerRequest) => String = _.showShort, showResponse: (ServerResponse[_]) => String = _.showShort, includeTiming: Boolean = true, clock: Clock = Clock.systemUTC(), ignoreEndpoints: Set[AnyEndpoint] = Set.empty) extends ServerLog[F] with Product with Serializable
- Alphabetic
- By Inheritance
- DefaultServerLog
- Serializable
- Product
- Equals
- ServerLog
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DefaultServerLog(doLogWhenReceived: (String) => F[Unit], doLogWhenHandled: (String, Option[Throwable]) => F[Unit], doLogAllDecodeFailures: (String, Option[Throwable]) => F[Unit], doLogExceptions: (String, Throwable) => F[Unit], noLog: F[Unit], logWhenReceived: Boolean = false, logWhenHandled: Boolean = true, logAllDecodeFailures: Boolean = false, logLogicExceptions: Boolean = true, showEndpoint: (AnyEndpoint) => String = _.showShort, showRequest: (ServerRequest) => String = _.showShort, showResponse: (ServerResponse[_]) => String = _.showShort, includeTiming: Boolean = true, clock: Clock = Clock.systemUTC(), ignoreEndpoints: Set[AnyEndpoint] = Set.empty)
Type Members
- type TOKEN = Long
The type of the per-request token that is generated when a request is started and passed to callbacks when the request is completed.
The type of the per-request token that is generated when a request is started and passed to callbacks when the request is completed. E.g.
Unitor a timestamp (Long).- Definition Classes
- DefaultServerLog → ServerLog
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clock(c: Clock): DefaultServerLog[F]
- val clock: Clock
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def decodeFailureHandled(ctx: DecodeFailureContext, response: ServerResponse[_], token: TOKEN): F[Unit]
Invoked when there's a decode failure for an input of the endpoint and the interpreter, or other interceptors, provided a response.
Invoked when there's a decode failure for an input of the endpoint and the interpreter, or other interceptors, provided a response.
- Definition Classes
- DefaultServerLog → ServerLog
- def decodeFailureNotHandled(ctx: DecodeFailureContext, token: TOKEN): F[Unit]
Invoked when there's a decode failure for an input of the endpoint and the interpreter, or other interceptors, haven't provided a response.
Invoked when there's a decode failure for an input of the endpoint and the interpreter, or other interceptors, haven't provided a response.
- Definition Classes
- DefaultServerLog → ServerLog
- def doLogAllDecodeFailures(f: (String, Option[Throwable]) => F[Unit]): DefaultServerLog[F]
- val doLogAllDecodeFailures: (String, Option[Throwable]) => F[Unit]
- def doLogExceptions(f: (String, Throwable) => F[Unit]): DefaultServerLog[F]
- val doLogExceptions: (String, Throwable) => F[Unit]
- def doLogWhenHandled(f: (String, Option[Throwable]) => F[Unit]): DefaultServerLog[F]
- val doLogWhenHandled: (String, Option[Throwable]) => F[Unit]
- def doLogWhenReceived(f: (String) => F[Unit]): DefaultServerLog[F]
- val doLogWhenReceived: (String) => F[Unit]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def exception(ctx: ExceptionContext[_, _], ex: Throwable, token: TOKEN): F[Unit]
Invoked when an exception has been thrown when running the server logic or handling decode failures.
Invoked when an exception has been thrown when running the server logic or handling decode failures.
- Definition Classes
- DefaultServerLog → ServerLog
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ignoreEndpoints(es: Seq[AnyEndpoint]): DefaultServerLog[F]
Allows defining a list of endpoints which should not log requestHandled.
Allows defining a list of endpoints which should not log requestHandled. Exceptions, decode failures and security failures will still be logged.
- val ignoreEndpoints: Set[AnyEndpoint]
Allows defining a list of endpoints which should not log requestHandled.
Allows defining a list of endpoints which should not log requestHandled. Exceptions, decode failures and security failures will still be logged.
- Definition Classes
- DefaultServerLog → ServerLog
- def includeTiming(doInclude: Boolean): DefaultServerLog[F]
- val includeTiming: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logAllDecodeFailures(doLog: Boolean): DefaultServerLog[F]
- val logAllDecodeFailures: Boolean
- def logLogicExceptions(doLog: Boolean): DefaultServerLog[F]
- val logLogicExceptions: Boolean
- def logWhenHandled(doLog: Boolean): DefaultServerLog[F]
- val logWhenHandled: Boolean
- val logWhenReceived: Boolean
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noLog(f: F[Unit]): DefaultServerLog[F]
- val noLog: F[Unit]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def requestHandled(ctx: DecodeSuccessContext[F, _, _, _], response: ServerResponse[_], token: TOKEN): F[Unit]
Invoked when all inputs of the request have been decoded successfully and the endpoint handles the request by providing a response, with the given status code.
Invoked when all inputs of the request have been decoded successfully and the endpoint handles the request by providing a response, with the given status code.
- Definition Classes
- DefaultServerLog → ServerLog
- def requestReceived(request: ServerRequest, token: TOKEN): F[Unit]
Invoked when the request has been received.
Invoked when the request has been received.
- Definition Classes
- DefaultServerLog → ServerLog
- def requestToken: TOKEN
Invoked when the request has been received to obtain the per-request token, such as the starting timestamp.
Invoked when the request has been received to obtain the per-request token, such as the starting timestamp.
- Definition Classes
- DefaultServerLog → ServerLog
- def securityFailureHandled(ctx: SecurityFailureContext[F, _], response: ServerResponse[_], token: TOKEN): F[Unit]
Invoked when the security logic fails and returns an error.
Invoked when the security logic fails and returns an error.
- Definition Classes
- DefaultServerLog → ServerLog
- def showEndpoint(s: (AnyEndpoint) => String): DefaultServerLog[F]
- val showEndpoint: (AnyEndpoint) => String
- def showRequest(s: (ServerRequest) => String): DefaultServerLog[F]
- val showRequest: (ServerRequest) => String
- def showResponse(s: (ServerResponse[_]) => String): DefaultServerLog[F]
- val showResponse: (ServerResponse[_]) => String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated