User Guide

In this guide, we will cover the most used features, operations and settings of Pingora.

Running Pingora servers

• Start and stop
• Graceful restart and graceful shutdown
• Configuration
• Daemonization
• Systemd integration
• Handling panics
• Error logging
• Prometheus

Building HTTP proxies

• Life of a request: pingora-proxy phases and filters
• Peer: how to connect to upstream
• Sharing state across phases and connections with CTX (including tracking active connection counts)
• How to return errors
• Examples: take control of the request
• Connection pooling and reuse
• Handling failures and failover
• RateLimiter quickstart

Advanced topics (WIP)

• Pingora internals
• Using BoringSSL
• User defined configuration
• Pingora async runtime and threading model
• Background Service
• Blocking code in async context
• Tracing