Skip to main content

Beta License: LGPL-3 OCA/rest-framework Translate me on Weblate Try me on Runboat

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.

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)

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

Authors

  • Camptocamp

  • ACSONE

Contributors

Other credits

Financial support

  • Cosanum

  • Camptocamp R&D

  • ACSONE R&D

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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:

simahawk

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.

Metadata

Release files for odoo14-addon-rest-log 14.0.1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo14-addon-rest-log 14.0.1.4.0
File Interpreter ABI Platform Actions
odoo14_addon_rest_log-14.0.1.4.0-py3-none-any.whl Python 3 none any Details for odoo14_addon_rest_log-14.0.1.4.0-py3-none-any.whl

Release files / odoo14_addon_rest_log-14.0.1.4.0-py3-none-any.whl

Download URL odoo14_addon_rest_log-14.0.1.4.0-py3-none-any.whl
Size 38.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4739d1e6e953038a436ca243ceefcb2c20bc60eab5693304d6e09da136e4e7ed
BLAKE2b-256 checksum
How to use checksums
2ebfc244cc3bfe11fed18e802e4eaf9ce720c63068e826985ad4f0551ce7d459
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.10

Security for odoo14-addon-rest-log 14.0.1.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page