fapilog

Documentation

  • Getting Started
    • Installation
    • Quickstart Tutorial
    • Hello World Walkthrough
  • Why fapilog?
  • Features
  • Python Logging Library Comparison
  • Core Concepts
    • Pipeline Architecture
    • Envelope
    • Context Binding
    • Batching & Backpressure
    • Sinks
    • Metrics
    • Diagnostics Resilience
    • Diagnostics & Resilience
  • User Guide
    • Configuration
    • Configuration Presets
    • Execution Modes
    • Configuring Fapilog with the Builder API
    • Environment Variable Configuration
    • Production Checklist
    • Using the Logger
    • Context Enrichment
    • Rotating File Sink
    • Sink routing by level
    • Circuit Breaker
    • Adaptive Pipeline
    • Sampling Strategies
    • Graceful Shutdown
    • Performance Tuning
    • Performance Benchmarks
    • Integration Guide
    • stdlib Logging Bridge
    • FastAPI / ASGI Integration
    • Reliability Defaults and Guardrails
    • Testing Plugins
    • Webhook Security
  • Cookbook
    • FastAPI Microservices in Production
    • FastAPI JSON logging to stdout (Uvicorn access logs included)
    • FastAPI request_id logging (correlation ID middleware, concurrency-safe)
    • Django Structured JSON Logging with Correlation IDs
    • Non-blocking logging in FastAPI (protect latency under slow sinks)
    • One FastAPI logging config for dev + prod (Uvicorn/Gunicorn)
    • Redacting secrets and PII in FastAPI logs (Authorization, tokens, fields)
    • Compliance Redaction: What Works and What Doesn’t
    • Logging request/response bodies without hanging (safe patterns)
    • Skipping health/metrics endpoints (noise reduction)
    • Log sampling and rate limiting for FastAPI
    • Adaptive Sampling for High-Volume Services
    • Graceful shutdown & flushing logs (don’t lose logs on deploy)
    • Exception logging in FastAPI with request_id + structured context
    • Custom log levels in Python (TRACE, VERBOSE, NOTICE)
  • Examples & Recipes
    • Builder Configuration Examples
    • FastAPI Logging
    • Logging in Scripts/CLIs
    • Redacting Secrets
    • Structured Error Logging
    • Kubernetes File Sink
    • Prometheus Metrics
    • Sampling Debug Logs
    • Handling Size-Limited Destinations
    • CloudWatch Logging (LocalStack)
    • Cloud Sink Examples
  • Redaction
    • Redaction Presets
    • Redaction Configuration
    • Redaction Behavior
    • Testing Redaction
  • Enterprise Features
  • API Reference
    • Top-Level Functions
    • Builder API Reference
    • Logger Methods
    • Context Binding
    • Audit Trail
    • Configuration
    • Configuration Reference
    • Types
    • Plugins
    • Lifecycle & Results
    • API Modules
  • Plugin Development
    • Plugin Author Quickstart
    • Authoring Fapilog Plugins
    • Plugin Contracts and API Versioning
    • Redactors
    • Sinks
    • Enrichers
    • Filters
    • Processors
    • Plugin Testing
    • Plugin Configuration
    • Plugin Health Checks
    • Plugin Error Handling
  • Integration Patterns
    • Building SDK-Based Sinks
    • Building HTTP-Based Sinks
  • Troubleshooting
    • Logs Dropped Under Load
    • Logs Rejected by Destination Size Limits
    • Context Values Missing
    • File Sink Not Rotating
    • Serialization Errors
    • PII Showing Despite Redaction
    • CloudWatch Sink Issues
    • Loki Sink Issues
  • Frequently Asked Questions
  • Appendices
    • Environment Variables
    • Settings Reference
    • Schema Guide
    • Schema Migration Guide: v1.0 to v1.1
    • Plugin Catalog
    • Security Remediation & Approval Workflows
    • Quality Signals
    • Migrating from Settings to Builder
    • Migration Guide: Simplified Rotating File Setup
    • Tenacity Integration Guide
    • Testing with Fapilog
    • Async Context Propagation
    • Tamper-Evident Logging Add-on (Optional)
fapilog
  • Search

© Copyright 2024, Chris Haste. Last updated on February 20, 2026.

Built with Sphinx using a theme provided by Read the Docs.