Skip to main content
The /metrics endpoint exposes Prometheus-compatible metrics for monitoring the Styx server.

​
Endpoint

GET /metrics

​
Authentication

No authentication required.

​
Response Format

The endpoint returns metrics in Prometheus text-based exposition format. Content-Type: text/plain; version=0.0.4

​
Available Metrics

​
styx_up

Indicates whether the Styx server is running.
​
styx_up
gauge
Server availability indicator. Value is 1 when the server is running.

​
Example Request

curl http://localhost:8080/metrics

​
Example Response

# HELP styx_up STYX server is up
# TYPE styx_up gauge
styx_up 1

​
Usage with Prometheus

Configure Prometheus to scrape the Styx metrics endpoint:
prometheus.yml
scrape_configs:
  - job_name: 'styx'
    static_configs:
      - targets: ['localhost:8080']
    metrics_path: '/metrics'
    scrape_interval: 15s

​
Kubernetes ServiceMonitor

For Prometheus Operator in Kubernetes: 
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: styx-metrics
  labels:
    app: styx
spec:
  selector:
    matchLabels:
      app: styx
  endpoints:
    - port: http
      path: /metrics
      interval: 30s

​
Grafana Dashboard

Use this query to visualize Styx availability: 
styx_up{job="styx"}
Create alerts for service downtime: 
groups:
  - name: styx_alerts
    rules:
      - alert: StyxDown
        expr: styx_up == 0
        for: 1m
        labels:
          severity: critical
        annotations:
          summary: "Styx server is down"
          description: "Styx server has been unavailable for more than 1 minute"
The current implementation provides basic availability metrics. Future versions may include additional metrics for query latency, witness count, belief distributions, and partition detection events.
  • Health Check - Simple health check for liveness probes
  • Query - Query node liveness status

Build docs developers (and LLMs) love

Get started for freeTalk to us