Skip to content
df12
Tools
Creative
Docs
About
Menu
Tools
Creative
Docs
About
Contents
Introduction
Introduction
Installation
Installation
Quick Start
Quick Start
How It Works
How It Works
Header retrieval and trusted source behaviour
Configuration Options
Configuration Options
`CorrelationIDConfig`
header_name
trusted_sources
Important notes
generator
validator
Context Variables
Context Variables
correlation_id_var
user_id_var
Accessing the correlation ID
Accessing the correlation ID
Via `req.context.correlation_id`
Via `correlation_id_var.get()`
When to use each method
echo_header_in_response
Logging integration
Logging integration
Basic usage
Recommended format string
Using `dictConfig`
Placeholder behaviour
Preserving explicit metadata
Structlog integration
Structlog integration
How it works
Custom processor (recommended)
Alternative: `bind_contextvars` in middleware
Note on `merge_contextvars`
httpx propagation
httpx propagation
Choosing an approach
Synchronous wrapper usage
Asynchronous wrapper usage
Transport usage with shared clients
HTTP client behaviour
Celery propagation
Celery propagation
Enabling the publish and worker signal handlers
Behaviour
Full Configuration Example
Full Configuration Example
Current Status
Current Status
Installation
Version 0.1.0
Updated Aug 23, 2026
pip
install
falcon-correlate