Question 1

How to set up asgi-correlation-id with FastAPI?

Accepted Answer

Install the package via pip, add the CorrelationIdMiddleware to your FastAPI app, and configure your logging by adding the CorrelationIdFilter to your handlers and updating the formatter to include %(correlation_id)s. The README provides step-by-step examples for both basic and advanced setups.

Question 2

ASGI correlation ID or OpenTelemetry for tracing?

Accepted Answer

ASGI Correlation ID is a simpler, focused solution for adding correlation IDs to logs in ASGI apps, ideal for basic tracing needs with minimal overhead. OpenTelemetry is more comprehensive, supporting distributed tracing, metrics, and logs across services but with greater setup complexity and resource usage.

Question 3

How to integrate asgi-correlation-id with Celery workers?

Accepted Answer

Install the package with the celery extra (pip install asgi-correlation-id[celery]), then import load_correlation_ids() from the extensions and call it to set up signal handlers that transfer correlation IDs from web requests to Celery tasks, ensuring traceability across background processes.

Question 4

Can I use asgi-correlation-id with Django?

Accepted Answer

Yes, but only if Django is running in ASGI mode. For traditional WSGI deployment, it won't work without additional configuration to use ASGI, as the middleware is specifically designed for ASGI frameworks.

Question 5

How to add correlation IDs to structlog in Python?

Accepted Answer

Add a custom processor to structlog that uses correlation_id.get() to inject the ID into log events. The README includes a sample processor function that can be integrated into your structlog configuration for structured logging with correlation IDs.

Question 6

Does asgi-correlation-id work with Uvicorn access logs?

Accepted Answer

Yes, but you need to configure Uvicorn's logging by adding the CorrelationIdFilter to the access log handler and updating the formatter, as shown in the integration example in the README, which requires modifying the LOGGING_CONFIG dictionary.

ASGI Correlation ID

What is ASGI Correlation ID?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions