Packages

c

com.digitalasset.canton.config

TestingConfigInternal

final case class TestingConfigInternal(testSequencerClientFor: Set[TestSequencerClientFor] = Set.empty, metricsFactoryType: MetricsFactoryType = External, supportAdhocMetrics: Boolean = false, initializeGlobalOpenTelemetry: Boolean = true, doNotUseCommitmentCachingFor: Set[String] = Set.empty, reinterpretationTestHookFor: (String) => () => Unit = _ => () => (), maxCommitmentSendDelayMillis: Option[NonNegativeInt] = None, sequencerTransportSeed: Option[Long] = None, participantsWithoutLapiVerification: Set[String] = Set.empty, enableInMemoryTransactionStoreForParticipants: Boolean = false, warnOnAcsCommitmentDegradation: Boolean = true) extends Product with Serializable

Used to set parameters for testing when these don't need to be exposed in a config file.

supportAdhocMetrics

if true, then creating adhoc metrics is supported (conflicts with histogram redefinitions)

initializeGlobalOpenTelemetry

Determines whether the OpenTelemetry instance we build is set as the global OpenTelemetry instance. This is set to false during tests to prevent failures as the global OpenTelemetry instance can be initialized just once.

doNotUseCommitmentCachingFor

A participant whose participant.uid.identifier that matches one of these strings will be excluded from the commitment caching.

reinterpretationTestHookFor

Hooks allowing participants to perform actions during reinterpretation interruptions. The argument to pass is a function that takes a string as an argument and returns the hook for the corresponding member whose identifier matches the string. The hook itself is a function that takes no argument and returns Unit. The default value provides hooks that do nothing for all members. Example:

def myHooks(identifier: String): () => Unit =
  identifier match {
    case "participant1" => () => println(s"do something special for `participant1`")
    case _ => () => println(s"no action")
  }

See also the example in EngineComputationAbortIntegrationTest.

maxCommitmentSendDelayMillis

The maximum delay for sending commitments in milliseconds. If not set, commitment sending is delayed by a random amount at most the default value.

sequencerTransportSeed

The seed to be used for choosing threshold number of sequencer transports.

warnOnAcsCommitmentDegradation

When true, we log a warning when the participant falls behind in producing ACS commitments. This is the default. A false value lowers the logging level to debug, while keeping the degradation of the health status. In tests, we should set it to false, because any test with high load can cause a participant to lag behind in producing commitments, which would produce an ACS commitment degradation warning and cause a CI test to be reported as failed. Because in our testing framework any test can run colocated with any other test, any test, load-intensive or not, can issue the warning. Therefore, this parameter should be set to false in tests, unless the test expressly checks the behavior of the degradation.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestingConfigInternal
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TestingConfigInternal(testSequencerClientFor: Set[TestSequencerClientFor] = Set.empty, metricsFactoryType: MetricsFactoryType = External, supportAdhocMetrics: Boolean = false, initializeGlobalOpenTelemetry: Boolean = true, doNotUseCommitmentCachingFor: Set[String] = Set.empty, reinterpretationTestHookFor: (String) => () => Unit = _ => () => (), maxCommitmentSendDelayMillis: Option[NonNegativeInt] = None, sequencerTransportSeed: Option[Long] = None, participantsWithoutLapiVerification: Set[String] = Set.empty, enableInMemoryTransactionStoreForParticipants: Boolean = false, warnOnAcsCommitmentDegradation: Boolean = true)

    supportAdhocMetrics

    if true, then creating adhoc metrics is supported (conflicts with histogram redefinitions)

    initializeGlobalOpenTelemetry

    Determines whether the OpenTelemetry instance we build is set as the global OpenTelemetry instance. This is set to false during tests to prevent failures as the global OpenTelemetry instance can be initialized just once.

    doNotUseCommitmentCachingFor

    A participant whose participant.uid.identifier that matches one of these strings will be excluded from the commitment caching.

    reinterpretationTestHookFor

    Hooks allowing participants to perform actions during reinterpretation interruptions. The argument to pass is a function that takes a string as an argument and returns the hook for the corresponding member whose identifier matches the string. The hook itself is a function that takes no argument and returns Unit. The default value provides hooks that do nothing for all members. Example:

    def myHooks(identifier: String): () => Unit =
      identifier match {
        case "participant1" => () => println(s"do something special for `participant1`")
        case _ => () => println(s"no action")
      }

    See also the example in EngineComputationAbortIntegrationTest.

    maxCommitmentSendDelayMillis

    The maximum delay for sending commitments in milliseconds. If not set, commitment sending is delayed by a random amount at most the default value.

    sequencerTransportSeed

    The seed to be used for choosing threshold number of sequencer transports.

    warnOnAcsCommitmentDegradation

    When true, we log a warning when the participant falls behind in producing ACS commitments. This is the default. A false value lowers the logging level to debug, while keeping the degradation of the health status. In tests, we should set it to false, because any test with high load can cause a participant to lag behind in producing commitments, which would produce an ACS commitment degradation warning and cause a CI test to be reported as failed. Because in our testing framework any test can run colocated with any other test, any test, load-intensive or not, can issue the warning. Therefore, this parameter should be set to false in tests, unless the test expressly checks the behavior of the degradation.

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]) @IntrinsicCandidate() @native()
  6. val doNotUseCommitmentCachingFor: Set[String]
  7. val enableInMemoryTransactionStoreForParticipants: Boolean
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. val initializeGlobalOpenTelemetry: Boolean
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val maxCommitmentSendDelayMillis: Option[NonNegativeInt]
  13. val metricsFactoryType: MetricsFactoryType
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. val participantsWithoutLapiVerification: Set[String]
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val reinterpretationTestHookFor: (String) => () => Unit
  20. val sequencerTransportSeed: Option[Long]
  21. val supportAdhocMetrics: Boolean
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val testSequencerClientFor: Set[TestSequencerClientFor]
  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])
  27. val warnOnAcsCommitmentDegradation: Boolean

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 AnyRef

Inherited from Any

Ungrouped