Skip to content

manager.md

Latest commit

 

History

History
74 lines (53 loc) · 2.8 KB

manager.md

File metadata and controls

74 lines (53 loc) · 2.8 KB

Manager Component

The Manager serves as the central hub in Backend.AI's architecture. It receives requests from clients and orchestrates operations across Agents, Storage-Proxy, and App-Proxy services.

Entry Points

HTTP API

Apply HTTP middleware to the aiohttp application. The middleware:

  1. Extracts X-Backend-Request-ID header if present
  2. Generates new request ID if not present
  3. Binds request ID to context
  4. Adds X-Backend-Request-ID to response headers

Background Tasks

Apply context binding decorator to background tasks that don't originate from HTTP requests. The decorator auto-generates request ID and binds it to the async context.

Message Queue Event Handlers

Restore request ID from event metadata for causality tracking.

Outbound Propagation

Agent RPC Calls

Manager communicates with Agents via Callosum RPC. Include request ID in the request body:

request_body = {
    "headers": {"request_id": get_current_request_id()},  # from context
    "args": args,
    "kwargs": kwargs,
}

Legacy Agents without headers support will ignore the headers field.

HTTP Calls (Storage-Proxy, App-Proxy, WSProxy)

Include X-Backend-Request-ID header in all outbound HTTP requests.

Event System Integration

  • EventProducer: Include request_id in event metadata
  • EventDispatcher: Restore request_id from metadata when handling events

Request Flow

Client                    Manager                   Service
   │                         │                    (Agent/Storage/App-Proxy)
   │  HTTP Request           │                         │
   ├────────────────────────▶│                         │
   │                         │                         │
   │         middleware generates request_id           │
   │                         │                         │
   │                         │  RPC or HTTP call       │
   │                         │  (with request_id)      │
   │                         ├────────────────────────▶│
   │                         │                         │
   │                         │◀────────────────────────┤
   │                         │                         │
   │  X-Backend-Request-ID   │                         │
   │◀────────────────────────┤                         │

Implementation Checklist

  • HTTP middleware applied to main app and sub-apps
  • Context binding decorator on background tasks
  • Agent RPC calls include headers
  • Storage-Proxy/App-Proxy HTTP calls include header
  • Event system propagates request_id