FlowLogger

This trait implements a logger that is used for rendering entry/exit logging wrappers.

The FlowMethod implements the bulk of the logic here, and is intended to be used with a user-provided FlowBehavior that determines what statements and side effects happen on entry and exit.

If logging is enabled, then the execution is wrapped to capture the result or execution, and then the result is returned or execution rethrown. If the logging level is not enabled or logging execution is denied by a filter, then execution of the block still proceeds but is not wrapped by a Try block.

You should use Condition.never explicitly here to disable logging, as it will shortcut to a Noop implementation. Benchmarks show a noop flow takes 42ns to execute, 4.5ns if you remove sourcecode.Args from the method signature.

import com.tersesystems.blindsight._
import com.tersesystems.blindsight.flow._

implicit def flowBehavior[B: ToArgument]: FlowBehavior[B] = new SimpleFlowBehavior
val logger = LoggerFactory.getLogger
val flowLogger: FlowLogger = logger.flow
val resultIsThree: Int = flowLogger.trace(1 + 2)

Source: FlowLogger.scala

Known Subclasses

Base, Impl, Noop

Type Members

type Method = FlowMethod

Definition Classes
FlowLogger → SLF4JLoggerComponent
type Predicate = CorePredicate

Definition Classes
FlowLogger → SLF4JLoggerComponent
type Self = FlowLogger

Definition Classes
FlowLogger → OnConditionMixin → ConditionMixin → EventBufferMixin → EntryTransformMixin → MarkerMixin → SLF4JLoggerComponent

Abstract Value Members

abstract def debug: Method

Definition Classes
Debug
abstract def error: Method

Definition Classes
Error
abstract def info: Method

Definition Classes
Info
abstract def isDebugEnabled: Predicate

Definition Classes
Debug
abstract def isErrorEnabled: Predicate

Definition Classes
Error
abstract def isInfoEnabled: Predicate

Definition Classes
Info
abstract def isTraceEnabled: Predicate

Definition Classes
Trace
abstract def isWarnEnabled: Predicate

Definition Classes
Warn
abstract def markers: Markers

Returns the accumulated markers of this logger.
Returns the accumulated markers of this logger.
returns
the accumulated markers, may be Markers.empty.

Definition Classes
MarkerMixin
abstract def trace: Method

Definition Classes
Trace
abstract def underlying: org.slf4j.Logger

Definition Classes
UnderlyingMixin
abstract def warn: Method

Definition Classes
Warn
abstract def withCondition(condition: Condition): Self

Returns a new instance of the logger that will only log if the condition is met.
Returns a new instance of the logger that will only log if the condition is met.

Definition Classes
ConditionMixin
abstract def withEntryTransform(f: (Entry) ⇒ Entry): Self

Definition Classes
EntryTransformMixin
abstract def withEntryTransform(level: Level, f: (Entry) ⇒ Entry): Self

Definition Classes
EntryTransformMixin
abstract def withEventBuffer(level: Level, buffer: EventBuffer): Self

Definition Classes
EventBufferMixin
abstract def withEventBuffer(buffer: EventBuffer): Self

Definition Classes
EventBufferMixin
abstract def withMarker[T](instance: T)(implicit arg0: ToMarkers[T]): Self

Returns a logger which will always render with the given marker.
Returns a logger which will always render with the given marker.
T
the instance type.
instance
a type class instance of ToMarkers
returns
a new instance of the logger that has this marker.

Definition Classes
MarkerMixin

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from FlowLogger to any2stringadd[FlowLogger] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (FlowLogger, B)

Implicit information
This member is added by an implicit conversion from FlowLogger to ArrowAssoc[FlowLogger] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def ensuring(cond: (FlowLogger) ⇒ Boolean, msg: ⇒ Any): FlowLogger

Implicit information
This member is added by an implicit conversion from FlowLogger to Ensuring[FlowLogger] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (FlowLogger) ⇒ Boolean): FlowLogger

Implicit information
This member is added by an implicit conversion from FlowLogger to Ensuring[FlowLogger] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): FlowLogger

Implicit information
This member is added by an implicit conversion from FlowLogger to Ensuring[FlowLogger] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): FlowLogger

Implicit information
This member is added by an implicit conversion from FlowLogger to Ensuring[FlowLogger] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from FlowLogger to StringFormat[FlowLogger] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (FlowLogger, B)

Implicit information
This member is added by an implicit conversion from FlowLogger to ArrowAssoc[FlowLogger] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.
def onCondition(condition: Condition): Self

Returns a new instance of the logger that will only log if the condition is met.
Returns a new instance of the logger that will only log if the condition is met.

Definition Classes
OnConditionMixin
Annotations
@deprecated
Deprecated
(Since version 1.4.0) Use withCondition

Inherited from OnConditionMixin

Inherited from ConditionMixin

Related Docs: object FlowLogger | package flow

trait FlowLogger extends SLF4JLoggerAPI[CorePredicate, FlowMethod] with UnderlyingMixin with MarkerMixin with EntryTransformMixin with EventBufferMixin with OnConditionMixin

Type Members

type Method = FlowMethod

type Predicate = CorePredicate

type Self = FlowLogger

Abstract Value Members

abstract def debug: Method

abstract def error: Method

abstract def info: Method

abstract def isDebugEnabled: Predicate

abstract def isErrorEnabled: Predicate

abstract def isInfoEnabled: Predicate

abstract def isTraceEnabled: Predicate

abstract def isWarnEnabled: Predicate

abstract def markers: Markers

abstract def trace: Method

abstract def underlying: org.slf4j.Logger

abstract def warn: Method

abstract def withCondition(condition: Condition): Self

abstract def withEntryTransform(f: (Entry) ⇒ Entry): Self

abstract def withEntryTransform(level: Level, f: (Entry) ⇒ Entry): Self

abstract def withEventBuffer(level: Level, buffer: EventBuffer): Self

abstract def withEventBuffer(buffer: EventBuffer): Self

abstract def withMarker[T](instance: T)(implicit arg0: ToMarkers[T]): Self

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (FlowLogger, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (FlowLogger) ⇒ Boolean, msg: ⇒ Any): FlowLogger

def ensuring(cond: (FlowLogger) ⇒ Boolean): FlowLogger

def ensuring(cond: Boolean, msg: ⇒ Any): FlowLogger

def ensuring(cond: Boolean): FlowLogger

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

def →[B](y: B): (FlowLogger, B)

Deprecated Value Members

def finalize(): Unit

def onCondition(condition: Condition): Self

Inherited from OnConditionMixin

Inherited from ConditionMixin

Inherited from EventBufferMixin

Inherited from EntryTransformMixin

Inherited from MarkerMixin

Inherited from UnderlyingMixin

Inherited from SLF4JLoggerAPI[CorePredicate, FlowMethod]

Inherited from Error[CorePredicate, FlowMethod]

Inherited from Warn[CorePredicate, FlowMethod]

Inherited from Info[CorePredicate, FlowMethod]

Inherited from Debug[CorePredicate, FlowMethod]

Inherited from Trace[CorePredicate, FlowMethod]

Inherited from SLF4JLoggerComponent[CorePredicate, FlowMethod]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from FlowLogger to any2stringadd[FlowLogger]

Inherited by implicit conversion StringFormat from FlowLogger to StringFormat[FlowLogger]

Inherited by implicit conversion Ensuring from FlowLogger to Ensuring[FlowLogger]

Inherited by implicit conversion ArrowAssoc from FlowLogger to ArrowAssoc[FlowLogger]

Ungrouped