Dashboard Module

The Dashboard Module is a zero-dependency, built-in admin panel served directly by Vorte. It provides visual insights and management control over your running application without requiring any external dependencies or build pipelines.

Setup & Activation

By default, the dashboard is enabled in development environments and auto-mounts at /vorte/dashboard.

app.py

python

Copied!

1	from vorte import Vorte, DashboardModule
2
3	app = Vorte()
4
5	# Auto-loaded by default if auto_load=True, or registered manually:
6	app.register(DashboardModule())

Configuration Options

Customize the dashboard mount path, visibility, and security settings via your settings file or environment variables.

.env

bash

Copied!

1	DASHBOARD_ENABLED=true
2	DASHBOARD_PATH=/vorte/dashboard
3	DASHBOARD_AUTH_REQUIRED=true
4	DASHBOARD_TOKEN=your_custom_secure_token

Feature Control Panels

The dashboard consists of 6 integrated live panels:

Overview: Real-time application metrics (requests count, active module status, latency, error rates) alongside live process metrics including resident memory footprint (RSS) and CPU utilization gauges.
Modules: Displays all registered/unregistered Vorte modules, active versioning metadata, priority levels, and health states.
Routes: Displays all registered FastAPI & framework endpoints. Includes filtering routes dynamically by method type (GET, POST, etc.) and search.
Health: Displays overall system diagnostics and detailed health statuses of active modules.
Logs: Streams live console log entries directly from Python named loggers (including uvicorn and fastapi loggers) using the custom in-memory Ring Buffer. Includes search and severity filtering.
Config: View system and application settings (excluding secrets and database credentials) in a clean, syntax-highlighted JSON viewer with a quick Copy action.

Developer Experience (DX) Improvements

Vorte's admin dashboard is optimized for developer productivity:

Token Management: In development mode, if auth is required, Vorte auto-generates a secure runtime token. The token is shown truncated in the top bar with a convenient Copy-to-Clipboard action to easily paste into external REST clients like Postman or curl.
API Documentation Shortcuts: The sidebar footer contains direct links to Swagger UI (/docs) and ReDoc (/redoc) to open them in a new tab instantly.

Underlying REST Endpoints

The admin panel UI communicates with Vorte using these built-in API endpoints, which you can query using any HTTP client:

GET /_vorte/dashboard/overview: Metrics, uptime, memory, and system overview.
GET /_vorte/dashboard/modules: Details of all installed modules.
GET /_vorte/dashboard/routes: Complete listing of routes.
GET /_vorte/dashboard/health: Running diagnostics checklist.
GET /_vorte/dashboard/logs: Retrieve recent in-memory log buffer records.
GET /_vorte/dashboard/config: Non-sensitive app configuration settings.