Forge Protocol¶
Forge is the supported integration boundary for Aurum operations, runtime
data, and historical data. Terminal and Workbench use the same contracts; they
do not connect directly to aurumd, a strategy process, or ClickHouse.
Endpoint¶
Configure one browser-reachable Forge origin:
https://forge.example.com
Business calls are unary Connect RPCs with Content-Type: application/proto
and Connect-Protocol-Version: 1. Requests and responses are binary
Protobuf. ProtoJSON and REST aliases are not supported.
Canonical schemas¶
Package |
Responsibility |
|---|---|
|
|
|
Forge health, inventory, lifecycle, logs, runtime query, and datasource RPCs. |
|
Typed history catalog, summary, series, metrics, and preview RPCs. |
|
Runtime models and binary realtime envelopes. |
Data planes¶
Plane |
Interface |
Use |
|---|---|---|
Public control |
Binary Connect |
Inventory, health, lifecycle, logs, runtime status, and queries. |
Daemon control |
Framed Unix Protobuf |
Forge and CLI communication with |
History |
Binary Connect |
Run-scoped summaries and durable typed rows. |
Realtime |
Binary WebSocket |
Live resource updates at one canonical stream path. |
Metrics |
Prometheus text |
Monitoring only; not a business payload protocol. |
Use generated clients¶
Applications should generate a client from proto/aurum and enable binary
format. Do not construct service paths, field numbers, or realtime envelopes
by hand. The canonical realtime path and frame rules are documented in
Runtime Realtime.