Skip to content

Commit 5d40973

Browse files
authored
change docs for incident.io alert support (#145)
1 parent b38406b commit 5d40973

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

docs/production/scheduling-metaflow-flows/scheduling-with-argo-workflows.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -328,12 +328,22 @@ python debug --notify-on-success --notify-on-error --notify-pager-duty-integrati
328328

329329
### Incident.io alerts
330330

331-
For notifications through Incident.io, generate an API key with a permission to *create incidents* on the websites *settings* page.
332-
333-
As Incident.io deals with incidents, every notification requires a severity. These can be supplied with the `--incident-io-success-severity-id/--incident-io-error-severity-id` options.
331+
For notifications through Incident.io, we need to create an alert source configuration HTTP endpoint. After creating this, grab the provided `authorization token`, and the `alert source config ID` as we will need these when deploying our flow.
334332

335333
Once you have gathered all the necessary information, the flow can be deployed with
336334

337335
```bash
338-
python debug.py argo-workflows --notify-on-error --incident-io-error-severity-id severity-id-for-errors --notify-incident-io-api-key key-that-we-generated
336+
python debug.py argo-workflows --notify-on-success --notify-on-error --notify-incident-io-api-key token --incident-io-alert-source-config-id source-config-id
337+
```
338+
339+
Metaflow sets the following metadata for the alert payload so that the consumption can be customized on the Incident.io side.
340+
341+
```python
342+
{
343+
"metadata": {
344+
"run_status": "failed or succeeded",
345+
"flow_name": "HelloFlow"
346+
"run_id": "run-123"
347+
}
348+
}
339349
```

0 commit comments

Comments
 (0)