Packages

final case class LoggingConfig(api: ApiLoggingConfig = ApiLoggingConfig(), eventDetails: Boolean = false, logConfigOnStartup: Boolean = true, logConfigWithDefaults: Boolean = false, logSlowFutures: Boolean = false, delayLoggingThreshold: NonNegativeFiniteDuration = LoggingConfig.defaultDelayLoggingThreshold, jvmGc: GCLoggingConfig = GCLoggingConfig(), queryCost: Option[QueryCostMonitoringConfig] = None) extends UniformCantonConfigValidation with Product with Serializable

Detailed logging configurations

This section allows to configure additional data such as transaction details to be logged to the standard logback system

api

Configuration settings for the ApiRequestLogger

eventDetails

If set to true, we will log substantial details of internal messages being processed. To be disabled in production!

logConfigOnStartup

If set to true (default), it will log the config on startup (omitting sensitive details)

logConfigWithDefaults

If set to true (default false), the default values of the config will be included

logSlowFutures

Whether we should active log slow futures (where instructed)

delayLoggingThreshold

Logs a warning message once the sequencer client falls behind in processing messages from the sequencer (based on the sequencing timestamp).

jvmGc

Controls the JVM Gc logging

queryCost

Determines whether to log the 15 most expensive db queries

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LoggingConfig
  2. Serializable
  3. Product
  4. Equals
  5. UniformCantonConfigValidation
  6. CustomCantonConfigValidation
  7. CantonConfigValidation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LoggingConfig(api: ApiLoggingConfig = ApiLoggingConfig(), eventDetails: Boolean = false, logConfigOnStartup: Boolean = true, logConfigWithDefaults: Boolean = false, logSlowFutures: Boolean = false, delayLoggingThreshold: NonNegativeFiniteDuration = LoggingConfig.defaultDelayLoggingThreshold, jvmGc: GCLoggingConfig = GCLoggingConfig(), queryCost: Option[QueryCostMonitoringConfig] = None)

    api

    Configuration settings for the ApiRequestLogger

    eventDetails

    If set to true, we will log substantial details of internal messages being processed. To be disabled in production!

    logConfigOnStartup

    If set to true (default), it will log the config on startup (omitting sensitive details)

    logConfigWithDefaults

    If set to true (default false), the default values of the config will be included

    logSlowFutures

    Whether we should active log slow futures (where instructed)

    delayLoggingThreshold

    Logs a warning message once the sequencer client falls behind in processing messages from the sequencer (based on the sequencing timestamp).

    jvmGc

    Controls the JVM Gc logging

    queryCost

    Determines whether to log the 15 most expensive db queries

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. val api: ApiLoggingConfig
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. val delayLoggingThreshold: NonNegativeFiniteDuration
  8. final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    UniformCantonConfigValidationCustomCantonConfigValidation
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val eventDetails: Boolean
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val jvmGc: GCLoggingConfig
  14. val logConfigOnStartup: Boolean
  15. val logConfigWithDefaults: Boolean
  16. val logSlowFutures: Boolean
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val queryCost: Option[QueryCostMonitoringConfig]
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def validate[T >: LoggingConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CantonConfigValidation

Inherited from AnyRef

Inherited from Any

Ungrouped