Documentation

Monitoring & audit

Operations dashboard, health checks, and the comprehensive audit trail.

Updated Aug 5, 20254 min read

Monitoring & audit

The Monitoring and Audit modules give operations full visibility into platform health and every mutating action.

Monitoring

The Monitoring module backs the Operations dashboard:

Capability Description
Health checks /health endpoint for orchestrators and probes
System metrics CPU/memory/disk surfaced on the dashboard
Entity counts Customers, sites, subscriptions, jobs
Job status Gateway, notification, backup job progress
Maintenance mode MaintenanceMode + message shown to users
Refresh cadence DashboardRefreshIntervalSeconds controls polling

Audit

The Audit module logs every mutating action across modules. Audit entries capture:

  • Actor (user/role, system)
  • Action (e.g., customer.activate, backup.run, billing.webhook)
  • Target entity + ID
  • Timestamp (UTC)
  • Result (success/failure) with error details

Audit log is append-only and used for compliance, troubleshooting, and authorization review.

Operations dashboard refresh

  • DashboardRefreshIntervalSeconds (Platform Settings → Maintenance) controls how often the Operations dashboard polls.
  • Set lower during incident response, higher to reduce load.