# opensre **Repository Path**: xiaohan2013/opensre ## Basic Information - **Project Name**: opensre - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-10-14 - **Last Updated**: 2026-10-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

OpenSRE v0.1: Build Your Own AI SRE Agents

The open-source framework for AI SRE agents, and the training and evaluation environment they need to improve. Connect the 60+ tools you already run, define your own workflows, and answer production questions on your own infrastructure.

Quickstart · Docs · FAQ · Security

--- > 🚧 Public Alpha: Core workflows are usable for early exploration, though not yet fully stable. The project is in active development, and APIs and integrations may evolve. --- ## Before you begin Make sure you have: - A terminal open in a code project - A Git repository (recommended for the full workflow demonstration) ## Step 1: Install and start opensre macOS or Linux: ```bash curl -fsSL https://install.opensre.com | bash -s -- -gh ``` Windows (PowerShell): ```powershell & ([scriptblock]::Create((irm https://install.opensre.com/install.ps1))) -gh ``` Then start OpenSRE: ```bash opensre ``` ![OpenSRE CLI welcome screen with the sign-in prompt](docs/images/opensre-welcome.png) Windows details: [Windows](docs/install/windows-local.mdx). The installer fetches the latest build from `main` without requiring sudo. If `opensre` is not found, follow the PATH instructions printed by the installer or open a new terminal. For supported platforms and troubleshooting, see [Install locally](https://www.opensre.com/docs/install/install-local). --- ## Table of Contents - [Before you begin](#before-you-begin) - [Install and start opensre](#step-1-install-and-start-opensre) - [Why OpenSRE?](#why-opensre) - [Quick Start](#quick-start) - [Deployment](#deployment) - [How OpenSRE Works](#how-opensre-works) - [Capabilities & integrations](#capabilities--integrations) - [Contributing & development](#contributing--development) - [Security](#security) - [Telemetry](#telemetry) - [License](#license) - [Citations](#citations) --- ## Why OpenSRE? When something breaks in production, the evidence is scattered across logs, metrics, traces, runbooks, and Slack threads. OpenSRE is an open-source framework for AI SRE agents that resolve production incidents, built to run on your own infrastructure. We do that because SWE-bench¹ gave coding agents scalable training data and clear feedback. Production incident response still lacks an equivalent. Distributed failures are slower, noisier, and harder to simulate and evaluate than local code tasks, which is why AI SRE, and AI for production debugging more broadly, remains unsolved. OpenSRE is building _that_ missing layer: > an open reinforcement learning environment for agentic infrastructure incident response, with end-to-end tests for realistic production failures We do that by: - building easy-to-deploy, customizable AI SRE agents for production operations and incident response - running real-world end-to-end tests across cloud-backed scenarios [(tests/e2e)](tests/e2e) - keeping semantic test-catalog naming so e2e vs unit and local vs cloud boundaries stay obvious [(tests/README.md)](tests/README.md) Our mission is to build AI SRE agents on top of this, scale it to thousands of realistic infrastructure failure scenarios, and establish OpenSRE as the benchmark and training ground for AI SRE. ¹ https://arxiv.org/abs/2310.06770 --- ## Quick Start Contributors: start at [`main.py`](main.py) for the process entrypoint map. Run `opensre` to sign in and get started. The first launch activates the hosted model. ```bash opensre ``` Webapp contributors can run `opensre setup --dev` to authenticate through `http://localhost:3000`. **Interactive shell** — with no subcommand, `opensre` validates your account and starts a REPL (TTY required). You can exit and stay signed out, but the shell only opens for an active account. Describe incidents in plain language, watch the agent work, and use slash commands for session control (`/help`, `/status`, `/cost`, `/sessions`, `/resume`, `/compact`, `/new`, `/exit`), integrations (`/integrations list`, `/integrations verify`), and local agent fleet monitoring (`/agents`). Ctrl+C cancels an in-flight turn without losing session state. See **[interactive shell commands](https://www.opensre.com/docs/getting-started/interactive-shell-commands)** for the full reference. **Headless CLI** — run one agent turn non-interactively from a terminal, script, or CI job: ```bash opensre ask "why is checkout-api slow?" ``` See **[Headless CLI](https://www.opensre.com/docs/guides/headless-cli)** for stdin prompts, JSON output, and tool approvals. **From Python** — drive the agent in-process from your own code (source checkout required): ```python from bootstrap.embedded import start_embedded_session session = start_embedded_session() result = session.chat("why is checkout-api slow?") if result.answered: print(result.primary_response_text) ``` See **[Python API](https://www.opensre.com/docs/guides/python-api)** for sessions, conversations, and custom output sinks. **For your team's daily loop:** embed OpenSRE in the Python services and automations your teammates already use. Start with the in-repo [Python API guide](docs/guides/python-api.mdx), then use it every day to make incident response repeatable. Other useful commands: ```bash opensre integrations setup opensre fleet scan opensre update opensre uninstall # remove opensre and all local data ``` --- ## Deployment An OpenSRE Cloud managed gateway, an AWS EC2 path, and a general self-hosted option: - **OpenSRE Cloud managed gateway:** an organization admin provisions it in the web app; signed-in shell users can check, start, or stop it without handling infrastructure credentials locally. - **Gateway (AMI + systemd):** `make build-gateway-image` then `make deploy-gateway` — Telegram gateway only, no Docker; the gateway is installed into a server image that new servers start from. - **Self-hosted container (Railway / ECS / Vercel):** deploy the repo `Dockerfile`, select `MODE`, and set `LLM_PROVIDER` plus its API key. Use `DATABASE_URL` only when the gateway needs shared Postgres-backed state, such as Slack Events API replicas. **[Full deployment steps and prerequisites → DEPLOYMENT.md](DEPLOYMENT.md)** --- ## How OpenSRE Works opensre-how-it-works-github

When you ask a question or an alert arrives, OpenSRE automatically: 1. **Fetches** the relevant context and correlated logs, metrics, traces, and recent deploys 2. **Masks** sensitive identifiers (optional) before external LLM calls 3. **Reasons** across your connected systems to test hypotheses in a tool-calling loop 4. **Answers** with an evidence-linked response in the conversation 5. **Suggests** next steps and, optionally, executes remediation actions 6. **Posts** a summary directly to Slack, PagerDuty, or Telegram — no context switching needed For the current code-level agent architecture after removing the old graph and chain framework layers, see [AGENTS.md](AGENTS.md). --- ## Capabilities & integrations | | | | ---------------------------------------- | -------------------------------------------------------------------------------- | | 🔍 **Evidence-driven diagnosis** | Correlated analysis across logs, metrics, traces, deploys, and config | | 📋 **Runbook-aware reasoning** | OpenSRE reads your runbooks and applies them automatically | | 🔗 **Evidence-backed root cause** | Every conclusion is linked to the data behind it | | 🛡️ **Reversible identifier masking** | Redact pods, clusters, and account IDs before external LLM calls; restore in output | | 📊 **Session cost & history** | Per-session token tracking (`/cost`) and resumable REPL sessions (`/sessions`) | | 👥 **Local agent fleet** | Monitor Claude Code, Cursor, Codex, and other coding agents on your machine | | 🤖 **Full LLM flexibility** | Bring your own model — Anthropic, OpenAI, Codex, Ollama, Gemini, OpenRouter, TrustedRouter, NVIDIA NIM, Bedrock | OpenSRE connects to **60+** tools across LLMs, observability, cloud infrastructure, data platforms, incident management, and MCP. The full matrix (with roadmap links) lives in the **[product docs](https://www.opensre.com/docs)**; a detailed catalog is also maintained in-repo as the project grows. --- ## Integrations OpenSRE connects to 60+ tools and services across the modern cloud stack, from LLM providers and observability platforms to infrastructure, databases, and incident management. | Category | Integrations | Roadmap | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **AI / LLM Providers** | Anthropic · OpenAI · OpenAI Codex · Ollama · Google Gemini · OpenRouter · TrustedRouter · NVIDIA NIM · Bedrock | | | **Observability** |

Grafana (Loki · Mimir · Tempo · annotations) ·

Datadog · Honeycomb · Coralogix ·

groundcover ·

CloudWatch ·

Sentry · Elasticsearch · Better Stack · Splunk · Victoria Logs · SignOz · OpenObserve · OpenSearch · Azure Monitor · New Relic | | | **Infrastructure** |

Kubernetes ·

AWS (S3 · Lambda · EKS · EC2 · CloudTrail · Bedrock) ·

Azure · Yandex Cloud · ArgoCD · Helm | | | **Database** | MongoDB · ClickHouse · PostgreSQL · MySQL · MariaDB · MongoDB Atlas · Azure SQL · Snowflake · Redis · RDS · Supabase | | | **Data Platform** | Apache Airflow · Apache Kafka · Prefect · RabbitMQ · Dagster · Temporal | | | **Dev Tools** |

GitHub · GitHub MCP · Bitbucket · GitLab · Jenkins | | | **Incident Management** |

PagerDuty · Opsgenie · Jira · Alertmanager · incident.io · ServiceNow · Trello (client helpers only) | [Linear](https://github.com/Tracer-Cloud/opensre/issues/124) | | **Communication** |

Slack · Google Docs · Discord · Telegram ·

Rocket.Chat · WhatsApp · Buzz | [Notion](https://github.com/Tracer-Cloud/opensre/issues/286) · [Teams](https://github.com/Tracer-Cloud/opensre/issues/138) · [Confluence](https://github.com/Tracer-Cloud/opensre/issues/313) | | **Agent Deployment** |

Vercel ·

EC2 ·

ECS · Railway | | | **Protocols** |

MCP | | OpenSRE is community-built. Looking for a safe first contribution? Browse [`good first issue`](https://github.com/Tracer-Cloud/opensre/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tickets or see the [Good First Issues guide](docs/good-first-issues/README.md). See **[CONTRIBUTING.md](CONTRIBUTING.md)** for the full workflow. **Local environment:** **[SETUP.md](SETUP.md)** (all platforms, Windows, MCP). **Developing in this repo:** **[docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)** (install from source, CI parity checks, dev container, deployment detail, telemetry reference).

Thanks goes to these amazing people:

--- ## Security OpenSRE is designed with production environments in mind: structured and auditable LLM prompts, local transcript handling by default, and no silent bulk export of raw logs. See **[SECURITY.md](SECURITY.md)** for responsible disclosure. --- ## Telemetry First-party product analytics and Sentry (errors) are **opt-out**. Quick disable: ```bash export OPENSRE_NO_TELEMETRY=1 ``` **[Full matrix, DSN override, and local event logging → docs/DEVELOPMENT.md](docs/DEVELOPMENT.md#telemetry-and-privacy)** --- ## License Apache 2.0 — see [LICENSE](LICENSE). ## Citations ¹ https://arxiv.org/abs/2310.06770