DispatcherMessage¶

Model of Dispatcher Heartbeat Messages

Field	Type	Description	Required	Default
msg	Heartbeat	Heartbeat message	Yes	`None`
msg_loader	Enum	Loader class for message Supported values are: `"assemblyline.odm.messages.dispatcher_heartbeat.DispatcherMessage"`	Yes	`assemblyline.odm.messages.dispatcher_heartbeat.DispatcherMessage`
msg_type	Enum	Type of message Supported values are: `"DispatcherHeartbeat"`	Yes	`DispatcherHeartbeat`
sender	Keyword	Sender of message	Yes	`None`

Heartbeat¶

Heartbeat Model

Field	Type	Description	Required	Default
inflight	Inflight	Inflight submissions	Yes	`None`
instances	Integer	Number of instances	Yes	`None`
metrics	Metrics	Dispatcher metrics	Yes	`None`
queues	Queues	Dispatcher queues	Yes	`None`
component	Keyword	Component name	Yes	`None`

Inflight Model

Field	Type	Description	Required	Default
max	Integer	Maximum number of submissions	Yes	`None`
outstanding	Integer	Number of outstanding submissions	Yes	`None`
per_instance	List [Integer]	Number of submissions per Dispatcher instance	Yes	`None`

Metrics Model

Field	Type	Description	Required	Default
files_completed	Integer	Number of files completed	Yes	`None`
submissions_completed	Integer	Number of submissions completed	Yes	`None`
service_timeouts	Integer	Number of service timeouts	Yes	`None`
cpu_seconds	PerformanceTimer	CPU time	Yes	`None`
cpu_seconds_count	Integer	CPU count	Yes	`None`
busy_seconds	PerformanceTimer	Busy CPU time	Yes	`None`
busy_seconds_count	Integer	Busy CPU count	Yes	`None`
save_queue	Integer	Processed submissions waiting to be saved	Yes	`None`
error_queue	Integer	Errors waiting to be saved	Yes	`None`

Queue Model

Field	Type	Description	Required	Default
ingest	Integer	Number of submissions in ingest queue	Yes	`None`
start	List [Integer]	Number of submissions that started	Yes	`None`
result	List [Integer]	Number of results in queue	Yes	`None`
command	List [Integer]	Number of commands in queue	Yes	`None`