IngestMessage¶

Model of Ingester Heartbeat Message

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

Heartbeat¶

Heartbeat Model

Field	Type	Description	Required	Default
instances	Integer	Number of ingest processes	Yes	`None`
metrics	Metrics	Metrics	Yes	`None`
processing	Processing	Inflight queue sizes	Yes	`None`
processing_chance	ProcessingChance	Chance of processing items	Yes	`None`
queues	Queues	Queue lengths block	Yes	`None`

Metrics

Field	Type	Description	Required	Default
cache_miss	Integer	Number of cache misses	Yes	`None`
cache_expired	Integer	Number of cache expires	Yes	`None`
cache_stale	Integer	Number of cache stales	Yes	`None`
cache_hit_local	Integer	Number of cache local hits	Yes	`None`
cache_hit	Integer	Number of cache hits	Yes	`None`
bytes_completed	Integer	Number of bytes completed	Yes	`None`
bytes_ingested	Integer	Number of bytes ingested	Yes	`None`
duplicates	Integer	Number of duplicate submissions	Yes	`None`
error	Integer	Number of errors	Yes	`None`
files_completed	Integer	Number of completed files	Yes	`None`
skipped	Integer	Number of skipped files	Yes	`None`
submissions_completed	Integer	Number of completed submissions	Yes	`None`
submissions_ingested	Integer	Number of ingested submissions	Yes	`None`
timed_out	Integer	Number of timed_out submissions	Yes	`None`
whitelisted	Integer	Number of safelisted submissions	Yes	`None`
cpu_seconds	PerformanceTimer	None	Yes	`None`
cpu_seconds_count	Integer	None	Yes	`None`
busy_seconds	PerformanceTimer	None	Yes	`None`
busy_seconds_count	Integer	None	Yes	`None`

Processing

Field	Type	Description	Required	Default
inflight	Integer	Number of inflight submissions	Yes	`None`

Chance of Processing

Field	Type	Description	Required	Default
critical	Float	Chance of processing critical items	Yes	`None`
high	Float	Chance of processing high items	Yes	`None`
low	Float	Chance of processing low items	Yes	`None`
medium	Float	Chance of processing medium items	Yes	`None`

Queues

Field	Type	Description	Required	Default
critical	Integer	Size of the critical priority queue	Yes	`None`
high	Integer	Size of the high priority queue	Yes	`None`
ingest	Integer	Size of the ingest queue	Yes	`None`
complete	Integer	Size of the complete queue	Yes	`None`
low	Integer	Size of the low priority queue	Yes	`None`
medium	Integer	Size of the medium priority queue	Yes	`None`