OdooWiki OCA HUB

REST Log

rest_log folder_open OCA/rest-framework open_in_new
Uncategorised License: LGPL-3

When exposing REST services is often useful to see what's happening especially in case of errors.

This module add DB logging for REST requests. It also inject in the response the URL of the log entry created.

It can also enable profiling for selected REST endpoints. When profiling is active, the request execution is wrapped by Odoo's profiler and results are stored in ir_profile.

NOTE: this feature was implemented initially inside shopfloor app. Up to version 13.0.1.2.1 of this module, if shopfloor is installed, log records will be copied from its table.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Records every REST API call made to your Odoo into a searchable log, showing what was requested, the result or the error, and a link back to the related record. Old logs are cleaned up automatically.

This module adds a log of REST API calls so you can see what external systems asked Odoo to do and what happened.

  • A new "Logs" menu appears under the REST API menu, with a list and a form. Each entry shows the collection, the request URL and method, the user, the date, the status (Success or Failed), the exception name and message, and a severity (Functional, Warning or Severe).
  • On a log entry you can open the Parameters, Result and Error sections to inspect the exact data sent and returned. A "View collection" button jumps to the record the call was about, when one is linked.
  • Failed calls are highlighted in red in the list. You can filter by Today, Failed, or by severity, and group by collection, user, request URL, status, exception, severity or date.
  • When a call fails, the error response sent back to the caller includes a link to the log entry, so the person debugging can open it directly.
  • Sensitive values such as passwords, cookies and API keys are replaced with "<redacted>" before being stored.
  • Logging is controlled by settings: it can be switched on globally, or only for certain collections, endpoints or states. A daily scheduled job deletes logs older than the retention period (30 days by default).
  • Access is limited to the "REST Log Manager" group, which is read-only.

Depends on

base_rest

Required by other modules

shopfloor_rest_log
Models and fields (2)
  • rest.log · new modelerror, state, params, result, headers, severity, collection, request_url (Request URL), collection_id (Collection ID), exception_name (Exception), request_method, exception_message
  • base.rest.service · extends an existing model

Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 5 confirmed, 4 with no information of 9 versions.

Sources · Odoo 16.0

Confirmed on 2026-11-03 in branch 16.0 of OCA/rest-framework.

terminal Installation and usage

OCA documentation · Odoo 18.0

Configuration

Source · Odoo 18.0

Logs retention

Logs are kept in database for every REST requests made by a client application. They can be used for debugging and monitoring of the activity.

The Logs menu is shown only with Developer tools (?debug=1) activated.

By default, REST logs are kept 30 days. You can change the duration of the retention by changing the System Parameter rest.log.retention.days.

If the value is set to 0, the logs are not stored at all.

Logged data is: request URL and method, parameters, headers, result or error.

Logs activation

You have 2 ways to activate logging:

  • on the service component set _log_calls_in_db = True
  • via configuration

In the 1st case, calls will be always be logged.

In the 2nd case you can set rest.log.active param as:

collection_name # enable for all endpoints of the collection collection_name.usage # enable for specific endpoints collection_name.usage.endpoint # enable for specific endpoints collection_name*:state # enable only for specific state (success, failed)

Profiling

Profiling is enabled per endpoint and per user via system parameters:

  • rest.log.profiling.conf: same matching syntax as rest.log.active
  • rest.log.profiling.uid: comma-separated list of user ids allowed to profile

When both parameters match, the request execution is wrapped in Odoo's profiler and the results are stored in ir_profile.

base.profiling_enabled_until is only needed to view speedscope output in the UI. It is not required to record profiles.

No verified information in OCA: Installation, Usage.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.