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
106 lines
4.4 KiB
Plaintext
106 lines
4.4 KiB
Plaintext
---
|
|
title: "Investigations overview"
|
|
description: "Start investigations from the interactive shell or CLI, review artifacts, and use plain-language REPL actions"
|
|
---
|
|
|
|
Use this workflow when running OpenSRE via the local `opensre` binary.
|
|
|
|
You can work in two ways:
|
|
|
|
- **Interactive prompt shell** — run `opensre` with no subcommand (TTY) to enter the REPL: describe incidents conversationally, stream investigations, and use slash commands.
|
|
- **Direct investigation** — run `opensre investigate` from your terminal with `-i` pointing at an alert payload (or `--interactive` to pick a file in the UI). The process runs and exits when the investigation completes.
|
|
|
|
## 1) Start an investigation
|
|
|
|
### Interactive shell (`opensre`)
|
|
|
|
From a terminal with stdin and stdout attached (`opensre` detects a TTY), run:
|
|
|
|
```bash
|
|
opensre
|
|
```
|
|
|
|
Then describe the incident or paste alert context at the prompt. Use `/help` for slash commands and `/exit` when finished. See [Interactive Shell Commands](/interactive-shell-commands) for the full slash-command reference (`/cost`, `/status`, `/investigate`, and every other REPL command).
|
|
|
|
When `LLM_PROVIDER` is `openai` or `codex`, `/effort` sets how much reasoning the model applies for that REPL session (`low`, `medium`, `high`, `xhigh`, or `max`). Run `/effort` with no arguments to print the current level and usage; `/status` includes the same field. Other providers ignore this setting (the shell prints a hint). You can also set `OPENSRE_REASONING_EFFORT` to `low`, `medium`, `high`, or `xhigh` in the environment for non-interactive defaults.
|
|
|
|
### Plain language and compound requests
|
|
|
|
You do not need to memorize every slash command. Describe what you want in natural language and the REPL planner maps intent to the right actions — often a sequence of slash commands executed in order.
|
|
|
|
Examples:
|
|
|
|
| You type | Typical action |
|
|
| --- | --- |
|
|
| "check the health of my opensre and then show connected services" | `/health`, then `/integrations list` |
|
|
| "verify datadog" | `/verify datadog` or `/integrations verify datadog` |
|
|
| "run the sample alert investigation" | `/investigate` with a built-in template |
|
|
| "connect to my remote EC2 instance and send it hello world" | `/remote` subcommands, then a remote investigation |
|
|
|
|
List-style questions map to **per-domain** commands (there is no global `/list`):
|
|
|
|
| Intent | Command |
|
|
| --- | --- |
|
|
| Connected integrations | `/integrations list` |
|
|
| Investigation tools | `/tools` |
|
|
| Background tasks | `/tasks` |
|
|
| MCP servers | `/mcp list` |
|
|
| Cron deliveries | `/cron list` |
|
|
| Past REPL sessions | `/sessions` |
|
|
|
|
For procedural questions ("how do I configure Datadog?"), the assistant answers from docs without running mutating commands unless you ask it to.
|
|
|
|
### Direct investigation (`opensre investigate`)
|
|
|
|
Pass an alert payload to `opensre investigate`:
|
|
|
|
```bash
|
|
opensre investigate -i tests/e2e/kubernetes/fixtures/datadog_k8s_alert.json
|
|
```
|
|
|
|
You can also use `--interactive` to pick an input file from your terminal UI.
|
|
|
|
For deployed services by name, see [Remote runtime investigation](/remote-runtime-investigation).
|
|
|
|
## 2) Review investigation artifacts
|
|
|
|
A local run produces structured RCA artifacts such as:
|
|
|
|
- `problem.md` for incident framing and initial hypothesis
|
|
- `theory/hypothesis_*.md` for each hypothesis tested during the run
|
|
- `report.md` for final root-cause summary and next steps
|
|
|
|
If you want a single machine-readable output file, pass:
|
|
|
|
```bash
|
|
opensre investigate -i <alert-file> --output ./rca.json
|
|
```
|
|
|
|
## 3) Understand what OpenSRE analyzed
|
|
|
|
Each run captures:
|
|
|
|
- the original alert payload
|
|
- extracted context and normalized evidence
|
|
- tool outputs collected from connected integrations
|
|
- final diagnosis and recommended remediation steps
|
|
|
|
## Session continuity
|
|
|
|
REPL sessions are persisted under `~/.opensre/sessions/`. When you exit, the shell prints a `/resume <session-id>` hint so you can pick up later. See [Session history](/sessions).
|
|
|
|
## Chat
|
|
|
|
For local binary usage, the primary workflow is file-based (`problem.md`, `report.md`, and optional JSON output).
|
|
You can open these artifacts in your editor and iterate from there (for example, by asking your editor's AI chat
|
|
to drill into specific hypotheses or evidence sections).
|
|
|
|
## Slack reports
|
|
|
|
If you've configured the Slack integration, OpenSRE can publish a concise incident summary into Slack after the
|
|
local investigation completes.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|