Reference

Canonical runtime reference, split into short hubs for faster navigation.

Quick Start

Machine-readable

  • https://docs.fairvisor.com/llms.txt
  • https://docs.fairvisor.com/prompt.txt
  • https://docs.fairvisor.com/sitemap.xml
Get Started (API)
Fast path: first decision request, first reject, first metric.
How-to Library
Task-oriented shortcuts for common operator workflows.
Decision Tracing
How to trace a 429 from response headers back to policy and limiter logic.
Core Reference
Canonical API contracts, lifecycle, headers, reasons, and metrics.
Operations Hub
Runbooks, troubleshooting, alerting, and failure policy.
Reliability and Security
Security posture, hardening, compatibility, and release expectations.
Platform and Governance
Golden patterns and operator-focused guidance.
Request Lifecycle
Detailed evaluation order and decision flow inside Fairvisor Edge.
Decision API
HTTP API reference for the Fairvisor Edge decision service.
Response Headers
Headers that Fairvisor Edge may set on decision responses.
Rejection Reasons
Reason codes returned in X-Fairvisor-Reason.
Metrics
Prometheus metrics emitted by Fairvisor Edge.
Streaming Enforcement
How Fairvisor Edge enforces token limits on SSE streaming responses.
Security Model
Trust boundaries, assets, and security checklist for Fairvisor Edge.
Debug Session
Per-user debug session workflow with signed cookie and X-Fairvisor-Debug-* headers.
Troubleshooting
Symptom-driven troubleshooting for common edge issues.
Policy Lint Checklist
Pre-release checklist for policy bundle quality and safety.
Migration Guides
Migration paths for docs and runtime operating modes.
Golden Bundles
Reference bundle patterns you can adapt for production.
Runbooks
Operational incident runbooks for common production failures and control actions.
SLO and Alerting
Baseline SLOs and practical alert rules for Fairvisor Edge.
Gateway Failure Policy
Fail-open vs fail-closed behavior when gateway cannot reach edge.
Security Hardening
Secure-by-default deployment checklist for edge runtime.
Capacity Planning
Estimate memory/cardinality requirements for limiter state.
Known Limitations
Current runtime limitations and non-goals.
Operator FAQ
Practical Q/A for platform and on-call teams operating Fairvisor Edge.