IQueueAdapterReceiverMonitor Methods

1. Documentation
2. API reference
3. Microsoft.Orleans.Streaming
4. IQueueAdapterReceiverMonitor
5. Methods

Markdown

Responsible for monitoring receiver performance metrics.

TrackInitialization(bool, TimeSpan, Exception)

abstract

public abstract void TrackInitialization(bool success, TimeSpan callTime, Exception exception)

Track attempts to initialize the receiver.

Parameters

successbool

True if read succeeded, false if read failed.

callTimeTimeSpan

Init operation time.

exceptionException

Exception caught if initialize fail.

TrackMessagesReceived(long, DateTime?, DateTime?)

abstract

public abstract void TrackMessagesReceived(long count, DateTime? oldestMessageEnqueueTimeUtc, DateTime? newestMessageEnqueueTimeUtc)

Tracks messages read and time taken per successful read. Tracked per successful partition read operation.

Parameters

countlong

Messages read.

oldestMessageEnqueueTimeUtcDateTime?

The oldest message enqueue time (UTC).

newestMessageEnqueueTimeUtcDateTime?

The newest message enqueue time (UTC).

TrackRead(bool, TimeSpan, Exception)

abstract

public abstract void TrackRead(bool success, TimeSpan callTime, Exception exception)

Track attempts to read from the partition. Tracked per partition read operation.

Parameters

successbool

True if read succeeded, false if read failed.

callTimeTimeSpan

Time spent in read operation.

exceptionException

The exception caught if read failed.

TrackShutdown(bool, TimeSpan, Exception)

abstract

public abstract void TrackShutdown(bool success, TimeSpan callTime, Exception exception)

Track attempts to shutdown the receiver.

Parameters

successbool

True if read succeeded, false if read failed.

callTimeTimeSpan

Shutdown operation time.

exceptionException

Exception caught if shutdown fail.