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

AuthorityRole
ProjectRuntimeDescriptorPins The optimizer plane to a publication, runtime descriptor, worker, or substrate realization.
descriptor fingerprintsCanonical owner for The optimizer plane; downstream surfaces derive from this rather than inventing their own truth.
capability-aware plan selectionCanonical owner for The optimizer plane; downstream surfaces derive from this rather than inventing their own truth.
observability feedbackCanonical owner for The optimizer plane; downstream surfaces derive from this rather than inventing their own truth.

Projection coverage

Surface kindsExplainabilitySurface, ObservabilitySurface, AnalyticsSurface, CacheInfrastructure
Projection facetsExplainability, Analytics, Observability, ExposureBindings
ProtocolsRest, Sdk, Cli, Dashboard
Public projectionsexplainability; 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.

        ControllerBase routeEndpoint countExamples
        Explainability/api/Explainability15
        GET surface
        GET project-runtime
        GET publication/latest
        GET publication/{publicationVersion:long}
        Analytics/api/Analytics45
        GET catalog
        GET catalog/subjects/{subjectId}
        GET catalog/dimensions
        GET catalog/measures
        RuntimeFabric/api/RuntimeFabric and /api/PlatformRuntimeFabric35
        GET {projectId}/fabric
        GET {projectId}/realization/{projectEnvironmentId}
        GET {projectId}/health/{projectEnvironmentId}
        GET {projectId}/topology
        Observability/api/Observability8
        GET Entries
        GET Entries/{id}
        GET Trail/{entityName}
        GET Trails

        SDK and CLI surface

        ProjectionNamespace / groupCoverage
        SDKexplainabilityaccess, read-plan, surface, publication, analytics, automation, PCG, measure explanations. Rendered methods: 3.
        SDKanalyticscatalog, query validate/explain/execute, models, metrics, reports, dashboards, materializations. Rendered methods: 6.
        SDKobservabilityaudit, operational, debug, metrics, traces, diagnostics, reason-code correlation. Rendered methods: 4.
        SDKplatformprovider health/capabilities, runtime fabric scaling, distribution, version governance, data portability. Rendered methods: 12.
        CLIvadyl explainProject canonical decision reasoning. Rendered commands: 4.
        CLIvadyl analyticsCatalog, query, models, metrics, reports, dashboards, materializations. Rendered commands: 10.
        CLIvadyl runtime-fabricTopology, 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

          ErrorMeaning

          Observability and explainability

            Related references