88 lines
3.2 KiB
Markdown
88 lines
3.2 KiB
Markdown
# The dashboard app
|
|
|
|
Open your instance's app address, or select it at [fluksio.com](https://fluksio.com)
|
|
after enrollment. For the local Docker setup, use
|
|
[app.localhost](http://app.localhost) and the admin login printed by
|
|
`make init`. See [Getting started](../getting-started/index.md) for setup.
|
|
|
|
## Finding your way around
|
|
|
|
The sidebar opens as a sheet on phones.
|
|
|
|
| Entry | Use it to |
|
|
|---|---|
|
|
| **Home** | see the brain graph, health and recent activity |
|
|
| **Flows** | create flows and open their editors |
|
|
| **Dashboards** | build widget dashboards and pair wall panels |
|
|
| **Runs** | start batch runs and review their results |
|
|
| **Workers** | manage machines that execute nodes |
|
|
| **Secrets** | store credentials; superusers only |
|
|
| **Modules** | see or install packages used by node code |
|
|
| **Alerts** | choose where failures are reported |
|
|
| **Admin** | manage users and OAuth clients; superusers only |
|
|
| **Search** | find items by name |
|
|
| **Settings** | change your account, appearance and remote access |
|
|
|
|
**Assistant** appears when a provider is configured. **Documentation** opens
|
|
the docs in another tab.
|
|
|
|
### Search
|
|
|
|
Use **Search**, or ⌘K / Ctrl-K, to find flows, nodes, flow inputs and outputs,
|
|
dashboards, widgets, panels, secrets, modules, workers and alert channels.
|
|
Selecting a result opens its editor or settings.
|
|
|
|
Search covers the current instance. When connected through a portal,
|
|
**All instances** returns to the instance list.
|
|
|
|
## Home
|
|
|
|
### The brain graph
|
|
|
|
The graph combines nodes from published flows. Nodes talking to the same
|
|
broker topic, URL or other external target share a neuron; computation nodes
|
|
appear individually. Messages connect them, and activity makes them pulse.
|
|
|
|
A problem keeps the affected neuron's label visible. A
|
|
[`wren` node](../reference/node-types.md#wren) also adds a chat button for its
|
|
[Control tab](../code/agents.md#control).
|
|
|
|
### Flows and dashboards
|
|
|
|
The flow list includes switches to start and stop flows. Dashboard tiles show
|
|
a small sketch of each layout; open one for its live readings.
|
|
|
|
### Health
|
|
|
|
Health shows flow status, node load errors, queue depth and event-loop lag.
|
|
After you have used batch runs, it also shows running and queued runs.
|
|
A degraded instance lists the problems that need attention.
|
|
|
|
### Activity
|
|
|
|
Choose 1h, 6h, 24h or 7d to review executions and failures, recent runs,
|
|
dead-lettered work and the audit trail. Hover a chart to filter the lists to
|
|
that moment; click to hold the selection while you read.
|
|
|
|
## Managing flows and dashboards
|
|
|
|
The lists show titles, unpublished changes and status. Use **New flow** or
|
|
**New dashboard** to create one. The Flows list offers **Publish all changes**
|
|
when drafts are waiting.
|
|
|
|
To delete several items, hold a card or Ctrl-click it, then select the rest.
|
|
The create button becomes a trash button. Deletion asks for confirmation;
|
|
Escape clears the selection.
|
|
|
|
## Appearance
|
|
|
|
Light and dark follow your system by default. Change this under
|
|
**Settings → Appearance**. Dashboards also have their own theme settings.
|
|
|
|
## Next stops
|
|
|
|
- [The flow editor](flow-editor.md)
|
|
- [Dashboards and panels](dashboards.md)
|
|
- [Secrets, modules and alerts](operations.md)
|
|
- [Accounts and the portal](portal.md)
|