Files
tracer-cloud--opensre/docs/incident_io.mdx
T
wehub-resource-sync 4b6817381b
CI (OpenClaw E2E) / openclaw test (push) Has been cancelled
CI / coverage-report (push) Has been cancelled
CI / test-kubernetes (push) Has been cancelled
CI / should-run-thorough (push) Has been cancelled
CI / test-thorough (cloudwatch-demo) (push) Has been cancelled
CI / test-thorough (flink-ecs) (push) Has been cancelled
CI / test-thorough (upstream-lambda) (push) Has been cancelled
CI / test-thorough (prefect-ecs-fargate) (push) Has been cancelled
Release / build-binaries (zip, opensre.exe, onefile, windows-latest, windows-x64) (push) Has been cancelled
Benchmark image — build + push to ECR (any adapter) / build + push (push) Has been cancelled
CI / quality (ubuntu-latest) (push) Has been cancelled
CI / test (tools-runtime) (push) Has been cancelled
CI / test (e2e-general) (push) Has been cancelled
CI / test (cli-runtime) (push) Has been cancelled
CI / test (e2e-provider-and-openclaw) (push) Has been cancelled
CI / test (integrations-and-misc) (push) Has been cancelled
Release / verify (push) Has been cancelled
Release / build-python-dist (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-15-intel, darwin-x64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-latest, darwin-arm64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04, linux-x64) (push) Has been cancelled
Release / publish-release (push) Has been cancelled
Release / publish-main-release (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-checks (no-LLM) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-live shard ${{ matrix.shard_index }} (push) Has been cancelled
Release / prepare (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04-arm, linux-arm64) (push) Has been cancelled
Synthetic Deterministic Tests / Synthetic offline (deterministic) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:10:45 +08:00

59 lines
1.8 KiB
Plaintext

---
title: "incident.io"
description: "Connect incident.io so OpenSRE can read incident context, updates, and metadata during investigations"
---
OpenSRE can use incident.io as incident context during RCA. The integration can list live incidents, fetch full incident metadata, read incident updates, and append final findings to the incident summary through the supported incident edit API.
## Prerequisites
- incident.io account
- incident.io API key with read access to incidents and incident updates
- Write permission if you want OpenSRE to append findings to incident summaries
## Setup
### Interactive CLI
```bash
opensre integrations setup incident_io
```
### Environment variables
```bash
INCIDENT_IO_API_KEY=your-api-key
```
| Variable | Default | Description |
| --- | --- | --- |
| `INCIDENT_IO_API_KEY` | - | Required incident.io API key |
| `INCIDENT_IO_BASE_URL` | `https://api.incident.io` | Optional API URL override for tests or private routing |
## Verify
```bash
opensre integrations verify incident_io
```
Verification performs a minimal `GET /v2/incidents` request.
## Investigation Behavior
When an alert includes an incident.io incident ID or URL, OpenSRE makes the `incident_io_incidents` action available with `action="context"`. That reads:
- incident metadata from `GET /v2/incidents/{id}`
- incident updates from `GET /v2/incident_updates?incident_id={id}`
If no incident ID is present, OpenSRE can use `action="list"` to list live incidents.
## Write-Back
OpenSRE does not create native timeline events. incident.io's public v2 API supports editing incidents, so OpenSRE write-back uses:
```text
POST /v2/incidents/{id}/actions/edit
```
The action appends findings to the incident summary. Use `action="append_summary"` only after the RCA has useful findings or next steps ready to publish.