Skip to content

feature: change docs for incident.io alert support #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 13, 2025
Merged

feature: change docs for incident.io alert support #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/production/scheduling-metaflow-flows/scheduling-with-argo-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,12 +328,22 @@ python debug --notify-on-success --notify-on-error --notify-pager-duty-integrati

### Incident.io alerts

For notifications through Incident.io, generate an API key with a permission to *create incidents* on the websites *settings* page.

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.
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.

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

```bash
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
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
```

Metaflow sets the following metadata for the alert payload so that the consumption can be customized on the Incident.io side.

```python
{
"metadata": {
"run_status": "failed or succeeded",
"flow_name": "HelloFlow"
"run_id": "run-123"
}
}
```
Loading