Skip to main content

Overview

The Overview screen lets you see in one page the health, usage and spend of the platform for the current tenant, and jump to what needs a decision. Portal path: / (home page of the portal). Every signed-in user opens it: managers read the verdict, administrators (platform_admin, tenant_admin) see the same page titled Administrator dashboard. The screen is drawn by portal/src/screens/overview.tsx and only reads data: it changes nothing.

What the screen shows​

The page has five bands, from top to bottom. Each block loads on its own: while it loads it shows a grey placeholder, when its API call fails it shows the localized error message of the API, and when the call answers without data it shows No data yet.

BandContentData source
VerdictKicker Executive dashboard or Administrator dashboard followed by the tenant name, then one sentence: Everything is under control, Some items need your attention, Critical: immediate action required or Status being evaluated. Below it: N items need a decision or No pending approval, alert or incident., and three figures on the right: Error rate, p95 latency, Cost this month.GET /v1/me, GET /v1/telemetry/overview, GET /v1/finops/summary
Action chipsOne chip per subject that needs a decision: open incidents, pending approvals, budget alerts, quotas above 80 %, failing quality gates, error rate above 1 %.see the Actions table
Key figuresSix cards: Requests (with the window, for example Last 7 days), Cost today, Cost this month, Active agents, Open incidents, Quality gates passed (passed / total, or No evaluation yet).GET /v1/telemetry/overview, GET /v1/finops/summary, GET /v1/agents, GET /v1/incidents, GET /v1/evaluations/runs
TrendsTraffic and errors per day (area chart of requests and errors) and Spend per day (this month) (bar chart of the measured spend).GET /v1/telemetry/overview, GET /v1/finops/summary
Money and workMost expensive agents (month), Most expensive models (month) (ranked bars) and Agent runs (total, Succeeded, Running, Failed, Success rate).GET /v1/finops/summary, GET /v1/runs
Budgets and governanceBudgets and quotas (the six most used quotas, used / limit, percentage, red from 90 %, amber from 80 %) and Recent activity (audit) (the last eight audit events, a denied or failed event in red).GET /v1/quotas/usage, GET /v1/audit/events

How the verdict is computed (portal/src/lib/overview.ts):

  • Critical: a severe open incident, or an error rate above 5 %.
  • Some items need your attention: an error rate above 1 %, or at least one open incident, pending approval, budget alert, failing quality gate or quota above 80 %.
  • Everything is under control: none of the above.
  • Status being evaluated: none of these figures could be read yet.

The spend figures start on the first day of the current month. The approval, run, agent and incident counts read at most 200 rows each, the evaluation runs at most 100.

Actions​

The screen has no form and no button that changes data: every element is a link to the screen that holds the detail.

Button or actionWhat it doesAPI callRoles
Requests cardOpens Usage events (/finops/usage).GET /v1/telemetry/overviewAny signed-in user; the figure needs the right to read the telemetry.
Cost today and Cost this month cardsOpen the FinOps Summary (/finops/summary).GET /v1/finops/summaryFinOps readers
Active agents cardOpens the agents Registry (/agents/registry).GET /v1/agentsAgent readers
Open incidents cardOpens Incidents (/security/incidents).GET /v1/incidentsIncident readers
Quality gates passed cardOpens Quality gates (/quality/gates).GET /v1/evaluations/runsEvaluation readers
Details link of Traffic and errors per dayOpens Live metrics (/observability/metrics).GET /v1/telemetry/overviewObservability readers
Details link of Spend per day (this month), Most expensive agents (month), Most expensive models (month)Open the FinOps Summary.GET /v1/finops/summaryFinOps readers
Details link of Agent runsOpens Runs (/agents/runs).GET /v1/runsRun readers
Details link of Budgets and quotasOpens Quotas (/finops/quotas).GET /v1/quotas/usageFinOps readers
Details link of Recent activity (audit)Opens Events and chain (/audit/events).GET /v1/audit/eventsauditor, security_officer, tenant_admin, platform_admin
Chip N open incident(s)Opens Incidents; red when one incident is severe.GET /v1/incidentsIncident readers
Chip N pending approval(s)Opens the Approvals inbox (/agents/approvals).GET /v1/approvalsApproval readers
Chip N budget alert(s)Opens FinOps Alerts (/finops/alerts).GET /v1/finops/alertsFinOps readers
Chip N quota(s) above 80 %Opens Quotas.GET /v1/quotas/usageFinOps readers
Chip N failing quality gate(s)Opens Quality gates.GET /v1/evaluations/runsEvaluation readers
Chip Error rate at N %Opens Traces (/observability/traces); red above 5 %.GET /v1/telemetry/overviewObservability readers

Roles​

  • Every signed-in user can open the screen; GET /v1/me gives the tenant name and the roles.
  • The title Administrator dashboard is shown when the roles contain platform_admin or tenant_admin, otherwise Executive dashboard.
  • Each block keeps the rights of its own route: a block whose route refuses your role shows the error of the API (for example forbidden) while the other blocks stay readable. The audit block, for instance, follows the readers of GET /v1/audit/events declared in ROLES.auditReaders of portal/src/lib/kit.ts: auditor, security_officer, tenant_admin, platform_admin.

Typical tasks​

Read the state of the platform in the morning​

  1. Open the portal home page. The verdict summarizes the whole tenant in one sentence. Screen: Overview. Expected result: the verdict band is green (Everything is under control), amber or red. If it fails: a band that stays on Status being evaluated means that no figure could be read; check the error shown in the blocks.
  2. Read the action chips. Each chip names a subject that needs a decision and its count. Expected result: zero to six chips under the verdict. If it fails: when no chip appears while the verdict is amber, reload the page to refresh the counts.
  3. Click the first red chip. Red chips (severe incident, failing gate, error rate above 5 %) come first in priority. Expected result: the target screen opens (Incidents, Quality gates or Traces). If it fails: a forbidden error on the target screen means your role does not read that domain; ask a tenant_admin.

Check this month's spend​

  1. Read Cost today and Cost this month. They come from the FinOps summary grouped by day since the first of the month. Expected result: two amounts in the tenant currency. If it fails: None means that no usage was priced yet; check the price cards in the FinOps screens.
  2. Read Most expensive agents and Most expensive models. They show where the money goes. Expected result: ranked bars with amounts. If it fails: No data yet means no usage event this month.
  3. Open the detail. Click Details in one of these panels. Expected result: the FinOps Summary opens. If it fails: an error in the panel means your role is not a FinOps reader.

Find who did what recently​

  1. Read Recent activity (audit). The panel lists the last eight audit events: action, resource type, actor, date. Expected result: a list where denied or failed events are red. If it fails: a forbidden message means you are not an audit reader.
  2. Open the chain. Click Details to open Events and chain and filter the events. Expected result: the audit screen opens. If it fails: ask an auditor or a security_officer.

Troubleshooting​

SymptomCauseFix
Every block shows "The Control Plane API cannot be reached"The portal cannot reach the Control Plane API.Check that the API runs and that NEXT_PUBLIC_EAI_API_URL points to it.
One block shows a forbidden messageYour role does not read the route of this block (HTTP 403).Ask a tenant_admin for the reading role of the domain; the other blocks are not affected.
A block shows No data yetThe route answered with an empty list (no usage, no run, no quota this month).Normal on a new tenant; the block fills in with activity.
Cost today shows NoneNo priced usage event today.Check the price cards and the usage events of the FinOps screens.
Quality gates passed shows No evaluation yetNo evaluation run with a gate result.Run an evaluation suite from the Quality screens.
The verdict stays on Status being evaluatedNone of the figures used by the verdict could be read.Open the blocks one by one to read their errors.