Events and Metadata

Django’s RequestMiddleware

Request Events

Event	Type	Description
request_started	INFO	Django received a request
request_finished	INFO/WARNING/ERROR	request completed with status (2XX or 3XX)/4XX/5XX
request_cancelled	WARNING	request cancelled during an async request with asgi
request_failed	ERROR	unhandled exception occurred

StreamingHttpResponse Events

Specific to StreamingHttpResponse

Event	Type	Description
streaming_started	INFO	Streaming of response started
streaming_finished	INFO	Streaming of response finished
streaming_cancelled	WARNING	Streaming of response was cancelled
streaming_failed	ERROR	Streaming of response failed

Request Bound Metadata

These metadata are repeated on each log of the current request and will be also be repeated in all children Celery tasks and Django tasks.

Key	Value
request_id	UUID for the request or value of `X-Request-ID` HTTP header when provided
correlation_id	value of `X-Correlation-ID` HTTP header when provided
user_id	user’s id or None (requires django.contrib.auth.middleware.AuthenticationMiddleware) DRF: it will only be in `request_finished` and `request_failed` events If you need to override the bound `user_id`, it has to be done in all three signals: `django_structlog.signals.bind_extra_request_metadata` `django_structlog.signals.bind_extra_request_finished_metadata` `django_structlog.signals.bind_extra_request_failed_metadata`
ip	request’s ip

To bind more metadata or override existing metadata from request see Extending Request Log Metadata

Request Events Metadata

These metadata appear once along with their associated event

Event	Key	Value
request_started	request	request as string
request_started	user_agent	request’s user agent
request_finished	code	request’s status code
request_failed	exception	exception traceback (requires format_exc_info)

Celery

Task Events

Event	Type	Description
task_enqueued	INFO	A task was enqueued by request or another task
task_retrying	WARNING	Worker retry task
task_started	INFO	task just started executing
task_succeeded	INFO	Task completed successfully
task_failed	ERROR/INFO*	Task failed
task_revoked	WARNING	Task was canceled
task_not_found	ERROR	Celery app did not discover the requested task
task_rejected	ERROR	Task could not be enqueued

* if task threw an expected exception, it will logged as INFO. See Celery’s Task.throws

Task Bound Metadata

These metadata are repeated on each log of the current task and will be also be repeated in all children Celery tasks. Take note that all the caller’s logger bound metadata are also bound to the task’s logger.

Key	Value
task_id	UUID of the current task
parent_task_id	UUID of the parent’s task (if any)

To bind more metadata or override existing metadata from task see Signals

Task Event Metadata

These metadata appear once along with their associated event

Event	Key	Value
task_enqueued	child_task_id	id of the task being enqueued
task_enqueued	child_task_name	name of the task being enqueued
task_enqueued	routing_key	task’s routing key
task_enqueued	priority	priority of task (if any)
task_retrying	reason	reason for retry
task_started	task	name of the task
task_succeeded	duration_ms	duration of the task in milliseconds
task_failed	task_id	id of the task
task_failed	error	exception as string
task_failed	exception*	exception’s traceback
task_failed	duration_ms	duration of the task in milliseconds
task_revoked	terminated	Set to True if the task was terminated
task_revoked	signum	python termination signal’s number
task_revoked	signame	python termination signal’s name
task_revoked	expired	see Celery’s documentation
task_revoked	task_id	id of the task being revoked
task_revoked	task	name of the task being revoked
task_not_found	task_id	id of the task not found
task_not_found	task	name of the task not found
task_rejected	task_id	id of the task being rejected

* if task threw an expected exception, exception will be omitted. See Celery’s Task.throws

Django Tasks

See Django Tasks Integration. This integration is experimental.

Django Task Events

Event	Type	Description
task_enqueued	INFO	A task was enqueued by request or another task
task_started	INFO	task just started executing
task_succeeded	INFO	Task completed successfully
task_failed	ERROR	Task failed

Note

The DJANGO_STRUCTLOG_CELERY_*_LOG_LEVEL settings do not apply to Django tasks events.

Django Task Bound Metadata

These metadata are repeated on each log of the current task and will be also be repeated in all children Django tasks. Take note that all the caller’s logger bound metadata are also bound to the task’s logger.

Key	Value
task_id	id of the current task
parent_task_id	id of the parent’s task (if enqueued from within another task)

To bind more metadata or override existing metadata from task see Signals

Django Task Event Metadata

These metadata appear once along with their associated event

Event	Key	Value
task_enqueued	task_id	id of the task being enqueued
task_enqueued	task_name	module path of the task being enqueued
task_started	task	module path of the task
task_failed	exception_class	exception’s class path (of the last error)
task_failed	traceback	exception’s traceback (of the last error)

Note

In task_enqueued, task_id is the id of the task being enqueued. When enqueued from within another task, it overrides the bound task_id of the current task for this event only.