Notification types v1
Edition: SaaS Enterprise
IMPORTANT: Notification types are versioned but the content might change overtime. Changes within a version will not change in a backwards incompatible way. We might add more event types or new properties. Fields such as notificationLevel and notificationType could get more possible values. So make sure to that your implementation is able to ignore properties/values which cannot be recognized.
Supported notification types:
Notification content
Field | Types | Notes |
---|---|---|
sourceId | UUID | Mandatory id generated on source side to make surrogate unique id for tracking event. |
tenant | String | Identifier of the tenant the notification originated from. |
installation | String | Installation service name the notification originated from. |
environment | String | Environment name the notification originated from. |
notificationId | UUID | Identifier of the notification. |
notificationChannel | UUID | identifier of the notification channel. |
notificationLevel | String | Severity of the notification:
|
notificationType | String | Type of the error:
|
notificationTime | Timestamp | Time of the notification. |
notificationSource | String | Notification event source. |
contentText | String | Notification message in text format. |
contentType | String | Notification event type. |
contentLink | String | Link to the notified content. |
WorkflowFailure
This event happens when Dagger run for certain schedule fails.
{
"sourceId": "cf1e80db-3c1a-4b7b-88b7-2518b229603a",
"tenant": "s1234567",
"installation": "datahub",
"environment": "runtime",
"notificationId": "4fd01f17-4403-4a20-be86-3728611b4ad4",
"notificationChannel": "0bf43704-8ac7-4ca8-86e1-155de3e56389",
"notificationLevel": "ERROR",
"notificationType": "OPERATIONAL",
"notificationTime": "2022-01-13T12:50:05.358Z",
"notificationSource": "AdeCore/WorkflowOrchestration",
"contentText": "Workflow MY_DAG failed: Some problem description.",
"contentType": "WorkflowFailure",
"contentLink": "<https://external.runtime.datahub.s1234567.agiledataengine.com/dagger/graph?dag_id=MY_DAG&execution_date=2022-01-12T10%3A16%3A58.119141%2B00%3A00",>
}
SmokeTestFailure (black/grey)
This event happens when a smoke test in dagger run fails. Notification level is ERROR for black smoke tests and WARNING for grey smoke tests.
{
"sourceId": "cf1e80db-3c1a-4b7b-88b7-2518b229603a",
"tenant": "s1234567",
"installation": "datahub",
"environment": "runtime",
"notificationId": "4fd01f17-4403-4a20-be86-3728611b4ad4",
"notificationChannel": "0bf43704-8ac7-4ca8-86e1-155de3e56389",
"notificationLevel": "WARN|ERROR", # black=ERROR, grey=WARNING
"notificationType": "OPERATIONAL",
"notificationTime": "2022-01-13T12:50:05.358Z",
"notificationSource": "AdeCore/WorkflowOrchestration",
"contentText": "Smoke test my_smoketest failed: Test: my_smoketest - Type: SMOKE_BLACK, SmokeSQL: SELECT 1",
"contentType": "SmokeTestFailure",
"contentLink": "<https://external.runtime.datahub.s1234567.agiledataengine.com/dagger/graph?dag_id=MY_DAG&execution_date=2022-01-12T10%3A16%3A58.119141%2B00%3A00">
}