REST Log
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.
Table of contents
Configuration
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.
Changelog
13.0.1.0.0
First official version.
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
Guewen Baconnier <guewen.baconnier@camptocamp.com>
Simone Orsi <simahawk@gmail.com>
Other credits
Financial support
Cosanum
Camptocamp R&D
ACSONE R&D
Maintainers
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
Current maintainer:
This module is part of the OCA/rest-framework project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Release files for odoo-addon-rest-log 18.0.1.0.1.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| odoo_addon_rest_log-18.0.1.0.1.9-py3-none-any.whl | Python 3 | none | any | Details |
Release files / odoo_addon_rest_log-18.0.1.0.1.9-py3-none-any.whl
| Download URL | odoo_addon_rest_log-18.0.1.0.1.9-py3-none-any.whl |
|---|---|
| Size | 43.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0e3cc99922d46b5be8eeb4376768dfa3d54f7ed48f05378cc55fdb0c3df6fc12
|
|
BLAKE2b-256 checksum How to use checksums |
fc5f7bba30ee365d9b0cc2c35066e4cee1f79b2221083bd508098aaebe91ead2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|