Pipeline: Release 4.5.0.stable49 documentation

docs/odm/messages/alert.md

@@ -1,12 +1,12 @@
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 # AlertMessage
-> Model of Alert Message
+Model of Alert Message
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
 | msg | [Alert](/assemblyline4_docs/odm/models/alert/#alert) | Message of alert | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
-| msg_loader | Enum | Loader class for messages<br>Values:<br>`"assemblyline.odm.messages.alert.AlertMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.alert.AlertMessage` |
-| msg_type | Enum | Type of Message<br>Values:<br>`"AlertCreated", "AlertUpdated"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `AlertCreated` |
+| msg_loader | Enum | Loader class for messages<br>Supported values are:<br>`"assemblyline.odm.messages.alert.AlertMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.alert.AlertMessage` |
+| msg_type | Enum | Type of Message<br>Supported values are:<br>`"AlertCreated", "AlertUpdated"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `AlertCreated` |
 | sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 

docs/odm/messages/alerter_heartbeat.md

@@ -1,18 +1,18 @@
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 # AlerterMessage
-> Model of Alerter Heartbeat Message
+Model of Alerter Heartbeat Message
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
 | msg | [Heartbeat](/assemblyline4_docs/odm/messages/alerter_heartbeat/#heartbeat) | Heartbeat message from Alerter | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
-| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.alerter_heartbeat.AlerterMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.alerter_heartbeat.AlerterMessage` |
-| msg_type | Enum | Type of message<br>Values:<br>`"AlerterHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `AlerterHeartbeat` |
+| msg_loader | Enum | Loader class for message<br>Supported values are:<br>`"assemblyline.odm.messages.alerter_heartbeat.AlerterMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.alerter_heartbeat.AlerterMessage` |
+| msg_type | Enum | Type of message<br>Supported values are:<br>`"AlerterHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `AlerterHeartbeat` |
 | sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ## Heartbeat
-> Heartbeat Model for Alerter
+Heartbeat Model for Alerter
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
@@ -23,7 +23,7 @@
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ### Metrics
-> Alerter Metrics
+Alerter Metrics
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
@@ -36,7 +36,70 @@
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ### Queues
-> Alerter Queues
+Alerter Queues
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| alert | Integer | Number of alerts in queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| alert_retry | Integer | Number of alerts in retry queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+# Queues
+Alerter Queues
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| alert | Integer | Number of alerts in queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| alert_retry | Integer | Number of alerts in retry queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+# Metrics
+Alerter Metrics
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| created | Integer | Number of alerts created | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| error | Integer | Number of alerts with errors | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| received | Integer | Number of alerts received | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| updated | Integer | Number of alerts updated | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| wait | Integer | Number of alerts waiting for submission to complete | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+# Heartbeat
+Heartbeat Model for Alerter
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| instances | Integer | Number of Alerter instances | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| metrics | [Metrics](/assemblyline4_docs/odm/messages/alerter_heartbeat/#metrics) | Alert metrics | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| queues | [Queues](/assemblyline4_docs/odm/messages/alerter_heartbeat/#queues) | Alert queues | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+## Metrics
+Alerter Metrics
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| created | Integer | Number of alerts created | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| error | Integer | Number of alerts with errors | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| received | Integer | Number of alerts received | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| updated | Integer | Number of alerts updated | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| wait | Integer | Number of alerts waiting for submission to complete | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+## Queues
+Alerter Queues
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |

docs/odm/messages/archive_heartbeat.md

@@ -1,18 +1,18 @@
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 # ArchiveMessage
-> Model for Archive Heartbeat Messages
+Model for Archive Heartbeat Messages
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
 | msg | [Heartbeat](/assemblyline4_docs/odm/messages/archive_heartbeat/#heartbeat) | Heartbeat message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
-| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.archive_heartbeat.ArchiveMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.archive_heartbeat.ArchiveMessage` |
-| msg_type | Enum | Message type<br>Values:<br>`"ArchiveHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `ArchiveHeartbeat` |
+| msg_loader | Enum | Loader class for message<br>Supported values are:<br>`"assemblyline.odm.messages.archive_heartbeat.ArchiveMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.archive_heartbeat.ArchiveMessage` |
+| msg_type | Enum | Message type<br>Supported values are:<br>`"ArchiveHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `ArchiveHeartbeat` |
 | sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ## Heartbeat
-> Archive Heartbeat Model
+Archive Heartbeat Model
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
@@ -23,7 +23,52 @@
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ### Metrics
-> Archive Metrics
+Archive Metrics
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| file | Integer | Number of files archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| result | Integer | Number of results archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| submission | Integer | Number of submissions archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| received | Integer | Number of received archive messages | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| exception | Integer | Number of exceptions during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| invalid | Integer | Number of invalid archive type errors during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| not_found | Integer | Number of submission not found failures during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+# Metrics
+Archive Metrics
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| file | Integer | Number of files archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| result | Integer | Number of results archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| submission | Integer | Number of submissions archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| received | Integer | Number of received archive messages | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| exception | Integer | Number of exceptions during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| invalid | Integer | Number of invalid archive type errors during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| not_found | Integer | Number of submission not found failures during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+# Heartbeat
+Archive Heartbeat Model
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| instances | Integer | Number of instances | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| metrics | [Metrics](/assemblyline4_docs/odm/messages/archive_heartbeat/#metrics) | Archive metrics | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| queued | Integer | Number of documents to be archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+## Metrics
+Archive Metrics
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |