class ReplayingSendsSequencerClientTransport extends SequencerClientTransport with NamedLogging with NoTracing with FlagCloseableAsync
Replays previously recorded sends against the configured sequencer and using a real sequencer client transport. Records the latencies/rates to complete the send itself, and latencies/rates for an event that was caused by the send to be witnessed. These metrics are currently printed to stdout. Sequencers are able to drop sends so to know when all sends have likely been sequenced we simply wait for a period where no events are received for a configurable duration. This isn't perfect as technically a sequencer could stall, however the inflight gauge will report a number greater than 0 indicating that these sends have gone missing. Clients are responsible for interacting with the transport to initiate a replay and wait for observed events to be idle. A reference can be obtained to this transport component by waiting on the future provided in ReplayAction.SequencerSends. This testing transport is very stateful and the metrics will only make sense for a single replay, however currently multiple or even concurrent calls are not prevented (just don't).
- Alphabetic
- By Inheritance
- ReplayingSendsSequencerClientTransport
- FlagCloseableAsync
- NoTracing
- NamedLogging
- SequencerClientTransport
- SupportsHandshake
- FlagCloseable
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ReplayingSendsSequencerClientTransport(protocolVersion: ProtocolVersion, recordedPath: Path, replaySendsConfig: SequencerSends, member: Member, underlyingTransport: SequencerClientTransport, metrics: SequencerClientMetrics, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext, materializer: Materializer)
Type Members
- case class EventsReceivedReport(elapsedDuration: FiniteDuration, totalEventsReceived: Int, finishedAtCounter: SequencerCounter) extends Product with Serializable
- case class SendReplayReport(successful: Int = 0, overloaded: Int = 0, errors: Int = 0) extends Product with Serializable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def acknowledge(member: Member, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]
Acknowledge that we have successfully processed all events up to and including the given timestamp.
Acknowledge that we have successfully processed all events up to and including the given timestamp. The client should then never subscribe for events from before this point.
- Definition Classes
- ReplayingSendsSequencerClientTransport → SequencerClientTransport
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def close(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- FlagCloseable → AutoCloseable
- Annotations
- @SuppressWarnings()
- def closeAsync(): Seq[AsyncOrSyncCloseable]
closeAsync asynchronously releases resources held by a future
closeAsync asynchronously releases resources held by a future
- returns
an ordered sequence of async and sync closeables with async closeables made up of future and timeout
- Attributes
- protected
- Definition Classes
- ReplayingSendsSequencerClientTransport → FlagCloseableAsync
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def handshake(request: HandshakeRequest)(implicit traceContext: TraceContext): EitherT[Future, HandshakeRequestError, HandshakeResponse]
Attempt to obtain a handshake response from the sequencer server.
Attempt to obtain a handshake response from the sequencer server. Can indicate with the error if the error is transient and may be retried by the caller.
- Definition Classes
- ReplayingSendsSequencerClientTransport → SupportsHandshake
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.
- Definition Classes
- FlagCloseable
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfOpenFutures: Boolean
track running futures on shutdown
track running futures on shutdown
set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- ReplayingSendsSequencerClientTransport → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def metricReport: String
Dump the submission related metrics into a string for periodic reporting during the replay test
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def onClosed(): Unit
- Definition Classes
- FlagCloseableAsync → FlagCloseable
- def performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherT[E, R](onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.- etf
The task to perform
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.- f
The task to perform
- returns
The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.
- Definition Classes
- FlagCloseable
- def replay(sendParallelism: Int): Future[SendReplayReport]
- def replayDuration: Option[Duration]
How long did the replay take from first send sent to last event received.
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def sendAsync(request: SubmissionRequest, timeout: Duration, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]
We're replaying sends so shouldn't allow the app to send any new ones
We're replaying sends so shouldn't allow the app to send any new ones
- Definition Classes
- ReplayingSendsSequencerClientTransport → SequencerClientTransport
- def sendAsyncUnauthenticated(request: SubmissionRequest, timeout: Duration, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]
- Definition Classes
- ReplayingSendsSequencerClientTransport → SequencerClientTransport
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def subscribe[E](request: SubscriptionRequest, handler: SerializedEventHandler[E])(implicit traceContext: TraceContext): SequencerSubscription[E]
Create a single subscription to read events from the Sequencer for this member starting from the counter defined in the request.
Create a single subscription to read events from the Sequencer for this member starting from the counter defined in the request. Transports are currently responsible for calling the supplied handler. The handler must not be called concurrently and must receive events in-order. If the handler fails with an exception the subscription should close with a com.digitalasset.canton.sequencing.client.SubscriptionCloseReason.HandlerError. If the subscription fails for a technical reason it should close with a com.digitalasset.canton.sequencing.client.SubscriptionCloseReason.SubscriptionError. The transport is not expected to provide retries of subscriptions.
- Definition Classes
- ReplayingSendsSequencerClientTransport → SequencerClientTransport
- def subscribeUnauthenticated[E](request: SubscriptionRequest, handler: SerializedEventHandler[E])(implicit traceContext: TraceContext): SequencerSubscription[E]
- Definition Classes
- ReplayingSendsSequencerClientTransport → SequencerClientTransport
- def subscriptionRetryPolicy: SubscriptionErrorRetryPolicy
The transport can decide which errors will cause the sequencer client to not try to reestablish a subscription
The transport can decide which errors will cause the sequencer client to not try to reestablish a subscription
- Definition Classes
- ReplayingSendsSequencerClientTransport → SequencerClientTransport
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- ReplayingSendsSequencerClientTransport → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitForIdle(duration: FiniteDuration, startFromCounter: SequencerCounter = GenesisSequencerCounter): Future[EventsReceivedReport]