Logs for error responses should include the error code/detail

[stevenbal]

Thema / Theme

API

Omschrijving / Description

Remark from Jan Brekelmans from DH. At the moment, log events for error responses do not include the error code/detail (we could include invalidParams as context as well, only the status code. It might be good to also include these to give more insight into what went wrong:

Current format:

{
    "code": 400,
    "request": "POST /klantinteracties/api/v1/partijen",
    "event": "api.handle_exception",
    "user_id": null,
    "request_id": "62814fda2ef339beb6917a1d675150b1",
    "timestamp": "2025-08-12T06:39:23.823687Z",
    "logger": "django_structlog.middlewares.request",
    "level": "error"
}

Toegevoegde waarde / Added value

No response

Aanvullende opmerkingen / Additional context

These logs are emitted via django_structlog, we might be able to bind the additional contextvars via the commonground-api-common exception handler

[stevenbal]

@sergei-maertens do you think it would be a good idea to add these contextvars to the request events from django structlog? Or would it be better to emit separate events for validation errors?

[sergei-maertens]

@sergei-maertens do you think it would be a good idea to add these contextvars to the request events from django structlog? Or would it be better to emit separate events for validation errors?

In Open Forms, we send the uncaught exceptions to Sentry and validation errors are logged. The exception unique ID is bound to contextvars, see:

• https://github.com/open-formulieren/open-forms/blob/a36184fb98dd24e03db139e8300c5114a1b7c762/src/openforms/api/exception_handling.py#L115
• https://github.com/open-formulieren/open-forms/blob/a36184fb98dd24e03db139e8300c5114a1b7c762/src/openforms/api/exception_handling.py#L138
• https://github.com/open-formulieren/open-forms/blob/a36184fb98dd24e03db139e8300c5114a1b7c762/src/openforms/api/views/views.py#L39

So IMO emitting a separate log event for this is the right approach, and you have the request_id to correlate it with other log entries.

[alextreme]

Discussed with Team Bron, estimated at 2 days of work. FYI @janmasGDH

[janmasGDH]

approved