Monitoring Overview
Observability tools for Surgewave.
Components
| Component | Purpose |
|---|---|
| Metrics | Prometheus-compatible metrics |
| Tracing | OpenTelemetry distributed tracing |
| Dashboard | Control UI dashboard with 14 customizable widgets |
Health Check
surgewave health
surgewave health -f json
Endpoint: https://localhost:9093/health
Quick Setup
Prometheus
scrape_configs:
- job_name: surgewave
static_configs:
- targets: ['localhost:9093']
metrics_path: /metrics
Grafana Dashboard
Import Surgewave dashboard:
- Dashboard ID: (coming soon)
- Data source: Prometheus
Key Metrics
| Metric | Description |
|---|---|
surgewave_connections_total |
Total connections |
surgewave_messages_in_total |
Messages received |
surgewave_messages_out_total |
Messages sent |
surgewave_request_duration_ms |
Request latency |
surgewave_storage_bytes |
Storage usage |
Alerts
Recommended alerts:
groups:
- name: surgewave
rules:
- alert: SurgewaveDown
expr: up{job="surgewave"} == 0
for: 1m
labels:
severity: critical
annotations:
summary: Surgewave broker is down
- alert: UnderReplicatedPartitions
expr: surgewave_under_replicated_partitions > 0
for: 5m
labels:
severity: warning
- alert: HighConsumerLag
expr: surgewave_consumer_lag > 10000
for: 10m
labels:
severity: warning