ArchiveMessage¶
Model for Archive 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.archive_heartbeat.ArchiveMessage" |
Yes |
assemblyline.odm.messages.archive_heartbeat.ArchiveMessage |
| msg_type | Enum | Message type Supported values are: "ArchiveHeartbeat" |
Yes |
ArchiveHeartbeat |
| sender | Keyword | Sender of message | Yes |
None |
Heartbeat¶
Archive Heartbeat Model
| Field | Type | Description | Required | Default |
|---|---|---|---|---|
| instances | Integer | Number of instances | Yes |
None |
| metrics | Metrics | Archive metrics | Yes |
None |
| queued | Integer | Number of documents to be archived | Yes |
None |
Metrics¶
Archive Metrics
| Field | Type | Description | Required | Default |
|---|---|---|---|---|
| file | Integer | Number of files archived | Yes |
None |
| result | Integer | Number of results archived | Yes |
None |
| submission | Integer | Number of submissions archived | Yes |
None |
| received | Integer | Number of received archive messages | Yes |
None |
| exception | Integer | Number of exceptions during archiving | Yes |
None |
| invalid | Integer | Number of invalid archive type errors during archiving | Yes |
None |
| not_found | Integer | Number of submission not found failures during archiving | Yes |
None |