oca-technical/odoo-bringout-oca-rest-framework-rest_log/rest_log/readme/CONFIGURE.rst
2025-08-29 15:43:03 +02:00

33 lines
1.1 KiB
ReStructuredText

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)