Skip to main content

Console Execution Guide

Use the Relay console (app.deployrelay.app) to manage and execute functions without leaving the browser.

Prerequisites​

  • Console account with tenant access.
  • API key or Clerk session with functions:execute scope.
  • Execution API reachable at https://api.deployrelay.com (or staging equivalent).

Function Catalog​

  1. Open the console and select Executions in the sidebar.
  2. The catalog table lists tenant-scoped functions with latest status, latency, error rate, and total runs.
  3. Use Refresh or Load more to fetch additional pages; the table queries /execution/functions.
  4. Click Run on any row to open the execution modal.

Execution History​

  • Filter by RUFID, status, or time range—filters call /execution/history server-side.
  • Reset clears filters; Refresh re-fetches results.
  • Selecting an entry opens a detail dialog with telemetry, logs, and metadata.

Running Functions​

  1. Choose Run in the catalog or history row.
  2. Adjust namespace and JSON payload in the modal.
  3. Optional toggles:
    • Async execution submits without waiting.
    • Relaxed sandbox options (network/file system) when policy allows.
  4. Click Run function. Synchronous runs show the response inline; async runs show queue identifiers.
  5. The history panel refreshes automatically after completion.

Metrics & Logs​

  • Detail dialog displays duration, memory, status, and log output.
  • Datadog-backed widgets (if credentials supplied) render latency/error charts from FN-056 telemetry exports.

Automated Coverage​

  • E2E: npm run test:e2e -- --project=chromium src/test/e2e/developer-dashboard.spec.ts
  • Accessibility: npm run test:a11y

Troubleshooting​

SymptomFix
Catalog emptyVerify backend reachability and user permissions.
403 errorsRotate API keys or confirm Clerk session scopes.
Modal validation errorsEnsure JSON payload is valid and sandbox flags allowed.
Logs missingPending/async executions may need a manual refresh once complete.

Keep this guide in sync with the FN-054 console integration issue and Playwright coverage.