Guides
The dashboard
What each page shows, where the numbers come from, and how to get your own gateway into it.
The dashboard reads your organisation's traffic from the control plane. It shows your calls, not benchmark runs. Until you log in it shows clearly labelled sample data so you can look around.
#Getting your traffic in
- Run the gateway with
-api-urlpointing at your control plane and your key in the environment variable named by-api-key-env(defaultRAKUVO_API_KEY). - Use a key with the gateway role for that. It can pull configuration and send calls, and nothing else.
- Log in to the dashboard with an admin or viewer key.
What the gateway sends is metadata: tokens, latency, retries, the agent's name and the notes each layer wrote. It does not send prompts or answers. See Security and privacy.
#Pages
| Page | What it answers |
|---|---|
| Overview | How many calls, how many failed, cost, tokens and median time, as charts over the last hour, 24 hours or 7 days. Alerts that are firing sit at the top. |
| Runs | Every call in order, with its outcome and cost and the notes layers recorded for it. Filter to calls where a layer acted, or to calls that were retried. |
| Agents | The same traffic split by agent, with spend share, failures, retries, median time and tokens. See Naming your agents. |
| Layers | The six layers drawn as the path a request takes, with an action count on each. Open a layer for every setting. |
| Memory | One user's remembered facts as a graph. See Memory graph. |
| Alerts | Rules that watch your traffic, and the times they fired. See Alerts. |
| Team | Access keys and their roles. See Keys and roles. |
| Billing | Your plan, this month's requests and an estimate of the bill. See Usage and billing. |
| Settings | How to connect a gateway: the data source, the command to start a gateway, and keys. |
#Changing a layer
Open Layers, switch a layer on or off, or open it to change its settings, then Save and apply. The settings are validated when they are saved, and a bad value is rejected with a message that names the field. A gateway started with -config-from-api notices the change on its next poll and swaps in the new pipeline without a restart.
#Time ranges
The ranges are the last hour, the last 24 hours and the last 7 days. The charts group calls into time buckets, and quiet buckets are drawn as zero so a gap looks like a gap.
#What it does not show
- The text of prompts and answers. It is not collected.
- Anything for a gateway that is not reporting. If a page is empty, see Troubleshooting.