Skip to content

ServiceMessage

Model of Service Heartbeat Message

Field Type Description Required Default
msg Heartbeat Heartbeat message
Yes
None
msg_loader Enum Loader class for message
Values:
"assemblyline.odm.messages.service_heartbeat.ServiceMessage"
Yes
assemblyline.odm.messages.service_heartbeat.ServiceMessage
msg_type Enum Type of message
Values:
"ServiceHeartbeat"
Yes
ServiceHeartbeat
sender Keyword Sender of message
Yes
None

Heartbeat

Heartbeat Model

Field Type Description Required Default
activity Activity Service activity
Yes
None
instances Integer Service instances
Yes
None
metrics Metrics Service metrics
Yes
None
queue Integer Service queue
Yes
None
service_name Keyword Service name
Yes
None

Activity

Service Activity

Field Type Description Required Default
busy Integer Number of busy instances
Yes
None
idle Integer Number of idle instances
Yes
None

Metrics

Service Metrics

Field Type Description Required Default
cache_hit Integer Number of cache hits
Yes
None
cache_miss Integer Number of cache misses
Yes
None
cache_skipped Integer Number of cache skips
Yes
None
execute Integer Number of service executes
Yes
None
fail_recoverable Integer Number of recoverable fails
Yes
None
fail_nonrecoverable Integer Number of non-recoverable fails
Yes
None
scored Integer Number of tasks scored
Yes
None
not_scored Integer Number of tasks not scored
Yes
None