LogEmitter

This instance of the TraceSystem.Emitter provides the means to record a Span to a log appender in both text and JSON formats, also logging the associated system properties provided in the passed-in TraceContext[F]. The recording is described in the context of an effectful program F with a Sync[F] instance in implicit scope and actually occurs when that program is run. Whether the information is recorded to log files, some other location, or not at all depends on the configuration of the distributed-trace.txt and distributed-trace.json loggers. Note that the logging occurs only if DEBUG is enabled for the particular logger in the underlying logging configuration.

Source: LogEmitter.scala

Linear Supertypes

Emitter[F], AnyRef, Any

Type Hierarchy

Instance Constructors

new LogEmitter(loggers: Loggers[F])(implicit arg0: Sync[F])

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 LogEmitter[F] to any2stringadd[LogEmitter[F]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (LogEmitter[F], B)

Implicit information
This member is added by an implicit conversion from LogEmitter[F] to ArrowAssoc[LogEmitter[F]] 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( ... )
val description: String

Definition Classes
LogEmitter → Emitter
def emit(context: TraceContext[F]): F[Unit]

Emit the Span and system properties contained in the passed-in TraceContext[F] to an log appender, in JSON and textual format.
Emit the Span and system properties contained in the passed-in TraceContext[F] to an log appender, in JSON and textual format. The emission/recording is described in the returned effectful program F and occurs when that program is run. The JSON is rendered by the implicit io.circe.Encoder[TraceContext[F]] provided via the json.encoding object.
context
- the TraceContext[F] containing the Span and TraceSystem containing system properties to include in the emission.
returns
loggingProgram - an effectful program F[Unit] that when run will record the trace information to the logging system.

Definition Classes
LogEmitter → Emitter
def ensuring(cond: (LogEmitter[F]) ⇒ Boolean, msg: ⇒ Any): LogEmitter[F]

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

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

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

Implicit information
This member is added by an implicit conversion from LogEmitter[F] to Ensuring[LogEmitter[F]] 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 LogEmitter[F] to StringFormat[LogEmitter[F]] 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): (LogEmitter[F], B)

Implicit information
This member is added by an implicit conversion from LogEmitter[F] to ArrowAssoc[LogEmitter[F]] 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.

Related Docs: object LogEmitter | package logging

class LogEmitter[F[_]] extends Emitter[F]

Instance Constructors

new LogEmitter(loggers: Loggers[F])(implicit arg0: Sync[F])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (LogEmitter[F], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val description: String

def emit(context: TraceContext[F]): F[Unit]

def ensuring(cond: (LogEmitter[F]) ⇒ Boolean, msg: ⇒ Any): LogEmitter[F]

def ensuring(cond: (LogEmitter[F]) ⇒ Boolean): LogEmitter[F]

def ensuring(cond: Boolean, msg: ⇒ Any): LogEmitter[F]

def ensuring(cond: Boolean): LogEmitter[F]

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): (LogEmitter[F], B)

Deprecated Value Members

def finalize(): Unit

Inherited from Emitter[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from LogEmitter[F] to any2stringadd[LogEmitter[F]]

Inherited by implicit conversion StringFormat from LogEmitter[F] to StringFormat[LogEmitter[F]]

Inherited by implicit conversion Ensuring from LogEmitter[F] to Ensuring[LogEmitter[F]]

Inherited by implicit conversion ArrowAssoc from LogEmitter[F] to ArrowAssoc[LogEmitter[F]]

Ungrouped