Optimization
The optimizer plane
Cross-cutting optimization at every layer. Coalescing. Memoization. Strategy selection. Content-hash dedup.
This page is the documentation contract for the The optimizer plane surface in Vadyl's final form. It is not a marketing summary: it names the authorities, projections, runtime behavior, examples, limits, errors, and observability expectations that every product implementation must honor.
What this surface owns
- The optimizer plane owns the canonical product-facing contract described here; provider-specific machinery stays behind capability declarations.
- Cross-cutting optimization at every layer. Coalescing. Memoization. Strategy selection. Content-hash dedup.
- The final docs treat this as complete: REST, GraphQL, gRPC, SDK, CLI, MCP, dashboard, observability, limits, errors, and explainability are all covered as projections of one authority.
Canonical authorities
| Authority | Role |
|---|---|
ProjectRuntimeDescriptor | Pins The optimizer plane to a publication, runtime descriptor, worker, or substrate realization. |
descriptor fingerprints | Canonical owner for The optimizer plane; downstream surfaces derive from this rather than inventing their own truth. |
capability-aware plan selection | Canonical owner for The optimizer plane; downstream surfaces derive from this rather than inventing their own truth. |
observability feedback | Canonical owner for The optimizer plane; downstream surfaces derive from this rather than inventing their own truth. |
Projection coverage
| Surface kinds | ExplainabilitySurface, ObservabilitySurface, AnalyticsSurface, CacheInfrastructure |
| Projection facets | Explainability, Analytics, Observability, ExposureBindings |
| Protocols | Rest, Sdk, Cli, Dashboard |
| Public projections | explainability; read-plan diagnostics; analytics explain; runtime-fabric plans; observability metrics |
Project-scope parity
Publish, install, consume
Consumption evidence
Runtime behavior
- read-plan optimizer
- cache singleflight
- analytics materialization planner
- runtime-fabric reconciliation
- cost and quota gates
REST and controller surface
Code-backed controllers are listed here so the docs menu does not hide the real endpoint surface. The complete route-by-route table remains in the REST controller atlas.
| Controller | Base route | Endpoint count | Examples |
|---|---|---|---|
| Explainability | /api/Explainability | 15 | GET surfaceGET project-runtimeGET publication/latestGET publication/{publicationVersion:long} |
| Analytics | /api/Analytics | 45 | GET catalogGET catalog/subjects/{subjectId}GET catalog/dimensionsGET catalog/measures |
| RuntimeFabric | /api/RuntimeFabric and /api/PlatformRuntimeFabric | 35 | GET {projectId}/fabricGET {projectId}/realization/{projectEnvironmentId}GET {projectId}/health/{projectEnvironmentId}GET {projectId}/topology |
| Observability | /api/Observability | 8 | GET EntriesGET Entries/{id}GET Trail/{entityName}GET Trails |
SDK and CLI surface
| Projection | Namespace / group | Coverage |
|---|---|---|
| SDK | explainability | access, read-plan, surface, publication, analytics, automation, PCG, measure explanations. Rendered methods: 3. |
| SDK | analytics | catalog, query validate/explain/execute, models, metrics, reports, dashboards, materializations. Rendered methods: 6. |
| SDK | observability | audit, operational, debug, metrics, traces, diagnostics, reason-code correlation. Rendered methods: 4. |
| SDK | platform | provider health/capabilities, runtime fabric scaling, distribution, version governance, data portability. Rendered methods: 12. |
| CLI | vadyl explain | Project canonical decision reasoning. Rendered commands: 4. |
| CLI | vadyl analytics | Catalog, query, models, metrics, reports, dashboards, materializations. Rendered commands: 10. |
| CLI | vadyl runtime-fabric | Topology, scaling, resources, ingress, realization, health, binding, deployment plans, reconcile, drain. Rendered commands: 15. |
Input request and output
GET /api/Explainability/surface HTTP/1.1
Host: api.vadyl.app
Authorization: Bearer $VADYL_TOKEN
X-Vadyl-Tenant: acme
X-Vadyl-Project: billing
Content-Type: application/json
{
"surface": "optimization",
"publicationVersion": 412,
"explain": true
}Limits and quotas
Error model
| Error | Meaning |
|---|