Skip to content

request-flow.md

Latest commit

 

History

History
95 lines (75 loc) · 2.59 KB

request-flow.md

File metadata and controls

95 lines (75 loc) · 2.59 KB
Raw

Request Flow

Cloud → Agent → Datasource → Agent → Cloud

sequenceDiagram
    participant Caller as Cloud API
    participant Relay as Relay Server
    participant RMQ as RabbitMQ
    participant Agent as Forager Agent
    participant DS as Datasource

    Caller->>Relay: Request (e.g., run SQL query)
    Relay->>RMQ: Publish to relay_requests_{account_id}_proxy
    RMQ->>Relay: WS handler consumes from queue
    Relay->>Agent: Send over WebSocket
    Agent->>Agent: readLoop spawns handler goroutine
    Agent->>Agent: Route to proxy by datasource_id
    Agent->>DS: Execute against datasource
    DS->>Agent: Result
    Agent->>Relay: Response over WS (matching request_id)
    Relay->>Caller: HTTP response (correlation ID match)
Loading

Message Routing

// handler.go — HandleMessage
switch {
case action == "datasource_config_sync":
    → handleConfigSync()        // Reconfigure all proxies

case datasource_id != "":
    → handleRequest()           // Unified path: route by datasource_id
    → works for all proxy types (DB, HTTP, MCP, etc.)

case datasource_id == "":
    → handleLegacyRequest()     // Backward compat for old message formats
}

Unified Request Format

All requests use a single format with explicit datasource routing:

{
  "request_id": "abc-123",
  "datasource_id": "local:my-postgres",
  "action": "run_query",
  "params": {
    "query": "SELECT version()"
  }
}

For HTTP proxy requests (Grafana, Prometheus, custom APIs):

{
  "request_id": "abc-123",
  "datasource_id": "local:my-grafana",
  "action": "http_request",
  "method": "GET",
  "url": "/api/v1/query?query=up",
  "header": {"Authorization": ["Bearer token"]},
  "body": ""
}

The relay server wraps HTTP requests in unified format when the caller provides X-NB-Datasource-ID header. Legacy formats (without datasource_id) are still supported via fallback routing.

Response Format

All responses follow this structure:

{
  "request_id": "abc-123",
  "status_code": 200,
  "data": "..."
}

Relay Server Integration

The relay server converts requests for proxy agents based on the X-NB-Datasource-ID header:

Header present? Agent type Behavior
Yes proxy Wraps in unified format with datasource_id
No proxy Sends raw format, forager uses legacy fallback
Any k8s No change, sends original format

Affected relay handlers: grafana.go, api.go. The request.go handler (ExternalActionRequest) is unchanged — forager's legacy handler extracts datasource_id from action_params.