Skip to content

Dashboard

OxideShield™ includes a real-time metrics dashboard for monitoring security events.

Quick Start

oxideshield dashboard --listen 0.0.0.0:9090

Open http://localhost:9090 in your browser.

Features

  • Real-time metrics display
  • Per-guard breakdown
  • Alert configuration
  • Prometheus metrics export
  • Health endpoints for Kubernetes

REST API

Endpoint Method Description
/api/v1/overview GET System overview
/api/v1/metrics GET Detailed metrics
/api/v1/metrics/guards GET Per-guard metrics
/api/v1/alerts GET Current alerts
/api/v1/metrics/reset POST Reset metrics
/health GET Health check
/metrics GET Prometheus format

Configuration

dashboard:
  listen: "0.0.0.0:9090"
  cors: true
  compression: true

  alerts:
    block_rate_warning: 0.1
    block_rate_critical: 0.25
    latency_warning_ms: 50
    latency_critical_ms: 100

Prometheus Integration

# prometheus.yml
scrape_configs:
  - job_name: 'oxideshield'
    static_configs:
      - targets: ['oxideshield-dashboard:9090']
    metrics_path: /metrics