OpsOrch Documentation

Unified API Layer

OpsOrch exposes unified APIs for incidents, logs, metrics, tickets, messaging, and services. All schemas are documented and evolving to support growing operational needs.

Adapter Architecture

OpsOrch Core contains no provider logic. Adapters implement capability interfaces in separate repositories and register with the registry. Load in-process or as out-of-process plugins.

QueryScope

All queries accept a shared `QueryScope` filter with service, team, and environment fields. Adapters map these to their native query languages for consistent cross-provider filtering.

Structured Queries

OpsOrch uses structured expressions for logs and metrics instead of free-form strings, ensuring validation and consistency across providers.

Query Incidents

curl -X POST http://localhost:8080/incidents/query \
  -H "Content-Type: application/json" \
  -d '{
    "statuses": ["open"],
    "severities": ["critical", "high"],
    "scope": {"service": "api", "environment": "prod"}
  }'

Query Metrics

curl -X POST http://localhost:8080/metrics/query \
  -H "Content-Type: application/json" \
  -d '{
    "expression": {
      "metricName": "http_requests_total",
      "aggregation": "sum",
      "filters": [{"label": "status", "operator": "=", "value": "500"}]
    },
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-01T01:00:00Z",
    "step": 60
  }'

Query Logs

curl -X POST http://localhost:8080/logs/query \
  -H "Content-Type: application/json" \
  -d '{
    "expression": {
      "search": "connection timeout",
      "severityIn": ["error", "critical"]
    },
    "scope": {"service": "gateway"}
  }'