Health Checks

Per-cluster health checks probe endpoints on a timer and remove unhealthy backends from the load balancer rotation

Category: Setup-dependent integration
Task: Per-cluster health checks probe endpoints on a timer and remove unhealthy backends from the load balancer rotation

Prerequisites: The external service, credentials, or certificates referenced by this configuration.

Run it: Use ghcr.io/praxis-proxy/praxis:0.7.2 and follow the first reverse-proxy tutorial to mount and start the configuration.

This configuration comes from the selected release. The example has not been run here; external services are not bundled.

Download the source file.

# Active Health Checks
#
# Per-cluster health checks probe endpoints on a timer and remove
# unhealthy backends from the load balancer rotation. Supports HTTP
# GET probes (check status code) and TCP connect probes.
#
listeners:
  - name: default
    address: "127.0.0.1:8080"
    filter_chains:
      - main

admin:
  address: "127.0.0.1:9090"

insecure_options:
  allow_private_endpoints: true # example proxies to local backends
  allow_private_health_checks: true  # dev only; allows loopback endpoints

clusters:
  - name: backend
    endpoints:
      - "127.0.0.1:3001"
      - "127.0.0.1:3002"
      - "127.0.0.1:3003"
    health_check:
      type: http
      path: "/healthz"
      expected_status: 200
      interval_ms: 5000
      timeout_ms: 2000
      healthy_threshold: 2
      unhealthy_threshold: 3
      passive_unhealthy_threshold: 5
      passive_healthy_threshold: 3

  - name: database
    endpoints:
      - "127.0.0.1:5432"
      - "127.0.0.1:5433"
    health_check:
      type: tcp
      interval_ms: 10000
      timeout_ms: 3000
      healthy_threshold: 1
      unhealthy_threshold: 2

filter_chains:
  - name: main
    filters:
      - filter: router
        routes:
          - path_prefix: "/api"
            cluster: backend
          - path_prefix: "/db"
            cluster: database
          - path_prefix: "/"
            cluster: backend

      - filter: load_balancer
        clusters:
          - name: backend
            endpoints:
              - "127.0.0.1:3001"
              - "127.0.0.1:3002"
              - "127.0.0.1:3003"
          - name: database
            endpoints:
              - "127.0.0.1:5432"
              - "127.0.0.1:5433"