Operational Dashboard

Overview#

The dashboard serves a responsive, self-contained HTML page that displays real-time service health, uptime, and Prometheus metrics. It fetches data from your existing /health and /metrics endpoints.

Usage#

import { createDashboard } from '@axiljs/cloud'
 
app.get('/dashboard', createDashboard({
  title: 'My Cloud Console',
  metricsEndpoint: '/metrics',
  healthEndpoint: '/health',
  refreshMs: 5000,
}))

Options#

Security#

The dashboard includes built-in security headers:

• Content-Security-Policy — restricts script and style sources
• X-Frame-Options: DENY — prevents clickjacking
• X-Content-Type-Options: nosniff — prevents MIME sniffing
• All dynamic content is HTML-escaped to prevent XSS

Production Deployment#

Mount the dashboard behind authentication in production:

import { authenticate, requireRole } from '@axiljs/auth'
 
app.get(
  '/dashboard',
  authenticate(jwt),
  requireRole('admin'),
  createDashboard({ title: 'Admin Dashboard' })
)