GET /api/v1/system/metrics

Get Prometheus-formatted metrics for scraping by monitoring systems. This endpoint exposes basic operational metrics for monitoring Blocklight’s health and performance.

Optional Feature: Prometheus monitoring is optional. Blocklight works perfectly without it. This endpoint is only available when the REST API is enabled.

Endpoint

GET /api/v1/system/metrics

Example Request

curl http://localhost:8000/api/v1/system/metrics

Response

# HELP blocklight_up Blocklight is running
# TYPE blocklight_up gauge
blocklight_up 1

# HELP blocklight_rules_total Total number of detection rules
# TYPE blocklight_rules_total gauge
blocklight_rules_total 37

# HELP blocklight_rules_enabled Number of enabled rules
# TYPE blocklight_rules_enabled gauge
blocklight_rules_enabled 15

# HELP blocklight_transactions_processed_total Total transactions processed
# TYPE blocklight_transactions_processed_total counter
blocklight_transactions_processed_total 1523

# HELP blocklight_findings_generated_total Total findings generated
# TYPE blocklight_findings_generated_total counter
blocklight_findings_generated_total 42

# HELP blocklight_avg_evaluation_time_ms Average rule evaluation time in milliseconds
# TYPE blocklight_avg_evaluation_time_ms gauge
blocklight_avg_evaluation_time_ms 12.5

Optional: Configure Prometheus to scrape this endpoint for operational monitoring. See Observability for setup instructions.For detection observability: Use Vector + Loki + Grafana to analyze the detections Blocklight generates (see Pipeline Integration).

GET /api/v1/system/status GET /api/v1/rules

Overview

Endpoints

GET /api/v1/system/metrics

Endpoint

Example Request

Response

​Endpoint

​Example Request

​Response

Endpoint

Example Request

Response