Logging

Format

Open Organisatie emits structured logs (using structlog). A log line can be formatted like this:

{
    "id": 1,
    "naam": "test",
    "event": "medewerker_created",
    "user_id": null,
    "request_id": "2f9e9a5b-d549-4faa-a411-594aa8a52eee",
    "timestamp": "2025-05-19T14:09:20.339166Z",
    "logger": "openorganisatie.scim.api.viewsets.medewerker",
    "level": "info"
}

Each log line will contain an event type, a timestamp and a level. Dependent on your configured LOG_LEVEL (see Environment configuration reference for more information), only log lines with of that level or higher will be emitted.

Open Organisatie log events

Below is the list of logging event types that Open Organisatie can emit. In addition to the mentioned context variables, these events will also have the request bound metadata described in the django-structlog documentation.

API

#TODO: update list after adding logging to API

Exceptions

#TODO: add exception handler to view.

Handled exceptions follow a standardized JSON format to ensure consistency and improve error tracking. Most fields are standard and include: title, code, status, event, source, user_id, request_id, timestamp, logger and level.

A new field data has been added to provide detailed information about which input parameters caused the error in API calls.

{
    "title": "Authentication credentials were not provided.",
    "code": "not_authenticated",
    "status": 401,
    "data": {
        "detail": "Authentication credentials were not provided."
    },
    "event": "api.handled_exception",
    "user_id": null,
    "request_id": "68b46bf0-a5b8-43f7-a550-e37dee617bff",
    "source": "app",
    "timestamp": "2025-10-06T07:43:40.991929Z",
    "logger": "openorganisatie.utils.views",
    "level": "error"
}

Uncaught exceptions that occur via the API are logged as api.uncaught_exception events and contain the traceback of the exception.

{
    "event": "api.uncaught_exception",
    "request_id": "9a5c781d-b15c-4b3a-8910-e7968ae37cb6",
    "user_id": null,
    "timestamp": "2025-10-06T08:31:57.572352Z",
    "logger": "openorganisatie.utils.views",
    "level": "error",
    "exception": "Traceback (most recent call last):\n  File \"/usr/local/lib/python3.12/site-packages/rest_framework/views.py\", line 497, in dispatch\n    self.initial(request, *args, **kwargs)\n  File \"/usr/local/lib/python3.12/site-packages/vng_api_common/geo.py\", line 30, in initial\n    super().initial(request, *args, **kwargs)\n  File \"/usr/local/lib/python3.12/site-packages/rest_framework/views.py\", line 415, in initial\n    self.check_permissions(request)\n  File \"/usr/local/lib/python3.12/site-packages/rest_framework/views.py\", line 332, in check_permissions\n    if not permission.has_permission(request, self):\n           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n  File \"/app/src/objects/token/permissions.py\", line 10, in has_permission\n    1 / 0\n    ~~^~~\nZeroDivisionError: division by zero"
}

Third party library events

For more information about log events emitted by third party libraries, refer to the documentation for that particular library