[NXP-29945] Provide a tool to analyze the content of the default WorkManager queue - Nuxeo Issue Tracker

XML

Word

Printable

Details

Type: New Feature
Status: Resolved
Priority: Minor
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 10.10-HF37, 11.5, 2021.0
Component/s: Events / Works

Tags:
- nxplatform
Upgrade notes:
Hide

There is now a way to get statistics on the type of Works that are processed in the default WorkManager queue.

./bin/stream.sh workCat --chronicle /var/lib/nuxeo/stream/ -l work/default -n 10 --codec avro ... pos,class,fullname,category,name work-default-01:+79907866542080,ListenerWork,org.nuxeo.ecm.core.event.impl.AsyncEventExecutor.ListenerWork,pictureViewsGenerationListener,ListenerWork(Listener...
Show
There is now a way to get statistics on the type of Works that are processed in the default WorkManager queue. ./bin/stream.sh workCat --chronicle / var /lib/nuxeo/stream/ -l work/ default -n 10 --codec avro ... pos, class, fullname,category,name work- default -01:+79907866542080,ListenerWork,org.nuxeo.ecm.core.event.impl.AsyncEventExecutor.ListenerWork,pictureViewsGenerationListener,ListenerWork(Listener...
Team:
PLATFORM
Sprint:
nxplatform #23
Story Points:
2

Description

The WorkManager default queue contains different types of Works.

When there is a performance issue represented by a lag on this queue, it is hard to understand what kind of processing is implied.

The idea is to dump the content of the queue and provide raw data that can be used for analytics, it should display:

Work class
Work Category
Work name

This will help to pinpoint which asynchronous listener is overly used and decide to create a dedicated queue and get access to WorkManager metrics.

This is only feasible for the StreamWorkManager where Works are persisted into a stream (and not destroyed after execution),
this can be done by adding a new command to the stream.sh tool.