Skip to content

ElasticMessage

Model of Elasticsearch Heartbeat Message

Field Type Description Required Default
msg Heartbeat Heartbeat message for elasticsearch
Yes
None
msg_loader Enum Loader class for message
Values:
"assemblyline.odm.messages.elastic_heartbeat.ElasticMessage"
Yes
assemblyline.odm.messages.elastic_heartbeat.ElasticMessage
msg_type Enum Type of message
Values:
"ElasticHeartbeat"
Yes
ElasticHeartbeat
sender Keyword Sender of message
Yes
None

Heartbeat

Heartbeat Model for Elasticsearch

Field Type Description Required Default
instances Integer Number of Elasticsearch instances with assigned shards
Yes
None
unassigned_shards Integer Number of unassigned shards in the cluster
Yes
None
request_time Float Time to load shard metrics
Yes
None
shard_sizes List [IndexData] Information about each index
Yes
None

IndexData

Information about an elasticsearch shard

Field Type Description Required Default
name Keyword None
Yes
None
shard_size Integer None
Yes
None