case class ErrorLoggingContext(logger: TracedLogger, properties: Map[String, String], traceContext: TraceContext) extends ContextualizedErrorLogger with Product with Serializable

Enriches a com.digitalasset.canton.tracing.TraceContext with a fixed logger and a set of properties. Use this class as an implicit parameter of methods inside helper classes whose class name shall not show up in the log line as part of the logger name. Instead, the logger name and properties are fixed when this object is created, which typically happens at a call site further up via NamedLogging.errorLoggingContext.

This class is primarily used with the com.daml.error framework for logging an error when it is created.

See also

NamedLoggingContext for another variant where the logger name is not fixed

NamedLogging.errorLoggingContext converts

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ErrorLoggingContext
  2. Serializable
  3. Product
  4. Equals
  5. ContextualizedErrorLogger
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ErrorLoggingContext(logger: TracedLogger, properties: Map[String, String], traceContext: TraceContext)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def correlationId: Option[String]
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  7. def debug(message: String, throwable: Throwable): Unit
  8. def debug(message: String): Unit
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def error(message: String, throwable: Throwable): Unit
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  11. def error(message: String): Unit
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def info(message: String, throwable: Throwable): Unit
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  14. def info(message: String): Unit
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def logError(err: BaseError, extra: Map[String, String]): Unit

    Log the cause while adding the context into the MDC

    Log the cause while adding the context into the MDC

    We add the context twice to the MDC: first, every map item is added directly and then we add a second string version as "err-context". When we log to file, we add the err-context to the log output. When we log to JSON, we ignore the err-context field.

    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  17. val logger: TracedLogger
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val properties: Map[String, String]
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def trace(message: String, throwable: Throwable): Unit
  25. def trace(message: String): Unit
  26. val traceContext: TraceContext
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. def warn(message: String, throwable: Throwable): Unit
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger
  31. def warn(message: String): Unit
    Definition Classes
    ErrorLoggingContext → ContextualizedErrorLogger

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped