Package ru.yoomoney.tech.dbqueue.config.impl

Class LoggingThreadLifecycleListener

java.lang.Object

ru.yoomoney.tech.dbqueue.config.impl.LoggingThreadLifecycleListener

All Implemented Interfaces:

ThreadLifecycleListener

public class LoggingThreadLifecycleListener
extends java.lang.Object
implements ThreadLifecycleListener

Thread listener with logging support

Since:

11.06.2021

Constructor Summary

Constructors

Constructor	Description
LoggingThreadLifecycleListener()

Method Summary

Modifier and Type	Method	Description
void	crashed(QueueShardId shardId, QueueLocation location, java.lang.Throwable exc)	Queue failed with fatal error.
void	executed(QueueShardId shardId, QueueLocation location, boolean taskProcessed, long threadBusyTime)	Thread was executed and finished processing.
void	finished(QueueShardId shardId, QueueLocation location)	End of the task processing lifecycle and start of the new one.
void	started(QueueShardId shardId, QueueLocation location)	Start of the task processing in the queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoggingThreadLifecycleListener

public LoggingThreadLifecycleListener()

Method Detail

started

public void started(@Nonnull
                    QueueShardId shardId,
                    @Nonnull
                    QueueLocation location)

Description copied from interface: ThreadLifecycleListener

Start of the task processing in the queue.

Always called.

Might be useful for setting values in the logging context or change thread name.

Specified by:

started in interface ThreadLifecycleListener

Parameters:

shardId - Shard identifier, which processes the queue.

location - Queue location.

executed

public void executed(QueueShardId shardId,
                     QueueLocation location,
                     boolean taskProcessed,
                     long threadBusyTime)

Description copied from interface: ThreadLifecycleListener

Thread was executed and finished processing.

Called when normal end of task processing.

Might be useful for measuring performance of the queue.

Specified by:

executed in interface ThreadLifecycleListener

Parameters:

shardId - Shard identifier, which processes the queue.

location - Queue location.

taskProcessed - Attribute that task was taken and processed, no tasks for processing otherwise.

threadBusyTime - Time in millis of the thread was running active before sleep.

finished

public void finished(@Nonnull
                     QueueShardId shardId,
                     @Nonnull
                     QueueLocation location)

Description copied from interface: ThreadLifecycleListener

End of the task processing lifecycle and start of the new one.

Always called, even after ThreadLifecycleListener.crashed(ru.yoomoney.tech.dbqueue.config.QueueShardId, ru.yoomoney.tech.dbqueue.settings.QueueLocation, java.lang.Throwable).

Might be useful for logging context return or move the thread to the initial state.

Specified by:

finished in interface ThreadLifecycleListener

Parameters:

shardId - Shard identifier, which processes the queue.

location - Queue location.

crashed

public void crashed(@Nonnull
                    QueueShardId shardId,
                    @Nonnull
                    QueueLocation location,
                    @Nullable
                    java.lang.Throwable exc)

Description copied from interface: ThreadLifecycleListener

Queue failed with fatal error.

Client code cannot trigger that method call, this method is called when task picking crashed.

Might be useful for logging and monitoring.

Specified by:

crashed in interface ThreadLifecycleListener

Parameters:

shardId - Shard identifier, which processes the queue.

location - Queue location.

exc - An error caused the crash.