Packages

final case class MonitoringConfig(deadlockDetection: DeadlockDetectionConfig = DeadlockDetectionConfig(), health: Option[HealthConfig] = None, metrics: MetricsConfig = MetricsConfig(), delayLoggingThreshold: NonNegativeFiniteDuration = MonitoringConfig.defaultDelayLoggingThreshold, tracing: TracingConfig = TracingConfig(), logMessagePayloads: Option[Boolean] = None, logQueryCost: Option[QueryCostMonitoringConfig] = None, logSlowFutures: Boolean = false, healthDumpMetricFrequency: NonNegativeFiniteDuration = MonitoringConfig.defaultHealthDumpMetricFrequency, logging: LoggingConfig = LoggingConfig(), dumpNumRollingLogFiles: NonNegativeInt = MonitoringConfig.defaultDumpNumRollingLogFiles) extends LazyLogging with Product with Serializable

Configuration for metrics and tracing

deadlockDetection

Should we regularly check our environment EC for deadlocks?

health

Optional Health check to expose an http server to monitor is the canton process is healthy

metrics

Optional Metrics Reporter used to expose internally captured metrics

delayLoggingThreshold

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

tracing

Tracing configuration

logMessagePayloads

Determines whether message payloads (as well as metadata) sent through GRPC are logged.

logQueryCost

Determines whether to log the 15 most expensive db queries

logSlowFutures

Whether we should active log slow futures (where instructed)

dumpNumRollingLogFiles

How many of the rolling log files shold be included in the remote dump. Default is 0.

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

Instance Constructors

  1. new MonitoringConfig(deadlockDetection: DeadlockDetectionConfig = DeadlockDetectionConfig(), health: Option[HealthConfig] = None, metrics: MetricsConfig = MetricsConfig(), delayLoggingThreshold: NonNegativeFiniteDuration = MonitoringConfig.defaultDelayLoggingThreshold, tracing: TracingConfig = TracingConfig(), logMessagePayloads: Option[Boolean] = None, logQueryCost: Option[QueryCostMonitoringConfig] = None, logSlowFutures: Boolean = false, healthDumpMetricFrequency: NonNegativeFiniteDuration = MonitoringConfig.defaultHealthDumpMetricFrequency, logging: LoggingConfig = LoggingConfig(), dumpNumRollingLogFiles: NonNegativeInt = MonitoringConfig.defaultDumpNumRollingLogFiles)

    deadlockDetection

    Should we regularly check our environment EC for deadlocks?

    health

    Optional Health check to expose an http server to monitor is the canton process is healthy

    metrics

    Optional Metrics Reporter used to expose internally captured metrics

    delayLoggingThreshold

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

    tracing

    Tracing configuration

    logMessagePayloads

    Determines whether message payloads (as well as metadata) sent through GRPC are logged.

    logQueryCost

    Determines whether to log the 15 most expensive db queries

    logSlowFutures

    Whether we should active log slow futures (where instructed)

    dumpNumRollingLogFiles

    How many of the rolling log files shold be included in the remote dump. Default is 0.

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() @IntrinsicCandidate()
  6. val deadlockDetection: DeadlockDetectionConfig
  7. val delayLoggingThreshold: NonNegativeFiniteDuration
  8. val dumpNumRollingLogFiles: NonNegativeInt
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def getLoggingConfig: LoggingConfig
  12. val health: Option[HealthConfig]
  13. val healthDumpMetricFrequency: NonNegativeFiniteDuration
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val logMessagePayloads: Option[Boolean]
  16. val logQueryCost: Option[QueryCostMonitoringConfig]
  17. val logSlowFutures: Boolean
  18. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
    Annotations
    @transient()
  19. val logging: LoggingConfig
  20. val metrics: MetricsConfig
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val tracing: TracingConfig
  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])

Deprecated Value Members

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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped