Dashboard
Intuware ships with a built-in web dashboard for monitoring channels, browsing messages, reprocessing failures, and viewing live metrics — all from a single pane of glass.
Overview
Section titled “Overview”The dashboard is available at http://localhost:3001 by default and is enabled out of the box. It provides a real-time view of every channel in your project along with a full message browser and REST API.
Configuration
Section titled “Configuration”Configure the dashboard in your root intu.yaml:
dashboard: enabled: true port: 3001 auth: provider: basic # basic | oidc | ldap users: - username: admin password: ${DASHBOARD_PASSWORD} role: admin| Property | Description | Default |
|---|---|---|
dashboard.enabled | Enable or disable the dashboard | true |
dashboard.port | HTTP port the dashboard listens on | 3001 |
dashboard.auth | Authentication configuration block | none (open) |
Features
Section titled “Features”Channel Monitoring
Section titled “Channel Monitoring”The channel list shows every deployed channel with real-time status indicators:
| Metric | Description |
|---|---|
| Status | running, stopped, or error |
| Throughput | Messages per second over the last 60 s |
| Error Rate | Percentage of messages that errored in the pipeline |
| Uptime | Time since the channel was last deployed |
Click a channel row to open the channel detail view with historical charts and configuration.
Message Browser
Section titled “Message Browser”Search and filter messages across all channels or scoped to a single channel:
- Filter by channel, status, or date range
- Inspect the raw payload at each pipeline stage (received → transformed → sent)
- View error details and stack traces for failed messages
Reprocessing
Section titled “Reprocessing”Reprocess individual messages or bulk-reprocess by filter directly from the dashboard.
- Single message — open the message detail view and click Reprocess.
- Bulk reprocess — apply filters in the message browser, select messages, and click Reprocess Selected.
Live Metrics
Section titled “Live Metrics”The dashboard exposes real-time throughput, latency percentiles, and error counts updated every few seconds.
REST API
Section titled “REST API”All dashboard functionality is available programmatically through the REST API served on the same port.
Channels
Section titled “Channels”| Method | Endpoint | Description |
|---|---|---|
GET | /api/channels | List all channels |
GET | /api/channels/:id | Get channel detail (config, status, metrics) |
POST | /api/channels/:id/deploy | Deploy and start a channel |
POST | /api/channels/:id/undeploy | Stop and undeploy a channel |
# List channelscurl http://localhost:3001/api/channels
# Deploy a channelcurl -X POST http://localhost:3001/api/channels/adt-feed/deployMessages
Section titled “Messages”| Method | Endpoint | Description |
|---|---|---|
GET | /api/messages | List messages |
GET | /api/messages/:id | Get message detail (all pipeline stages) |
POST | /api/messages/:id/reprocess | Reprocess a single message |
Query parameters for GET /api/messages:
| Param | Description | Default |
|---|---|---|
channel | Filter by channel ID | all |
status | Filter by status (received, transformed, sent, error) | all |
limit | Max results | 50 |
offset | Pagination offset | 0 |
# List error messages for a channelcurl "http://localhost:3001/api/messages?channel=adt-feed&status=error&limit=10"
# Reprocess a messagecurl -X POST http://localhost:3001/api/messages/msg_01HQXK9V7W/reprocessSystem
Section titled “System”| Method | Endpoint | Description |
|---|---|---|
GET | /api/metrics | Runtime metrics (throughput, latency, error counts) |
GET | /api/health | Health check — returns 200 OK when the engine is running |
Authentication
Section titled “Authentication”The dashboard supports three authentication providers:
Basic Auth
Section titled “Basic Auth”dashboard: auth: provider: basic users: - username: admin password: ${ADMIN_PASSWORD} role: admin - username: ops password: ${OPS_PASSWORD} role: operatordashboard: auth: provider: oidc issuer: https://auth.example.com client_id: ${OIDC_CLIENT_ID} client_secret: ${OIDC_CLIENT_SECRET}dashboard: auth: provider: ldap url: ldap://ldap.example.com:389 bind_dn: cn=readonly,dc=example,dc=com search_base: ou=users,dc=example,dc=com user_filter: "(uid={{username}})"Role-Based Access Control
Section titled “Role-Based Access Control”Three built-in roles control what each user can see and do:
| Role | Channels | Messages | Deploy / Undeploy | Reprocess | Settings |
|---|---|---|---|---|---|
| admin | view | view | yes | yes | yes |
| operator | view | view | yes | yes | no |
| viewer | view | view | no | no | no |